Ada · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Knowledge Variables API

3 actions 3 updates phrasing extends openapi/ada-variables-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Ada's API. It is a proposal applied on top of the contract, not a document Ada publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v2/variables/'].get

$.paths['/v2/variables/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knowledge Variables API
  version: 1.0.0
extends: openapi/ada-variables-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['/v2/variables/'].get
  update:
    x-apievangelist-phrasing:
      intent: List the AI Agent's variables
      effect: read
      questions:
      - Which variables can my AI Agent use?
      - Are reserved or internal variables included when I list them?
      instructions:
      - text: List all my variables.
      - text: Show the variables that appear on my dashboard.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/variables/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one variable
      effect: read
      questions:
      - How do I look up a single variable by its id?
      - Why would fetching a variable return a 404?
      instructions:
      - text: Get variable {id}.
        slots:
          id: path.id
      - text: Show me the details of variable {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'