Примеры тела множественного ответа в зависимости от типа носителя в OpenApi 3.0.0 / Swagger - PullRequest
Новая
       23

Примеры тела множественного ответа в зависимости от типа носителя в OpenApi 3.0.0 / Swagger

1 голос
/ 02 декабря 2019

Я пытаюсь задокументировать ответ для конечной точки, которая принимает несколько запросов типа MIME и возвращает другой ответ в зависимости от типа. Один тип ответа, pdf, возвращает свою собственную схему отдельно от других. Все остальные возвращают ту же схему и тот же пример. Этот синтаксис работает. Почти. За исключением примера пользовательского интерфейса, в ответе JSON также показана строка «$ ref: example-two.json» вместе с соответствующим примером ответа. Например: 

{
  "key": "value",
  "key2": "value2",
  "$$ref: example-two.json"
}

, когда это должно быть просто: 

{
  "key": "value",
  "key2": "value2"
}

Я просматривал документы, стек и Google, и я не вижу примеров создания чего-то подобногоРабота. Или, скорее, я не понимаю, почему этот не работает, но я не видел ни одного примера, включающего $ refs для каждого примера. 

responses:
    200:
        content:
            application/pdf:
                schema:
                    $ref: ../app.yaml#/components/schemas/ModelOne
            application/json:
                schema:
                    $ref: ../app.yaml#/components/schemas/ModelTwo
                examples:
                    Example:
                        value:
                            $ref: example-two.json
            text/html:
                schema:
                    $ref: ../app.yaml#/components/schemas/ModelTwo
                examples:
                    Example:
                        value:
                            $ref: example-two.json

Для контекста - я не могу изменить поведение конечной точкии мне нужно показать пример для каждого типа пантомимы, даже если они одинаковы. Потому что один отличается. Заранее спасибо!

...