CODEWITHSUNDEEP
openapijsonschemaswagger-2.0
Jeffrey04
Jeffrey04

Reputation: 6338

Freeform subobject in json-schema

I am drafting an API documentation with swagger.io and is trying to make it fit to our use case. The system is going to receive and process data from all sources, and they would each have different sets of fields.

While the product of the processing share the same schema, we want to include the input in the schema too for reference purpose. For instance, given

{
    "foo": "bar"
    "bar": "baz"
}

The product of the processing is

{
    "original": {
        "foo": "bar",
        "bar": "baz"
    }
    "processed": {
        "stdFieldA": "bar",
        "stdFieldB": "baz"
    }
}

Assuming for each input from different sources, we end up having stdFieldA and stdFieldB. So the response schema object we have

type: object
properties:
    processed:
        type: object
        properties:
            stdFieldA:
                type: string
            stdFieldB:
                type: string

now that we have the processed subobject defined, can we define a freeform object for the original input, so that this object coming from another source is valid

{
    "alpha": "lorem",
    "beta": "ipsum"
}

If I don't get any answer to this, my workaround to the problem would be storing the original input as string (convert the original input into JSON string).

Upvotes: 1

Views: 2355

Answers (1)

Helen
Helen

Reputation: 97982

type: object without properties describes a free-form object. So the response schema can be:

type: object
properties:
    original:
        type: object    # <----------
    processed:
        type: object
        properties:
            stdFieldA:
                type: string
            stdFieldB:
                type: string

Upvotes: 4

Related Questions