Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for COS registration server Schema API

2 actions 2 updates phrasing extends openapi/canonical-schema-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['/api/v1/schema/'].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 COS registration server Schema API
  version: 1.0.0
extends: openapi/canonical-schema-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['/api/v1/schema/'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the API's OpenAPI schema
      effect: read
      questions:
      - Can I download the OpenAPI 3 schema for this API?
      - Is the schema available as YAML or JSON?
      instructions:
      - text: Download the OpenAPI schema in {format} format.
        slots:
          format: query.format
      - text: Get the API schema localized for {lang}.
        slots:
          lang: query.lang
      method: generated
      generated: '2026-09-26'