swagger: '2.0'
info:
  version: '2.0'
  title: store-descriptions
consumes:
  - application/json
produces:
  - application/json
paths:
  /store-descriptions:
    get:
      tags:
        - store-descriptions
      description: Get a collection of store descriptions.
      operationId: getStoreDescriptions
      parameters:
        - name: storeId
          in: query
          description: The store ID.
          required: false
          type: integer
          format: int32
        - name: displayName
          in: query
          description: A brief description of the store suitable for display to customers in the given language.
          required: false
          type: string
        - name: description
          in: query
          description: A longer description of the store suitable for display to customers in the given language.
          required: false
          type: string
        - name: contactAddress
          in: query
          description: The contact address of the store.
          required: false
          type: integer
          format: int32
        - name: locationAddress
          in: query
          description: The physical location of the store.
          required: false
          type: integer
          format: int32
        - name: languageId
          in: query
          description: The language of the description.
          required: false
          type: integer
          format: int32
        - 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 store descriptions.
          schema:
            $ref: '#/definitions/StoreDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - store-descriptions
      description: Create a store description.
      operationId: createStoreDescription
      parameters:
        - in: body
          name: StoreDescription
          description: The store description.
          required: true
          schema:
            $ref: '#/definitions/StoreDescription'
      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'
  '/store-descriptions/storeId:{storeId},languageId:{languageId}':
    get:
      tags:
        - store-descriptions
      description: Get a store description.
      operationId: getStoreDescriptionById
      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: The store description.
          schema:
            $ref: '#/definitions/StoreDescription'
        '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:
        - store-descriptions
      description: Delete a store description.
      operationId: deleteStoreDescriptionById
      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:
        - store-descriptions
      description: Update a store description.
      operationId: updateStoreDescriptionById
      parameters:
        - in: body
          name: StoreDescription
          description: The store description.
          required: true
          schema:
            $ref: '#/definitions/StoreDescription'
      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 store ID.
        required: true
        type: integer
        format: int32
      - name: languageId
        in: path
        description: The language of the description.
        required: true
        type: integer
        format: int32
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.
  StoreDescription:
    type: object
    properties:
      storeId:
        type: integer
        format: int32
        description: The store ID.
      displayName:
        type: string
        description: A brief description of the store suitable for display to customers in the given language.
      description:
        type: string
        description: A longer description of the store suitable for display to customers in the given language.
      contactAddress:
        type: integer
        format: int32
        description: The contact address of the store.
      locationAddress:
        type: integer
        format: int32
        description: The physical location of the store.
      languageId:
        type: integer
        format: int32
        description: The language of the description.
    description: The store description.
  StoreDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/StoreDescription'
    description: A collection of store descriptions.
