Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Testflinger API

2 actions 2 updates phrasing extends openapi/canonical-testflinger-api-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/'].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 Testflinger API
  version: 1.0.0
extends: openapi/canonical-testflinger-api-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/v1/'].get
  update:
    x-apievangelist-phrasing:
      intent: Identify the server
      effect: read
      questions:
      - Is this endpoint a Testflinger server?
      - What does the server root say about itself?
      instructions:
      - text: Identify the server.
      - text: Ping the v1 root to confirm the server responds.
      method: generated
      generated: '2026-10-01'