swagger: '2.0'
info:
  version: '2.0'
  title: facet-descriptions
consumes:
  - application/json
produces:
  - application/json
paths:
  /facet-descriptions:
    get:
      tags:
        - facet-descriptions
      description: Get a collection of facet descriptions.
      operationId: getFacetDescriptions
      parameters:
        - name: facetId
          in: query
          description: The unique identifier for this search facet.
          required: false
          type: integer
          format: int64
        - name: languageId
          in: query
          description: The language ID for identifying the description of the search facet.
          required: false
          type: integer
          format: int32
        - name: name
          in: query
          description: The language sensitive name for none attribute dictionary attribute based search facets.
          required: false
          type: string
        - name: description
          in: query
          description: The language sensitive administrative description for none attribute dictionary attribute based search facets.
          required: false
          type: string
        - name: field1
          in: query
          description: Customizable field.
          required: false
          type: integer
          format: int32
        - name: field2
          in: query
          description: Customizable field.
          required: false
          type: string
        - name: field3
          in: query
          description: Customizable field.
          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 facet descriptions.
          schema:
            $ref: '#/definitions/FacetDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - facet-descriptions
      description: Create a facet descriptions.
      operationId: createFacetDescription
      parameters:
        - in: body
          name: FacetDescription
          description: The search facet descriptions for none attribute dictionary attribute based facets.
          required: true
          schema:
            $ref: '#/definitions/FacetDescription'
      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'
  '/facet-descriptions/facetId:{facetId},languageId:{languageId}':
    get:
      tags:
        - facet-descriptions
      description: Get a facet descriptions.
      operationId: getFacetDescriptionById
      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: The search facet descriptions for none attribute dictionary attribute based facets.
          schema:
            $ref: '#/definitions/FacetDescription'
        '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:
        - facet-descriptions
      description: Delete a facet descriptions.
      operationId: deleteFacetDescriptionById
      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:
        - facet-descriptions
      description: Update a facet descriptions.
      operationId: updateFacetDescriptionById
      parameters:
        - in: body
          name: FacetDescription
          description: The search facet descriptions for none attribute dictionary attribute based facets.
          required: true
          schema:
            $ref: '#/definitions/FacetDescription'
      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: facetId
        in: path
        description: The unique identifier for this search facet.
        required: true
        type: integer
        format: int64
      - name: languageId
        in: path
        description: The language ID for identifying the description of the search facet.
        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.
  FacetDescription:
    type: object
    properties:
      facetId:
        type: integer
        format: int64
        description: The unique identifier for this search facet.
      languageId:
        type: integer
        format: int32
        description: The language ID for identifying the description of the search facet.
      name:
        type: string
        description: The language sensitive name for none attribute dictionary attribute based search facets.
      description:
        type: string
        description: The language sensitive administrative description for none attribute dictionary attribute based search facets.
      field1:
        type: integer
        format: int32
        description: Customizable field.
      field2:
        type: string
        description: Customizable field.
      field3:
        type: string
        description: Customizable field.
    description: The search facet descriptions for none attribute dictionary attribute based facets.
  FacetDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/FacetDescription'
    description: A collection of facet descriptions.
