DelightedD0D DelightedD0D - 26 days ago 25
YAML Question

Define a response object with an array in YAML using Swagger Editor

I'm working on an API definition in Swagger Editor with YAML. I am trying to represent the following response body:

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


and this is what my YAML looks like:

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


Ive tried several different ways but like this but nothing seems valid

enter image description here

How do I properly describe the return object that Ive given above?

Answer

Here is an example to define a property as an array of string:

  photoUrls:
    type: array
    items:
      type: string

Ref: go to https://editor.swagger.io => File (top menu) => Open Example => "petstore_full.yaml" => line 538 - 541

Comments