# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for A/B Testing Abtesting API
  version: 1.0.0
extends: openapi/algolia-ab-testing-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Send a raw GET request to the A/B testing API
      effect: read
      questions:
      - Can I read from an A/B testing endpoint the client library doesn't wrap yet?
      - Is there a generic way to fetch any A/B testing API path with my own query parameters?
      instructions:
      - text: Send a raw GET request to A/B testing API path {path}.
        slots:
          path: path.path
      - text: Fetch A/B testing path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{path}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a raw PUT request to the A/B testing API
      effect: write
      questions:
      - Can I send a custom PUT to an A/B testing path that has no dedicated method?
      - Is there a passthrough for replacing a resource on an arbitrary A/B testing endpoint?
      instructions:
      - text: Send a raw PUT request to A/B testing API path {path}.
        slots:
          path: path.path
      - text: PUT to A/B testing path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a raw POST request to the A/B testing API
      effect: write
      questions:
      - Can I POST to an A/B testing endpoint the SDK doesn't expose as a method?
      - What's the generic escape hatch for posting to any A/B testing API path?
      instructions:
      - text: Send a raw POST request to A/B testing API path {path}.
        slots:
          path: path.path
      - text: POST to A/B testing path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{path}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Send a raw DELETE request to the A/B testing API
      effect: destructive
      questions:
      - Can I issue a DELETE against an arbitrary A/B testing API path?
      - Is there a generic delete call for A/B testing endpoints without a dedicated method?
      instructions:
      - text: Send a raw DELETE request to A/B testing API path {path}.
        slots:
          path: path.path
      - text: DELETE A/B testing path {path} with query parameters {parameters}.
        slots:
          path: path.path
          parameters: query.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2/abtests'].get
  update:
    x-apievangelist-phrasing:
      intent: List A/B tests with the deprecated v2 endpoint
      effect: read
      questions:
      - How do I list every A/B test configured in my Algolia application using the old v2 API?
      - Can I filter the legacy v2 A/B test list to indices starting with a given prefix?
      - What paging options does the deprecated v2 A/B test listing support?
      instructions:
      - text: List all my A/B tests using the deprecated v2 endpoint.
      - text: List v2 A/B tests on indices with prefix {indexPrefix}, {limit} per page.
        slots:
          indexPrefix: query.indexPrefix
          limit: query.limit
      - text: Show legacy v2 A/B tests for indices ending in {indexSuffix}.
        slots:
          indexSuffix: query.indexSuffix
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2/abtests'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an A/B test with the deprecated v2 endpoint
      effect: write
      questions:
      - How do I start a new A/B test between two index variants with the legacy v2 API?
      - Do I have to set an end date when creating a v2 A/B test?
      instructions:
      - text: Create a v2 A/B test named {name} comparing variants {variants}, ending at {endAt}.
        slots:
          name: requestBody.name
          variants: requestBody.variants
          endAt: requestBody.endAt
      - text: Set up an old-style v2 A/B test called {name} that runs until {endAt}.
        slots:
          name: requestBody.name
          endAt: requestBody.endAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2/abtests/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one A/B test's details via the v2 endpoint
      effect: read
      questions:
      - How can I see the details and results of a single A/B test by its ID on the v2 API?
      - Where do I look up the variants of one specific legacy v2 A/B test?
      instructions:
      - text: Show me the details of v2 A/B test {id}.
        slots:
          id: path.id
      - text: Retrieve A/B test {id} using the deprecated v2 endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2/abtests/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an A/B test via the v2 endpoint
      effect: destructive
      questions:
      - How do I permanently remove an A/B test with the legacy v2 API?
      - Can I delete an old A/B test by its ID on v2?
      instructions:
      - text: Delete v2 A/B test {id}.
        slots:
          id: path.id
      - text: Remove A/B test {id} using the deprecated v2 delete endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2/abtests/{id}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a running A/B test via the v2 endpoint
      effect: destructive
      questions:
      - How do I end an A/B test early on the v2 API?
      - Can I restart an A/B test after I stop it?
      instructions:
      - text: Stop v2 A/B test {id} now.
        slots:
          id: path.id
      - text: End the running A/B test {id} early using the deprecated v2 stop endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/2/abtests/estimate'].post
  update:
    x-apievangelist-phrasing:
      intent: Estimate A/B test sample size and duration (v2)
      effect: read
      questions:
      - How long would my A/B test need to run to detect the effect size I expect?
      - What sample size does the legacy v2 estimator suggest for a given traffic split?
      instructions:
      - text: Estimate sample size and duration for an A/B test with configuration {configuration} and variants {variants} on v2.
        slots:
          configuration: requestBody.configuration
          variants: requestBody.variants
      - text: Work out how many days a v2 A/B test on variants {variants} would take to reach significance.
        slots:
          variants: requestBody.variants
      method: generated
      generated: '2026-10-01'
- target: $.paths['/setClientApiKey'].get
  update:
    x-apievangelist-phrasing:
      intent: Switch the API key the A/B testing client uses
      effect: write
      questions:
      - Can I change which API key my A/B testing client authenticates with without rebuilding it?
      - How do I rotate the key an existing A/B testing client sends on requests?
      instructions:
      - text: Switch the A/B testing client to authenticate with API key {apiKey}.
        slots:
          apiKey: query.apiKey
      - text: Use {apiKey} for all further A/B testing API requests.
        slots:
          apiKey: query.apiKey
      method: generated
      generated: '2026-10-01'