Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Test Results API

2 actions 2 updates phrasing extends openapi/canonical-test-results-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-results'].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 Test Observer Test Results API
  version: 1.0.0
extends: openapi/canonical-test-results-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-results'].get
  update:
    x-apievangelist-phrasing:
      intent: Search test results across artefacts
      effect: read
      questions:
      - Which test cases failed across all my artefacts last week?
      - Can I find every result for one test case linked to a known issue?
      - What results were recorded on a given environment for the latest executions only?
      instructions:
      - text: Find test results for test cases {test_cases} with status {test_result_statuses}.
        slots:
          test_cases: query.test_cases
          test_result_statuses: query.test_result_statuses
      - text: Search test results linked to issues {issues} from {from_date} to {until_date}.
        slots:
          issues: query.issues
          from_date: query.from_date
          until_date: query.until_date
      method: generated
      generated: '2026-09-26'