openapi: 3.0.2
info:
  title: Composition API
  description: Composition API.
  version: 1.0.0
components:
  securitySchemes:
    appId:
      $ref: '../common/securitySchemes.yml#/appId'
    apiKey:
      $ref: '../common/securitySchemes.yml#/apiKey'
servers:
  - url: https://{appId}.algolia.net
    variables:
      appId:
        default: ALGOLIA_APPLICATION_ID
  - url: https://{appId}-1.algolianet.com
    variables:
      appId:
        default: ALGOLIA_APPLICATION_ID
  - url: https://{appId}-2.algolianet.com
    variables:
      appId:
        default: ALGOLIA_APPLICATION_ID
  - url: https://{appId}-3.algolianet.com
    variables:
      appId:
        default: ALGOLIA_APPLICATION_ID
  - url: https://{appId}-dsn.algolia.net
    variables:
      appId:
        default: ALGOLIA_APPLICATION_ID
security:
  - appId: []
    apiKey: []
tags:
  - name: Compositions
    description: |
      Manage your compositions and composition settings.
  - name: Rules
    description: |
      Manage your compositions rules.
  - name: Search
    description: Search one or more indices for matching records or facet values.
x-tagGroups:
  - name: Search
    tags:
      - Compositions
paths:
  # ######################
  # ### Custom request ###
  # ######################
  /{path}:
    $ref: '../common/paths/customRequest.yml'

  # ########################
  # ### Search Endpoints ###
  # ########################
  /1/compositions/{compositionID}/run:
    $ref: 'paths/search/run.yml'
  /1/compositions/{compositionID}/facets/{facetName}/query:
    $ref: 'paths/search/searchForFacetValues.yml'

  # #########################
  # ### Objects Endpoints ###
  # #########################
  /1/compositions/{compositionID}:
    $ref: 'paths/objects/objects.yml'
  /1/compositions/*/batch:
    $ref: 'paths/objects/multipleBatch.yml'

  # #######################
  # ### Rules Endpoints ###
  # #######################
  /1/compositions/{compositionID}/rules/{objectID}:
    $ref: 'paths/rules/rule.yml'
  /1/compositions/{compositionID}/rules/batch:
    $ref: 'paths/rules/saveRules.yml'
  /1/compositions/{compositionID}/rules/search:
    $ref: 'paths/rules/searchRules.yml'

  # ##########################
  # ### Advanced Endpoints ###
  # ##########################
  /1/compositions/{compositionID}/task/{taskID}:
    $ref: 'paths/advanced/getTask.yml'

  # #####################################
  # ### Manage Compositions Endpoints ###
  # #####################################
  /1/compositions:
    $ref: 'paths/manage_compositions/listCompositions.yml'

  # ###############
  # ### Helpers ###
  # ###############
  /setClientApiKey:
    $ref: '../common/helpers/setClientApiKey.yml#/method'

  /waitForCompositionTask:
    $ref: 'helpers/waitForCompositionTask.yml#/method'