Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Following swagger specifications, how can I define json of nested objects to yaml?

I am having a problem in defining the array of objects in swagger yaml. Swagger editor is giving an error everytime I try to define the type: array part of the yaml. I defined it, but it is not right as it is giving an error. Following is the json I am trying to define in swagger yaml.

{
    "CountryCombo": {
        "options": {
            "option": [{
                "id": "GB",
                "value": "GB Great Britain"
            }, {
                "id": "US",
                "value": "US United States"
            }, {
                "id": "AD",
                "value": "AD Andorra, Principality of"
            }]
        }
    }
}

I defined this json into swagger yaml like this but it is giving an error:

CountryCombo:
    type: object
    properties:
        options:
            type: object
            properties:
                option:
                    type: array
                    items:
                        - id:
                            type: string
                            description: GB
                          value:
                            type: string
                            description: GB Great Britain
                        - id:
                            type: string
                            description: US
                          value:
                            type: string
                            description: US United States
                        - id:
                            type: string
                            description: AD
                          value:
                            type: string
                            description: AD Andorra, Principality of

Can anyone suggest me how would I define this json in yaml following swagger specifications?

like image 840
Paypal Paypal Avatar asked Mar 12 '16 08:03

Paypal Paypal


People also ask

Can you nest objects in JSON?

Objects can be nested inside other objects. Each nested object must have a unique access path. The same field name can occur in nested objects in the same document.

Is swagger a JSON or YAML?

Swagger definitions can be written in JSON or YAML.


2 Answers

In a schema, you don't want to have the values, only the description of the values.

CountryCombo:
    type: object
    properties:
        options:
            type: object
            properties:
                option:
                    type: array
                    items:
                        type: object
                        properties:
                          id:
                            type: string
                          value:
                            type: string
like image 96
Mohsen Avatar answered Nov 05 '22 09:11

Mohsen


The above answer is also right but I already implemented this in my yaml. I found that I can also define array by creating another definition.

CountryCombo:
    type: object
    properties:
        options:
            type: object
            properties:
                option:
                    type: array
                    items:
                        $ref: '#/definitions/Country_row'

Country_row:
    type: object
    properties:
      id:
        type: string
      value:
        type: string
like image 20
Paypal Paypal Avatar answered Nov 05 '22 11:11

Paypal Paypal