Эксклюзивный минимум в Swagger OAS 3.0 не применяется - PullRequest
0 голосов
/ 20 декабря 2018

Редактор Swagger дает мне этот пример ответа:

[
  {
    "simulation_run_id": 0
  }
]

для определения:

  /v1/simulation-run-submissions:
    post:
      summary: 'Post a simulation run creation TODO: Will need to update API with parameters weather file, glmfile, name, start,end,interval, etc.. check wireframe.  Submit model file and get back validation and ID.  We will use the same API above and just return validation error.'
      #description:
      responses:
        '201':
          description: The metadata for a simulation run
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SimulationRunSubmissionResponse'
...
components:
  schemas:
    SimulationRunId:
      type : integer
      format: int64
      minimum: 1
      exclusiveMinimum: true

Параметр exclusiveMinimum не применяется к схеме в качестве примерапоказывает 0.

1 Ответ

0 голосов
/ 20 декабря 2018

В настоящее время Swagger UI и Swagger Editor не используют значения minimum и exclusiveMinimum при создании примеров запросов и ответов.Не стесняйтесь отправить запрос на улучшение .

Самое простое решение - указать example вручную:

components:
  schemas:
    SimulationRunId:
      type : integer
      format: int64
      minimum: 1
      exclusiveMinimum: true
      example: 2  # <-------
...