Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AMS external REST Service API

3 actions 3 updates phrasing extends openapi/canonical-service-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['/1.0/'].get
$.paths['/1.0/version'].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 AMS external REST Service API
  version: 1.0.0
extends: openapi/canonical-service-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['/1.0/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check AMS status and supported extensions
      effect: read
      questions:
      - Is the Anbox Management Service up, and which API extensions does it support?
      - Is my connection to AMS trusted?
      instructions:
      - text: Show the AMS service status and API extensions.
      - text: Check whether my client is trusted by AMS.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/version'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the running AMS version
      effect: read
      questions:
      - What version of the Anbox Management Service is running?
      - Which AMS release is deployed on this server?
      instructions:
      - text: Tell me the running AMS version.
      - text: Get the release number of this AMS deployment.
      method: generated
      generated: '2026-09-26'