Définissez un objet de réponse avec un tableau en YAML à l'aide de Swagger Editor

Question

Je travaille sur une définition d'API dans Swagger Editor avec YAML. J'essaie de représenter le corps de réponse suivant:

{
    success: true,
    ids: [123456, ...]
}

et voici à quoi ressemble mon YAML:

definitions:
  SuccessfulResponse:
    type: object 
    properties:
      success:
        type: boolean
        description: True if the all operations were successful
      ids:
        type: array
        items: 
          id: 
          type: string 

J'ai essayé plusieurs manières différentes mais comme ça mais rien ne semble valide

Comment puis-je décrire correctement l'objet de retour que j'ai donné ci-dessus?

Answer 1

Voici un exemple pour définir une propriété comme un tableau de chaînes:

  photoUrls:
    type: array
    items:
      type: string

Réf: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml#L661-L667