overlay: 1.0.0
info:
  title: API Evangelist enhancements for Algolia Composition API
  version: 1.0.0
  x-generated: '2026-08-27'
  x-method: generated
  x-source: Generated by the API Evangelist enrichment pipeline over openapi/algolia-composition-api-openapi.yml. The upstream
    Algolia document is never mutated in place; the pristine harvest is archived at openapi/_original/.
extends: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/openapi/algolia-composition-api-openapi.yml
actions:
- target: $.info
  description: Attach API Evangelist catalog identity so the document is traceable back to the provider profile.
  update:
    x-api-evangelist:
      provider: Algolia
      providerId: algolia
      profile: https://apis.io/provider/algolia/
      apis_yml: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/apis.yml
      upstream: https://github.com/algolia/api-clients-automation/tree/main/specs/bundled
      harvested: '2026-08-27'
- target: $.info
  description: Point at the cross-cutting runtime semantics this document does not itself carry.
  update:
    x-conventions: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/conventions/algolia-conventions.yml
    x-error-catalog: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/errors/algolia-problem-types.yml
    x-rate-limits: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/rate-limits/algolia-rate-limits.yml
    x-authentication: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/authentication/algolia-authentication.yml
    x-lifecycle: https://raw.githubusercontent.com/api-evangelist/algolia/refs/heads/main/lifecycle/algolia-lifecycle.yml
- target: $.info
  description: 'Record the two conventions an agent must know that no operation schema states: writes are asynchronous, and
    the fallback hosts are part of the contract.'
  update:
    x-write-semantics:
      asynchronous: true
      note: Write operations return a taskID rather than the committed state. Poll waitTask before reading back.
      docs: https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/in-depth/index-operations-are-asynchronous
    x-retry-strategy:
      required: true
      fallback_hosts:
      - https://{APPLICATION_ID}-1.algolianet.com
      - https://{APPLICATION_ID}-2.algolianet.com
      - https://{APPLICATION_ID}-3.algolianet.com
      note: Fallback hosts use a different DNS provider than the primary hosts and must be randomized. Every official Algolia
        client implements this; a direct REST caller must implement it itself.