Skip to content

How to properly document arrays #32

@BigDataKatha

Description

@BigDataKatha

Current documentation in JSON:

"passengerDetails": {
    "description": "Passenger Details captured from IBE",
    "type": "array",
    "properties": {
        "category": {
        "description": "Any passenger category following the format category[Age]To[Age]Count or category[Age]Plus",
        "type": "string",
        "example": "Adult"
        },
        "count": {
        "description": "Amount of passengers for a specific category",
        "type": "number",
        "example": 1
        }
    }
}

Incorrect result in dynamic documentation:

"passengerDetails": {
      "category": "Adult",
      "count": 1
    }

Expected result:

"passengerDetails": [
            {
                "category": "Adult",               
                "count": 1
            },
            {
                "category": "Child0to17",               
                "count": 1
            }
        ]

How can I properly document an array in JSON?

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions