Talon.One · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Management Experiments API

3 actions 3 updates phrasing extends openapi/talon-one-experiments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Talon.One's API. It is a proposal applied on top of the contract, not a document Talon.One publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/applications/{applicationId}/experiments'].get
$.paths['/v1/applications/{applicationId}/experiments/{experimentId}'].get

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 Management Experiments API
  version: 1.0.0
extends: openapi/talon-one-experiments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/applications/{applicationId}/experiments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an Application's experiments
      effect: read
      questions:
      - What A/B experiments are running in an Application?
      - Can I sort an Application's experiments?
      instructions:
      - text: List the experiments in application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show experiments of application {applicationId} sorted by {sort}.
        slots:
          applicationId: path.applicationId
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/applications/{applicationId}/experiments/{experimentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one experiment
      effect: read
      questions:
      - How is a particular experiment configured?
      - Where do I read the details of an experiment by its ID?
      instructions:
      - text: Get experiment {experimentId} in application {applicationId}.
        slots:
          experimentId: path.experimentId
          applicationId: path.applicationId
      - text: Show the setup of experiment {experimentId} (application {applicationId}).
        slots:
          experimentId: path.experimentId
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'