Как определить массив объектов в OpenAPI 2.0? - PullRequest
Новая
       8

Как определить массив объектов в OpenAPI 2.0?

0 голосов
/ 02 марта 2020

Я новичок в использовании swaggerhub. Мне нужно определить API, и запрос должен выглядеть следующим образом json: 

{
  "acountNumber": "1234564545444854",
  "warningTypes":[
    {
      "warningCode": 122,
      "warningMessage": "string message"
    }    
   ]  
}

На данный момент у меня есть это: 

definitions:
  WarningCodes:
    type: object
    required:
    - accountNumber
    - warningCodes
    - messages
    properties:
      accountNumber:
        type: string
        example: 1234567890
      warningTypes:
        type: array
        items:
          type: object
          properties:
            warningCode:
            type: integer
            warningMessage:
            type: string

Не работает таким образом .

1 Ответ

0 голосов
/ 02 марта 2020

Кажется, что требуется новая сущность, такая как 

definitions:
  WarningCodes:
    type: object
    required:
    - accountNumber
    - warningCodes
    - messages
    properties:
      accountNumber:
        type: string
        example: '1234567890'

      warningTypes:
        type: array
        items:
          $ref: '#/definitions/WarningType'

  WarningType:
    type: object
    properties:
      warningCode:
        type: integer
        example: 122
      warningMessage:
        type: string
        minLength: 0
        maxLength: 256
        example: test1,test
...