openapi: 3.0.2
info:
  title: Query Suggestions API
  description: |
    The Query Suggestions API lets you manage Algolia's Query Suggestions configurations.
    Query Suggestions add new indices with popular search queries, external suggestions, or facet values to your Algolia application.
    In your user interface, you can query the Query Suggestions indices like regular indices and add [suggested searches](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/query-suggestions/js/) to guide users and speed up their search.
  version: 1.0.0
components:
  securitySchemes:
    appId:
      $ref: '../common/securitySchemes.yml#/appId'
    apiKey:
      $ref: '../common/securitySchemes.yml#/apiKey'
servers:
  - url: https://query-suggestions.{region}.algolia.com
    description: |
      You can check the region for your application in the [Algolia dashboard](https://dashboard.algolia.com/account/infrastructure/analytics).
      If you connect to the wrong region, the API returns an error with the status `401` and the message: "The log processing region does not match".
    variables:
      region:
        enum:
          - us
          - eu
        default: us
security:
  - appId: []
    apiKey: []
tags:
  - name: configurations
    x-displayName: Configurations
    description: Manage Query Suggestions configurations.
  - name: logs
    x-displayName: Logs
    description: Get logs for a Query Suggestions index.
x-tagGroups: 
  - name: Configurations
    tags:
      - configurations
  - name: Logs
    tags:
      - logs
paths:
  # ######################
  # ### Custom request ###
  # ######################
  /{path}:
    $ref: '../common/paths/customRequest.yml'

  /1/configs:
    $ref: 'paths/qsConfigs.yml'
  /1/configs/{indexName}:
    $ref: 'paths/qsConfig.yml'
  /1/configs/{indexName}/status:
    $ref: 'paths/getConfigurationStatus.yml'
  /1/logs/{indexName}:
    $ref: 'paths/getLogFile.yml'