Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Test Cases API

6 actions 6 updates phrasing extends openapi/canonical-test-cases-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 6

$.info

$.paths['/v1/test-cases/reported-issues'].get

$.paths['/v1/test-cases/reported-issues'].post

$.paths['/v1/test-cases/reported-issues/{issue_id}'].put

$.paths['/v1/test-cases/reported-issues/{issue_id}'].delete

$.paths['/v1/test-cases'].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 Cases API
  version: 1.0.0
extends: openapi/canonical-test-cases-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: 5
- target: $.paths['/v1/test-cases/reported-issues'].get
  update:
    x-apievangelist-phrasing:
      intent: List issues reported against test cases
      effect: read
      questions:
      - Which known issues are linked to a test case?
      - Can I filter reported issues by test template?
      instructions:
      - text: List reported issues for test case {case_name}.
        slots:
          case_name: query.case_name
      - text: Show issues reported for template {template_id}.
        slots:
          template_id: query.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-cases/reported-issues'].post
  update:
    x-apievangelist-phrasing:
      intent: Report an issue for a test case
      effect: write
      questions:
      - How do I link a bug report to a failing test case?
      - Can I attach a known issue to a whole test template?
      instructions:
      - text: Report issue {url} described as {description} for test case {case_name}.
        slots:
          url: requestBody.url
          description: requestBody.description
          case_name: requestBody.case_name
      - text: Link bug {url} ({description}) to template {template_id}.
        slots:
          url: requestBody.url
          description: requestBody.description
          template_id: requestBody.template_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-cases/reported-issues/{issue_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a reported test case issue
      effect: write
      questions:
      - Can I change the bug link on an issue I already reported?
      - How do I edit the description of a reported test issue?
      instructions:
      - text: Update reported issue {issue_id} to link {url} with description {description}.
        slots:
          issue_id: path.issue_id
          url: requestBody.url
          description: requestBody.description
      - text: Move reported issue {issue_id} to test case {case_name}, keeping url {url} and description {description}.
        slots:
          issue_id: path.issue_id
          case_name: requestBody.case_name
          url: requestBody.url
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-cases/reported-issues/{issue_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a reported test case issue
      effect: destructive
      questions:
      - How do I remove an issue report once the bug is fixed?
      - Can I unlink a reported issue from a test case?
      instructions:
      - text: Delete reported issue {issue_id}.
        slots:
          issue_id: path.issue_id
      - text: Unlink the fixed issue {issue_id}.
        slots:
          issue_id: path.issue_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/test-cases'].get
  update:
    x-apievangelist-phrasing:
      intent: Search test cases and their templates
      effect: read
      questions:
      - Which test cases exist for disk tests?
      - How do I search test cases by name and family?
      instructions:
      - text: Search test cases matching {q}.
        slots:
          q: query.q
      - text: List {limit} test cases in families {families}.
        slots:
          limit: query.limit
          families: query.families
      method: generated
      generated: '2026-09-26'