Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management API Observations API

4 actions 4 updates phrasing extends openapi/apigee-api-observations-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}/observationJobs/{observationJobId}/apiObservations'].get

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

$.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}/apiObservations:batchEditTags'].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 API Observations API
  version: 1.0.0
extends: openapi/apigee-api-observations-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}/observationJobs/{observationJobId}/apiObservations'].get
  update:
    x-apievangelist-phrasing:
      intent: List shadow APIs found by an observation job
      effect: read
      questions:
      - What shadow APIs has my observation job discovered?
      - Can I page through the API observations from one job?
      instructions:
      - text: List API observations from job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show up to {pageSize} discovered APIs for observation job {observationJobId} in {projectId}/{locationId}.
        slots:
          pageSize: query.pageSize
          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}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a discovered API observation
      effect: read
      questions:
      - What hostname and server IPs does a discovered shadow API have?
      - When was a discovered API last seen and how many requests did it get?
      instructions:
      - text: Get API observation {apiObservationId} from job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          apiObservationId: path.apiObservationId
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show hostname, IPs and request count of observation {apiObservationId} in job {observationJobId}, {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:batchEditTags'].post
  update:
    x-apievangelist-phrasing:
      intent: Tag several discovered APIs at once
      effect: write
      questions:
      - Can I tag many discovered APIs in one call?
      - How do I categorize shadow APIs with tags?
      instructions:
      - text: Edit tags on observations from job {observationJobId} in project {projectId}, location {locationId} using {requests}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
          requests: requestBody.requests
      - text: Apply tag changes to discovered APIs in observation job {observationJobId} in {projectId}/{locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'