Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hardware API (hwapi) API

2 actions 2 updates phrasing extends openapi/canonical-hardware-api-hwapi-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['/'].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 Hardware API (hwapi) API
  version: 1.0.0
extends: openapi/canonical-hardware-api-hwapi-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['/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the hardware API root
      effect: read
      questions:
      - Is the hardware certification API up and responding?
      - What does the root of the hardware API return?
      instructions:
      - text: Call the hardware API root to confirm it responds.
      - text: Ping the hardware API.
      method: generated
      generated: '2026-09-26'