Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Operations API

4 actions 4 updates phrasing extends openapi/apigee-operations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Apigee's API. It is a proposal applied on top of the contract, not a document Apigee publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/projects/{projectId}/locations/{locationId}/operations'].get

$.paths['/projects/{projectId}/locations/{locationId}/operations/{operationId}'].get

$.paths['/projects/{projectId}/locations/{locationId}/operations/{operationId}:cancel'].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 Apigee API Management Operations API
  version: 1.0.0
extends: openapi/apigee-operations-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: 3
- target: $.paths['/projects/{projectId}/locations/{locationId}/operations'].get
  update:
    x-apievangelist-phrasing:
      intent: List long-running operations
      effect: read
      questions:
      - What long-running operations are in progress in my project?
      - Can I filter long-running operations by status?
      instructions:
      - text: List long-running operations in project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show operations matching {filter} in {projectId}/{locationId}.
        slots:
          filter: query.filter
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/operations/{operationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a long-running operation's status
      effect: read
      questions:
      - Has my long-running operation finished yet?
      - What is the current status of a specific operation?
      instructions:
      - text: Get operation {operationId} in project {projectId}, location {locationId}.
        slots:
          operationId: path.operationId
          projectId: path.projectId
          locationId: path.locationId
      - text: Check whether operation {operationId} in {projectId}/{locationId} is done.
        slots:
          operationId: path.operationId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/operations/{operationId}:cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a long-running operation
      effect: destructive
      questions:
      - Can I stop a long-running operation that is still running?
      - How do I cancel an in-progress operation?
      instructions:
      - text: Cancel operation {operationId} in project {projectId}, location {locationId}.
        slots:
          operationId: path.operationId
          projectId: path.projectId
          locationId: path.locationId
      - text: Stop the running operation {operationId} in {projectId}/{locationId}.
        slots:
          operationId: path.operationId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'