Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for AMS external REST Config API

3 actions 3 updates phrasing extends openapi/canonical-config-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/config'].get
$.paths['/1.0/config'].patch

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 Config API
  version: 1.0.0
extends: openapi/canonical-config-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/config'].get
  update:
    x-apievangelist-phrasing:
      intent: Show the AMS service configuration
      effect: read
      questions:
      - What configuration values is the Anbox Management Service currently using?
      - Can I check a service setting before changing it?
      instructions:
      - text: Show the current AMS configuration.
      - text: List every service configuration value.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/1.0/config'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an AMS service setting
      effect: write
      questions:
      - How do I change a configuration item on the Anbox Management Service?
      - Can I update one service setting by name?
      instructions:
      - text: Set AMS configuration item {name} to {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Update service setting {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'