Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hardware API (hwapi) Certification API

2 actions 2 updates phrasing extends openapi/canonical-certification-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/certification/status'].post

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) Certification API
  version: 1.0.0
extends: openapi/canonical-certification-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/certification/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether a system is Ubuntu certified
      effect: read
      questions:
      - Is my laptop model certified for Ubuntu?
      - Have components of this machine been seen on other certified systems?
      instructions:
      - text: Check certification for {vendor} {model} ({architecture}), board {board}, processor {processor}, OS {os}.
        slots:
          vendor: requestBody.vendor
          model: requestBody.model
          architecture: requestBody.architecture
          board: requestBody.board
          processor: requestBody.processor
          os: requestBody.os
      - text: Look up the certification status of {vendor} {model} with board {board}, CPU {processor}, {architecture}, running {os}.
        slots:
          vendor: requestBody.vendor
          model: requestBody.model
          board: requestBody.board
          processor: requestBody.processor
          architecture: requestBody.architecture
          os: requestBody.os
      method: generated
      generated: '2026-09-26'