Редактор Swagger выдает ошибку при указании ответа "Недопустимое определение ответа"

Question

Я пытаюсь сгенерировать документацию по API с помощью редактора Swagger. Я указал свою спецификацию API следующим образом

paths:
  /opendata/v1/{index}:
    get:
      tags: [verification]
      description: Verify the person information
      parameters:
        - name: index
          in: path
          description: specific data index
          required: true
          type: string
        - name: name
          in: query
          description: name of a person
          required: false
          type: string
        - name: company name
          in: query
          description: name of a company
          required: false
          type: string

      responses:
        '200':
          description: Success
          content:
            application/json:
              schemas:
                $ref: '#/responses/200'



responses:
    '200':
      description: Success
      schema:
        type: object
        properties:
          verification:
            type: string

Но в редакторе всегда отображается ошибка "Неправильное определение ответа". Я проверил спецификацию для ответа отсюда. Какие изменения я должен сделать, чтобы ошибка не наступила.

Примечание: я хочу получить ответ в форме json, как показано ниже:

{
    verification:string
}

Answer 1

Вы смешиваете синтаксис OpenAPI/Swagger 2.0 и OpenAPI 3.0. Ваша спецификация, кажется, swagger: '2.0', так что вы должны использовать:

paths:
  /opendata/v1/{index}:
    get:
      ...

      produces:
        - application/json
      responses:
        200:
          $ref: '#/responses/200'

Вот соответствующее руководство по OpenAPI/Swagger 2.0: Описание ответов