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

Question

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

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

William Cheng · Accepted Answer · 2018-06-18 03:09:22Z

24

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

  photoUrls:
    type: array
    items:
      type: string

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

edited Jun 18, 2018 at 3:09

answered Nov 7, 2016 at 5:54

William Cheng

10.9k5 gold badges57 silver badges85 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Tim Holt Over a year ago

Both editor options and referenced content has changed and is no longer valid.

William Cheng Over a year ago

Updated the reference

Collectives™ on Stack Overflow

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

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related