Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management API Proxies API

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

$.info
$.paths['/organizations/{organizationId}/apis'].get
$.paths['/organizations/{organizationId}/apis'].post
$.paths['/organizations/{organizationId}/apis/{apiId}'].get
$.paths['/organizations/{organizationId}/apis/{apiId}'].delete
$.paths['/organizations/{organizationId}/apis/{apiId}'].patch

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 API Proxies API
  version: 1.0.0
extends: openapi/apigee-api-proxies-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: 5
- target: $.paths['/organizations/{organizationId}/apis'].get
  update:
    x-apievangelist-phrasing:
      intent: List API proxies in an organization
      effect: read
      questions:
      - What API proxies exist in my Apigee organization?
      - Can I page through the proxy names in an org?
      instructions:
      - text: List the API proxies in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show up to {pageSize} API proxy names for org {organizationId}.
        slots:
          pageSize: query.pageSize
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apis'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API proxy
      effect: write
      questions:
      - How do I create a new API proxy from a bundle?
      - Will a newly created proxy serve traffic before it is deployed?
      instructions:
      - text: Create API proxy {name} in organization {organizationId}.
        slots:
          name: query.name
          organizationId: path.organizationId
      - text: Import an API proxy bundle as {name} in org {organizationId} with action {action}.
        slots:
          name: query.name
          organizationId: path.organizationId
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apis/{apiId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API proxy and its revisions
      effect: read
      questions:
      - Which revisions exist for one of my API proxies?
      - When was an API proxy last modified?
      instructions:
      - text: Get API proxy {apiId} in organization {organizationId}.
        slots:
          apiId: path.apiId
          organizationId: path.organizationId
      - text: Show the revisions and metadata of proxy {apiId} in org {organizationId}.
        slots:
          apiId: path.apiId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apis/{apiId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API proxy
      effect: destructive
      questions:
      - Must a proxy be undeployed everywhere before I can delete it?
      - How do I delete an API proxy with all its revisions and policies?
      instructions:
      - text: Delete API proxy {apiId} from organization {organizationId}.
        slots:
          apiId: path.apiId
          organizationId: path.organizationId
      - text: Remove proxy {apiId} and all of its revisions from org {organizationId}.
        slots:
          apiId: path.apiId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/apis/{apiId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API proxy's labels and metadata
      effect: write
      questions:
      - Can I change the labels on an API proxy without uploading a new bundle?
      - How do I edit proxy metadata only?
      instructions:
      - text: Update labels on API proxy {apiId} in organization {organizationId} using mask {updateMask}.
        slots:
          apiId: path.apiId
          organizationId: path.organizationId
          updateMask: query.updateMask
      - text: Set labels {labels} on proxy {apiId} in org {organizationId}, mask {updateMask}.
        slots:
          labels: requestBody.labels
          apiId: path.apiId
          organizationId: path.organizationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'