Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for debarchive Operation Service API

3 actions 3 updates phrasing extends openapi/canonical-operationservice-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['/v1/operations/{operation}'].get

$.paths['/v1/operations:batchGet'].post

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 debarchive Operation Service API
  version: 1.0.0
extends: openapi/canonical-operationservice-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['/v1/operations/{operation}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the state of a long-running operation
      effect: read
      questions:
      - Has my long-running operation finished yet?
      - How do I poll for the result of an operation?
      instructions:
      - text: Get the latest state of operation {operation}.
        slots:
          operation: path.operation
      - text: Poll operation {operation} until it completes.
        slots:
          operation: path.operation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/operations:batchGet'].post
  update:
    x-apievangelist-phrasing:
      intent: Get several long-running operations at once
      effect: read
      questions:
      - Can I check the status of many operations in one request?
      - What happens if some operations in a batch lookup cannot be found?
      instructions:
      - text: Fetch operations {names} in one batch.
        slots:
          names: requestBody.names
      - text: Batch-get operations {names} and allow partial success.
        slots:
          names: requestBody.names
      method: generated
      generated: '2026-09-26'