swagger: '2.0'
info:
  version: '2.0'
  title: search-configurations
consumes:
  - application/json
produces:
  - application/json
paths:
  /search-configurations:
    get:
      tags:
        - search-configurations
      description: Get a collection of search configurations.
      operationId: getSearchConfigurations
      parameters:
        - name: indexType
          in: query
          description: The index type property of the search configuration.
          required: false
          type: string
        - name: indexId
          in: query
          description: The index ID property of the search configuration.
          required: false
          type: string
        - name: languages
          in: query
          description: The comma-separated list of language IDs of the search configuration.
          required: false
          type: string
        - name: properties
          in: query
          description: The default properties of the search configuration.
          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 search configurations.
          schema:
            $ref: '#/definitions/SearchConfigurationCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - search-configurations
      description: Create a search configuration.
      operationId: createSearchConfiguration
      parameters:
        - in: body
          name: SearchConfiguration
          description: The search configuration.
          required: true
          schema:
            $ref: '#/definitions/SearchConfiguration'
      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'
  '/search-configurations/indexType:{indexType},indexId:{indexId}':
    get:
      tags:
        - search-configurations
      description: Get a search configuration.
      operationId: getSearchConfigurationById
      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 configuration.
          schema:
            $ref: '#/definitions/SearchConfiguration'
        '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:
        - search-configurations
      description: Delete a search configuration.
      operationId: deleteSearchConfigurationById
      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:
        - search-configurations
      description: Update a search configuration.
      operationId: updateSearchConfigurationById
      parameters:
        - in: body
          name: SearchConfiguration
          description: The search configuration.
          required: true
          schema:
            $ref: '#/definitions/SearchConfiguration'
      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: indexType
        in: path
        description: The index type property of the search configuration.
        required: true
        type: string
      - name: indexId
        in: path
        description: The index ID property of the search configuration.
        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.
  SearchConfiguration:
    type: object
    properties:
      indexType:
        type: string
        description: The index type property of the search configuration.
      indexId:
        type: string
        description: The index ID property of the search configuration.
      languages:
        type: string
        description: The comma-separated list of language IDs of the search configuration.
      properties:
        type: string
        description: The default properties of the search configuration.
    description: The search configuration.
  SearchConfigurationCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/SearchConfiguration'
    description: A collection of search configurations.
