Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Observation Jobs API

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

$.info
$.paths['/projects/{projectId}/locations/{locationId}/observationJobs'].get
$.paths['/projects/{projectId}/locations/{locationId}/observationJobs'].post
$.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}'].get
$.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}'].delete
$.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}:enable'].post
$.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}:disable'].post

OpenAPI Overlay

Raw ↑ 
# 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 Jobs API
  version: 1.0.0
extends: openapi/apigee-observation-jobs-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: 6
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationJobs'].get
  update:
    x-apievangelist-phrasing:
      intent: List shadow API observation jobs
      effect: read
      questions:
      - Which observation jobs are scanning traffic for shadow APIs in my project?
      - Can I page through all the API observation jobs in a region?
      instructions:
      - text: List observation jobs in project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show up to {pageSize} shadow API observation jobs 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}/observationJobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shadow API observation job
      effect: write
      questions:
      - How do I start discovering undocumented APIs from network traffic?
      - Can I choose which observation sources a new discovery job analyzes?
      instructions:
      - text: Create observation job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          observationJobId: query.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Set up shadow API discovery job {observationJobId} using sources {sources} in {projectId}/{locationId}.
        slots:
          observationJobId: query.observationJobId
          sources: requestBody.sources
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an observation job's details
      effect: read
      questions:
      - What state is my shadow API observation job in?
      - Which sources does a specific observation job watch?
      instructions:
      - text: Get observation job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the state and sources of observation job {observationJobId} in {projectId}/{locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an observation job
      effect: destructive
      questions:
      - Do I need to disable an observation job before deleting it?
      - How do I permanently remove a shadow API discovery job?
      instructions:
      - text: Delete observation job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove disabled discovery job {observationJobId} from {projectId}/{locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}:enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable an observation job
      effect: write
      questions:
      - How do I resume shadow API discovery on a disabled job?
      - Can I turn a paused observation job back on?
      instructions:
      - text: Enable observation job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Resume traffic analysis for discovery job {observationJobId} in {projectId}/{locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/observationJobs/{observationJobId}:disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Disable an observation job
      effect: write
      questions:
      - How do I pause traffic analysis on an active observation job?
      - Can I stop shadow API discovery temporarily without deleting the job?
      instructions:
      - text: Disable observation job {observationJobId} in project {projectId}, location {locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      - text: Pause traffic analysis for discovery job {observationJobId} in {projectId}/{locationId}.
        slots:
          observationJobId: path.observationJobId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/apigee-observation-jobs-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.