Skip to content

Handle array body parameters #8

Description

@pouyanh

There are requests which their body have to be an array, and not an object:

swagger: '2.0'
info:
  title: entities management
  version: 2.0.0
schemes:
  - http
consumes:
  - application/entities.management.api.v1+json
  - application/json
  - text/plain
produces:
  - application/entities.management.api.v1+json
  - application/json
paths:
  /entities:
    post:
      tags:
        - entities
      operationId: createEntities
      summary: Create new entities
      parameters:
        - name: entities
          in: body
          required: true
          schema:
            type: array
            items:
              $ref: "#/definitions/entity"
      responses:
        201:
          description: Created all
          schema:
            type: object
            properties:
              entities:
                type: array
                items:
                  $ref: "#/definitions/entity"
        207:
          description: Created some
          schema:
            type: object
            properties:
              entities:
                type: array
                items:
                  $ref: "#/definitions/entity"
              errors:
                type: array
                items:
                  $ref: "#/definitions/error"
        default:
          description: error
          schema:
            $ref: "#/definitions/error"
definitions:
  entity:
    type: object
    required:
      - entityId
      - name
    properties:
      entityId:
        type: integer
        format: int32
        readOnly: true
        description: Internal identifier of an entity
      name:
        type: string
        description: Name of an entity

  error:
    type: object
    required:
       - message
    properties:
      code:
        type: integer
        format: int64
      message:
        type: string
      fields:
        type: array
        items:
          type: string

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions