Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Reports API

3 actions 3 updates phrasing extends openapi/canonical-reports-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 3

$.info
$.paths['/v1/reports/test-results'].get
$.paths['/v1/reports/test-executions'].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 Reports API
  version: 1.0.0
extends: openapi/canonical-reports-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/reports/test-results'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a CSV of artefacts with test results
      effect: read
      questions:
      - Can I download a CSV of every artefact and its test results for a date range?
      - Which test results came in for artefacts during last month?
      instructions:
      - text: Export the test results report from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Give me a CSV of artefacts and their test results since {start_date}.
        slots:
          start_date: query.start_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reports/test-executions'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a CSV of test executions with environments
      effect: read
      questions:
      - Can I get a CSV of all test executions with their environment details?
      - Which test runs happened in a date window, and on what hardware?
      instructions:
      - text: Export the test executions report from {start_date} to {end_date}.
        slots:
          start_date: query.start_date
          end_date: query.end_date
      - text: Give me a CSV of test executions and environments until {end_date}.
        slots:
          end_date: query.end_date
      method: generated
      generated: '2026-09-26'