swagger: '2.0'
info:
  version: '2.0'
  title: widgets
consumes:
  - application/json
produces:
  - application/json
paths:
  /widgets:
    get:
      tags:
        - widgets
      description: Get the collection of all widgets.
      operationId: getWidgets
      parameters:
        - name: id
          in: query
          description: The identifier for widget.
          required: false
          type: number
        - name: storeId
          in: query
          description: The store identifier.
          required: false
          type: integer
          format: int32
        - name: pageLayoutWidgetDefId
          in: query
          description: The identifier for widget definition.
          required: false
          type: number
        - name: state
          in: query
          description: The state of widget.
          required: false
          type: boolean
        - name: definitionXml
          in: query
          description: The XML of widget definition.
          required: false
          type: string
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of widgets.
          schema:
            $ref: '#/definitions/WidgetCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - widgets
      description: Create a widget.
      operationId: createWidget
      parameters:
        - in: body
          name: Widget
          description: widget.
          required: true
          schema:
            $ref: '#/definitions/Widget'
      responses:
        '201':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/widgets/{id}':
    get:
      tags:
        - widgets
      description: Get a widget by Id.
      operationId: getWidgetById
      parameters:
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: widget.
          schema:
            $ref: '#/definitions/Widget'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    delete:
      tags:
        - widgets
      description: Delete a widget by Id.
      operationId: deleteWidgetById
      parameters: []
      responses:
        '204':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    patch:
      tags:
        - widgets
      description: Update a widget by Id.
      operationId: updateWidgetById
      parameters:
        - in: body
          name: Widget
          description: widget.
          required: true
          schema:
            $ref: '#/definitions/Widget'
      responses:
        '200':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The identifier for widget.
        required: true
        type: number
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  Widget:
    type: object
    properties:
      id:
        type: number
        description: The identifier for widget.
      storeId:
        type: integer
        format: int32
        description: The store identifier.
      pageLayoutWidgetDefId:
        type: number
        description: The identifier for widget definition.
      state:
        type: boolean
        description: The state of widget.
      definitionXml:
        type: string
        description: The XML of widget definition.
    description: widget.
  WidgetCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/Widget'
    description: A collection of widgets.
