Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Artefact Builds API

2 actions 2 updates phrasing extends openapi/canonical-artefact-builds-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/artefacts/{artefact_id}/builds'].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 Artefact Builds API
  version: 1.0.0
extends: openapi/canonical-artefact-builds-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/artefacts/{artefact_id}/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an artefact's builds with test executions
      effect: read
      questions:
      - What builds does an artefact have and which tests ran on each?
      - Can I see the latest test executions per build for an artefact?
      instructions:
      - text: Show the latest builds and their test runs for artefact {artefact_id}.
        slots:
          artefact_id: path.artefact_id
      - text: List builds of artefact {artefact_id} with test executions.
        slots:
          artefact_id: path.artefact_id
      method: generated
      generated: '2026-09-26'