Как создать поле объекта в api-blueprint? - PullRequest
1 голос
/ 05 апреля 2019

Я пытаюсь задокументировать POST-запрос с одним полем объекта и одним предопределенным. Как я могу сделать это правильно? Это решение нарушает схему после разбора api-blueprint.

### Create order [POST]

Create a new order

+ Request Post new patient (application/json)

    + Attributes (object)

        ### CustomIds 
            + system: `['Some1', 'Some2']` (string, optional) - The order custom id's system
            + Members
                + `Test1`
                + `Test2`
                + `Test3`
        + customerName: `John` (string, required) - The customer's given name
        + customIds: `some, 123` (array[CustomIds], optional) - custom ids
    + Body

            {
                "customerName" : "John", 
                "customIds": [{"system": "some", "id": "123"}] //optional
            }

1 Ответ

1 голос
/ 05 апреля 2019
### Create order [POST]

Create a new order

+ Request Post new order (application/json)

    + Attributes (object)
        + customIds (object)
            + id: `12345` (string, optional) - The order custom id
            + system: `Some` (enum[string], optional) - The order custom id's system name
                + Members
                    + `Some1`
                    + `Some2`
                    + `Some3`
        + customerName: `John` (string, required) - The customer's given name
    + Body

            {
                "customerName" : "John", 
                "customIds": [{"system": "some", "id": "123"}] //optional
            }
...