swagger: '2.0'
info:
  version: '2.0'
  title: search-collections
consumes:
  - application/json
produces:
  - application/json
paths:
  /search-collections:
    get:
      tags:
        - search-collections
      description: Get a collection of search collections.
      operationId: getSearchCollections
      parameters:
        - name: id
          in: query
          description: The unique numeric ID for identifying the search collection.
          required: false
          type: integer
          format: int64
        - name: indexId
          in: query
          description: The index ID property of the search collection.
          required: false
          type: string
        - name: indexType
          in: query
          description: The index type property of the search collection.
          required: false
          type: string
        - name: indexSubType
          in: query
          description: The index sub-type property of the search collection.
          required: false
          type: string
        - name: languageId
          in: query
          description: The language ID property of the the search collection.
          required: false
          type: integer
          format: int32
        - name: properties
          in: query
          description: The custom properties to override the default search collection properties.
          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 collections.
          schema:
            $ref: '#/definitions/SearchCollectionCollection'
        '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-collections
      description: Create a search collection.
      operationId: createSearchCollection
      parameters:
        - in: body
          name: SearchCollection
          description: The search collection.
          required: true
          schema:
            $ref: '#/definitions/SearchCollection'
      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-collections/{id}':
    get:
      tags:
        - search-collections
      description: Get a search collection by its unique ID.
      operationId: getSearchCollectionById
      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 collection.
          schema:
            $ref: '#/definitions/SearchCollection'
        '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-collections
      description: Delete a search collection.
      operationId: deleteSearchCollectionById
      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-collections
      description: Update a search collection.
      operationId: updateSearchCollectionById
      parameters:
        - in: body
          name: SearchCollection
          description: The search collection.
          required: true
          schema:
            $ref: '#/definitions/SearchCollection'
      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: id
        in: path
        description: The unique numeric ID for identifying the search collection.
        required: true
        type: integer
        format: int64
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.
  SearchCollection:
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: The unique numeric ID for identifying the search collection.
      indexId:
        type: string
        description: The index ID property of the search collection.
      indexType:
        type: string
        description: The index type property of the search collection.
      indexSubType:
        type: string
        description: The index sub-type property of the search collection.
      languageId:
        type: integer
        format: int32
        description: The language ID property of the the search collection.
      properties:
        type: string
        description: The custom properties to override the default search collection properties.
    description: The search collection.
  SearchCollectionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/SearchCollection'
    description: A collection of search collections.
