swagger: '2.0'
info:
  version: '2.0'
  title: command-registrations
consumes:
  - application/json
produces:
  - application/json
paths:
  /command-registrations:
    get:
      tags:
        - command-registrations
      description: Get a collection of registered commands.
      operationId: getCommandRegistrations
      parameters:
        - name: storeId
          in: query
          description: The unique numeric ID for identifying the store where the command is registered. A value of 0 means that the command implementation is registered and applicable to all stores.
          required: false
          type: integer
          format: int32
        - name: interfaceName
          in: query
          description: The command interface name.
          required: false
          type: string
        - name: className
          in: query
          description: The implementation class name for the command.
          required: false
          type: string
        - name: properties
          in: query
          description: The default properties that associated with the command. The properties are in the form "property1=value1&property2=value2" where "property" is the name of a property and "value" is the value for that property.
          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
      responses:
        '200':
          description: A collection of registered commands.
          schema:
            $ref: '#/definitions/CommandRegistrationCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - command-registrations
      description: Register a command in the command registry.
      operationId: createCommandRegistration
      parameters:
        - in: body
          name: CommandRegistration
          description: These services provide classes related to registering commands and managing existing command registrations.
          required: true
          schema:
            $ref: '#/definitions/CommandRegistration'
      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'
  '/command-registrations/storeId:{storeId},interfaceName:{interfaceName}':
    get:
      tags:
        - command-registrations
      description: Get a registered command from the command registry.
      operationId: getCommandRegistrationById
      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
      responses:
        '200':
          description: These services provide classes related to registering commands and managing existing command registrations.
          schema:
            $ref: '#/definitions/CommandRegistration'
        '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:
        - command-registrations
      description: Delete a registered command from the command registry.
      operationId: deleteCommandRegistrationById
      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:
        - command-registrations
      description: Update a registered command in the command registry.
      operationId: updateCommandRegistrationById
      parameters:
        - in: body
          name: CommandRegistration
          description: These services provide classes related to registering commands and managing existing command registrations.
          required: true
          schema:
            $ref: '#/definitions/CommandRegistration'
      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: storeId
        in: path
        description: The unique numeric ID for identifying the store where the command is registered. A value of 0 means that the command implementation is registered and applicable to all stores.
        required: true
        type: integer
        format: int32
      - name: interfaceName
        in: path
        description: The command interface name.
        required: true
        type: string
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.
  CommandRegistration:
    type: object
    properties:
      storeId:
        type: integer
        format: int32
        description: The unique numeric ID for identifying the store where the command is registered. A value of 0 means that the command implementation is registered and applicable to all stores.
      interfaceName:
        type: string
        description: The command interface name.
      className:
        type: string
        description: The implementation class name for the command.
      properties:
        type: string
        description: The default properties that associated with the command. The properties are in the form "property1=value1&property2=value2" where "property" is the name of a property and "value" is the value for that property.
    description: These services provide classes related to registering commands and managing existing command registrations.
  CommandRegistrationCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/CommandRegistration'
    description: A collection of registered commands.
