Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Platform Status Service API

3 actions 3 updates phrasing extends openapi/canonical-statusservice-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 3

$.info

$.paths['/api/v0/status'].get

$.paths['/api/v0/version'].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 Identity Platform Status Service API
  version: 1.0.0
extends: openapi/canonical-statusservice-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: 2
- target: $.paths['/api/v0/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check service status
      effect: read
      questions:
      - Is the service up and healthy right now?
      - Can I get a health status check from the API?
      instructions:
      - text: Check the service status.
      - text: Report whether the API is healthy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the running service version
      effect: read
      questions:
      - Which version of the service is deployed?
      - Can I find out what build the API is running?
      instructions:
      - text: Show the service version.
      - text: Tell me which release of the API is running.
      method: generated
      generated: '2026-09-26'