Скрытие полей в примере значения, но не в модели тела запроса в Swagger UI

Question

Мы пытаемся создать сценарий для пользовательского интерфейса Swagger в разделе Body.В разделе «Запросы» мы можем иметь пример значения JSON, скрывающий одно или несколько полей, но модель все равно будет отображать эти поля?

Мы в основном пытаемся уменьшить количество полей в теле запроса, но имеем всеполя, видимые в модели.

Например, мы хотели бы скрыть name в следующем примере:

, но по-прежнему отображать name в модели здесь:

Answer 1

Чтобы скрыть поля от автоматически сгенерированных примеров моделей в Swagger UI, вам нужно добавить пользовательский example для этой модели, включающий только необходимые поля.

definitions:
  Pet:
    type: object
    properties:
      ...

    # Override model example that will be displayed in Swagger UI
    example:
      id: foo
      status: available