Как исключить свойство из определения чванства

Я использую онлайн-редактор Swagger. Я создаю некоторую модель в определении

  Object:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      some_variable_to_exclude:
        type: string

Это полная модель, и я использую ее в разных ответах. Но в одном из них я хочу, чтобы моя модель не представляла свойство «some_variable_to_exclude». Как я могу это исключить? Это возможно ?
Хорошо, может быть, не исключить, может быть, какой-то комментарий рядом с объектом, но только для этого ответа.


swagger swagger-editor
person Abyss    schedule 23.03.2017    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Чтобы расширить схему Swagger с помощью пользовательских объектов, поле должно начинаться с x-.

Подробнее см. здесь: http://swagger.io/specification/#vendorExtensions

Например, swagger-node использует x-swagger-router-controller, чтобы указать, какой контроллер использовать для определенного пути API. Но вы можете использовать его для всего, что вам нужно, например, x-custom-property

person alemangui    schedule 27.03.2017