Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management API Operations API

3 actions 3 updates phrasing extends openapi/apigee-api-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 3

$.info

$.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}/apiObservations/{apiObservationId}/apiOperations'].get

$.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}/apiObservations/{apiObservationId}/apiOperations/{apiOperationId}'].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 Apigee API Management API Operations API
  version: 1.0.0
extends: openapi/apigee-api-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: 2
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}/apiObservations/{apiObservationId}/apiOperations'].get
  update:
    x-apievangelist-phrasing:
      intent: List endpoints found in a discovered API
      effect: read
      questions:
      - Which HTTP methods and paths were detected on a discovered API?
      - Can I page through operations seen in one API observation?
      instructions:
      - text: List operations in API observation {apiObservationId} of job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          apiObservationId: path.apiObservationId
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show detected endpoints for observation {apiObservationId}, job {observationJobId}, in {projectId}/{locationId}.
        slots:
          apiObservationId: path.apiObservationId
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}/apiObservations/{apiObservationId}/apiOperations/{apiOperationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a discovered API operation
      effect: read
      questions:
      - What traffic statistics exist for one discovered endpoint?
      - Which response codes did a detected operation return?
      instructions:
      - text: Get operation {apiOperationId} in observation {apiObservationId} of job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          apiOperationId: path.apiOperationId
          apiObservationId: path.apiObservationId
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the method, path and traffic of endpoint {apiOperationId}, observation {apiObservationId}, job {observationJobId}, {projectId}/{locationId}.
        slots:
          apiOperationId: path.apiOperationId
          apiObservationId: path.apiObservationId
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'