Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Test Plans API

2 actions 2 updates phrasing extends openapi/canonical-test-plans-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/v1/test-plans'].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 Test Observer Test Plans API
  version: 1.0.0
extends: openapi/canonical-test-plans-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: 1
- target: $.paths['/v1/test-plans'].get
  update:
    x-apievangelist-phrasing:
      intent: List test plan names
      effect: read
      questions:
      - Which test plans have been used in test executions?
      - Can I search test plan names within a family?
      instructions:
      - text: List all distinct test plan names.
      - text: Search test plans for {q} in families {families}, {limit} at a time.
        slots:
          q: query.q
          families: query.families
          limit: query.limit
      method: generated
      generated: '2026-09-26'