Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Split Test API

7 actions 7 updates phrasing extends openapi/netlify-split-test-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Netlify's API. It is a proposal applied on top of the contract, not a document Netlify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/sites/{site_id}/traffic_splits'].get
$.paths['/sites/{site_id}/traffic_splits'].post
$.paths['/sites/{site_id}/traffic_splits/{split_test_id}'].get
$.paths['/sites/{site_id}/traffic_splits/{split_test_id}'].put
$.paths['/sites/{site_id}/traffic_splits/{split_test_id}/publish'].post
$.paths['/sites/{site_id}/traffic_splits/{split_test_id}/unpublish'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Netlify's API documentation Split Test API
  version: 1.0.0
extends: openapi/netlify-split-test-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: 6
- target: $.paths['/sites/{site_id}/traffic_splits'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's split tests
      effect: read
      questions:
      - What split tests are configured on my site?
      - Can I see how traffic is divided between branches?
      instructions:
      - text: List split tests for site {site}.
        slots:
          site: path.site_id
      - text: Show every traffic split on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sites/{site_id}/traffic_splits'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a branch split test
      effect: write
      questions:
      - How do I A/B test two branches of my Netlify site?
      - Can I send a percentage of traffic to a different branch?
      instructions:
      - text: Create a split test on site {site}.
        slots:
          site: path.site_id
      - text: Create a split test on site {site} dividing traffic as {branches}.
        slots:
          site: path.site_id
          branches: requestBody.branch_tests
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sites/{site_id}/traffic_splits/{split_test_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a split test
      effect: read
      questions:
      - Can I view one split test's traffic allocation?
      - Is a particular split test currently live?
      instructions:
      - text: Get split test {test} on site {site}.
        slots:
          site: path.site_id
          test: path.split_test_id
      - text: Show the branch allocation for split test {test} of site {site}.
        slots:
          site: path.site_id
          test: path.split_test_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sites/{site_id}/traffic_splits/{split_test_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a split test's traffic split
      effect: write
      questions:
      - Can I change the traffic percentages in an existing split test?
      - How do I add another branch to a running A/B test?
      instructions:
      - text: Update split test {test} on site {site} to {branches}.
        slots:
          test: path.split_test_id
          site: path.site_id
          branches: requestBody.branch_tests
      - text: Change traffic allocation of split test {test} on site {site}.
        slots:
          site: path.site_id
          test: path.split_test_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sites/{site_id}/traffic_splits/{split_test_id}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a split test
      effect: write
      questions:
      - How do I publish a split test so it starts routing traffic?
      - Can I turn on a split test I've configured?
      instructions:
      - text: Start split test {test} on site {site}.
        slots:
          site: path.site_id
          test: path.split_test_id
      - text: Publish split test {test} for site {site}.
        slots:
          site: path.site_id
          test: path.split_test_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/sites/{site_id}/traffic_splits/{split_test_id}/unpublish'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop a split test
      effect: write
      questions:
      - How do I end an A/B test and send all traffic back to one branch?
      - Can I pause a split test without deleting it?
      instructions:
      - text: Stop split test {test} on site {site}.
        slots:
          site: path.site_id
          test: path.split_test_id
      - text: Unpublish split test {test} for site {site}.
        slots:
          site: path.site_id
          test: path.split_test_id
      method: generated
      generated: '2026-10-01'