Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Observation Sources API

5 actions 5 updates phrasing extends openapi/apigee-observation-sources-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 5

$.info

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

$.paths['/projects/{projectId}/locations/{locationId}/observationSources'].post

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

$.paths['/projects/{projectId}/locations/{locationId}/observationSources/{observationSourceId}'].delete

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 Observation Sources API
  version: 1.0.0
extends: openapi/apigee-observation-sources-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: 4
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationSources'].get
  update:
    x-apievangelist-phrasing:
      intent: List traffic observation sources
      effect: read
      questions:
      - Which network infrastructure am I monitoring for API traffic?
      - Can I page through the observation sources in a project?
      instructions:
      - text: List observation sources in project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show up to {pageSize} observation sources in {projectId}/{locationId}.
        slots:
          pageSize: query.pageSize
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationSources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a traffic observation source
      effect: write
      questions:
      - How do I tell Apigee which load balancer traffic to watch for shadow APIs?
      - Can I add a Cloud Load Balancing source for API discovery?
      instructions:
      - text: Create observation source {observationSourceId} in project {projectId}, location {locationId}.
        slots:
          observationSourceId: query.observationSourceId
          projectId: path.projectId
          locationId: path.locationId
      - text: Add load balancer source {observationSourceId} with config {gclbObservationSource} in {projectId}/{locationId}.
        slots:
          observationSourceId: query.observationSourceId
          gclbObservationSource: requestBody.gclbObservationSource
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationSources/{observationSourceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an observation source
      effect: read
      questions:
      - What infrastructure does a specific observation source monitor?
      - What state is an observation source in?
      instructions:
      - text: Get observation source {observationSourceId} in project {projectId}, location {locationId}.
        slots:
          observationSourceId: path.observationSourceId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the configuration of source {observationSourceId} in {projectId}/{locationId}.
        slots:
          observationSourceId: path.observationSourceId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationSources/{observationSourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an observation source
      effect: destructive
      questions:
      - Can I delete an observation source that an active job still uses?
      - How do I stop monitoring a piece of network infrastructure?
      instructions:
      - text: Delete observation source {observationSourceId} in project {projectId}, location {locationId}.
        slots:
          observationSourceId: path.observationSourceId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove traffic source {observationSourceId} from {projectId}/{locationId}.
        slots:
          observationSourceId: path.observationSourceId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'