swagger: '2.0'
info:
  version: '2.0'
  title: language-descriptions
consumes:
  - application/json
produces:
  - application/json
paths:
  /language-descriptions:
    get:
      tags:
        - language-descriptions
      description: Get a collection of languages descriptions.
      operationId: getLanguageDescriptions
      parameters:
        - name: descriptionLanguageId
          in: query
          description: The language ID of the language that is being described.
          required: false
          type: integer
          format: int32
        - name: description
          in: query
          description: >-
            The description of the language that is displayed in a graphical
            user interface, which manages supported languages for a StoreEntity.
          required: false
          type: string
        - name: languageId
          in: query
          description: The language ID.
          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
        - 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 languages descriptions.
          schema:
            $ref: '#/definitions/LanguageDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - language-descriptions
      description: Create a language descriptions.
      operationId: createLanguageDescription
      parameters:
        - in: body
          name: LanguageDescription
          description: Language Description
          required: true
          schema:
            $ref: '#/definitions/LanguageDescription'
      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'
  '/language-descriptions/descriptionLanguageId:{descriptionLanguageId},languageId:{languageId}':
    get:
      tags:
        - language-descriptions
      description: Get a language descriptions.
      operationId: getLanguageDescriptionById
      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: Language Description
          schema:
            $ref: '#/definitions/LanguageDescription'
        '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:
        - language-descriptions
      description: Delete a language descriptions.
      operationId: deleteLanguageDescriptionById
      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:
        - language-descriptions
      description: Update a language descriptions.
      operationId: updateLanguageDescriptionById
      parameters:
        - in: body
          name: LanguageDescription
          description: Language Description
          required: true
          schema:
            $ref: '#/definitions/LanguageDescription'
      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: descriptionLanguageId
        in: path
        description: The language ID of the language that is being described.
        required: true
        type: integer
        format: int32
      - name: languageId
        in: path
        description: The language ID.
        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.
  LanguageDescription:
    type: object
    properties:
      descriptionLanguageId:
        type: integer
        format: int32
        description: The language ID of the language that is being described.
      description:
        type: string
        description: >-
          The description of the language that is displayed in a graphical user
          interface, which manages supported languages for a StoreEntity.
      languageId:
        type: integer
        format: int32
        description: The language ID.
    description: Language Description
  LanguageDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/LanguageDescription'
    description: A collection of languages descriptions.
