Canonical · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for AMS external REST Addons API
8 actions
8 updates
phrasing
extends
openapi/canonical-add-ons-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.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/1.0/addons'].get
$.paths['/1.0/addons'].post
$.paths['/1.0/addons/{name}'].get
$.paths['/1.0/addons/{name}'].delete
$.paths['/1.0/addons/{name}'].patch
$.paths['/1.0/addons/{name}/{version}'].delete
$.paths['/1.0/addons?recursion=1'].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 AMS external REST Addons API
version: 1.0.0
extends: openapi/canonical-add-ons-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 7
- target: $.paths['/1.0/addons'].get
update:
x-apievangelist-phrasing:
intent: List addons in AMS
effect: read
questions:
- Which addons are installed in my Anbox Management Service?
- Can I list just addon names without their versions?
instructions:
- text: List the addons stored in AMS.
- text: Show AMS addons with recursion level {recursion}.
slots:
recursion: query.recursion
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/addons'].post
update:
x-apievangelist-phrasing:
intent: Create an addon by uploading a package
effect: write
questions:
- How do I upload a new addon with its manifest and hooks to AMS?
- Which archive formats can an AMS addon package use?
instructions:
- text: Create a new addon from this package with request metadata {request}.
slots:
request: header.X-AMS-Request
- text: Upload the addon archive with fingerprint {fingerprint} and request {request}.
slots:
fingerprint: header.X-AMS-Fingerprint
request: header.X-AMS-Request
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/addons/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get an addon
effect: read
questions:
- What versions exist for a particular AMS addon?
- What details does AMS keep for one stored addon?
instructions:
- text: Show addon {name}.
slots:
name: path.name
- text: Get the details and versions of AMS addon {name}.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/addons/{name}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an addon
effect: destructive
questions:
- How do I remove an addon and all its versions from AMS?
- Is deleting an AMS addon reversible?
instructions:
- text: Delete addon {name}.
slots:
name: path.name
- text: Remove AMS addon {name} with every version.
slots:
name: path.name
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/addons/{name}'].patch
update:
x-apievangelist-phrasing:
intent: Upload a new version of an addon
effect: write
questions:
- How do I ship an updated package for an existing addon?
- Does updating an AMS addon create a new addon version?
instructions:
- text: Upload a new package for addon {name} with request metadata {request}.
slots:
name: path.name
request: header.X-AMS-Request
- text: Create a new version of addon {name} from package fingerprint {fingerprint}, request {request}.
slots:
name: path.name
fingerprint: header.X-AMS-Fingerprint
request: header.X-AMS-Request
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/addons/{name}/{version}'].delete
update:
x-apievangelist-phrasing:
intent: Delete one version of an addon
effect: destructive
questions:
- Can I delete one broken version of an addon and keep the others?
- How do I remove a specific addon version from AMS?
instructions:
- text: Delete version {version} of addon {name}.
slots:
version: path.version
name: path.name
- text: Remove addon {name} version {version} only.
slots:
name: path.name
version: path.version
method: generated
generated: '2026-10-01'
- target: $.paths['/1.0/addons?recursion=1'].get
update:
x-apievangelist-phrasing:
intent: List addons with full details
effect: read
questions:
- Can I get every addon with its versions in one call?
- Can I see expanded addon records for the whole cluster?
instructions:
- text: List all addons in the cluster with full details.
- text: Get the expanded addon list at recursion {recursion}.
slots:
recursion: query.recursion
method: generated
generated: '2026-10-01'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/canonical-add-ons-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.