Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Developer App Keys API

6 actions 6 updates phrasing extends openapi/apigee-developer-app-keys-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}/developers/{developerId}/apps/{appId}/keys'].get
$.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys'].post
$.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys/{keyId}'].get
$.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys/{keyId}'].put
$.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys/{keyId}'].delete

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 Developer App Keys API
  version: 1.0.0
extends: openapi/apigee-developer-app-keys-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}/developers/{developerId}/apps/{appId}/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List a developer app's API keys
      effect: read
      questions:
      - What consumer keys and secrets does a developer app have?
      - Can I see every API key issued to one developer's app?
      instructions:
      - text: List the API keys for app {appId} of developer {developerId} in organization {organizationId}.
        slots:
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Show all consumer keys on developer {developerId}'s app {appId} in org {organizationId}.
        slots:
          developerId: path.developerId
          appId: path.appId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom consumer key to an app
      effect: write
      questions:
      - How do I migrate an existing consumer key and secret into Apigee?
      - Can I set my own consumer key value for a developer app?
      instructions:
      - text: Add custom consumer key {consumerKey} with secret {consumerSecret} to app {appId} of developer {developerId} in org {organizationId}.
        slots:
          consumerKey: requestBody.consumerKey
          consumerSecret: requestBody.consumerSecret
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Create a custom key for developer {developerId}'s app {appId} in organization {organizationId}.
        slots:
          developerId: path.developerId
          appId: path.appId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys/{keyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a developer app key
      effect: read
      questions:
      - Which API products is a particular consumer key approved for?
      - Is a given app key approved or revoked?
      instructions:
      - text: Get key {keyId} of app {appId} for developer {developerId} in organization {organizationId}.
        slots:
          keyId: path.keyId
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Show the status and API products of consumer key {keyId} on app {appId}, developer {developerId}, org {organizationId}.
        slots:
          keyId: path.keyId
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys/{keyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add API products to an app key
      effect: write
      questions:
      - How do I give an existing app key access to another API product?
      - Can I attach more API products to a consumer key?
      instructions:
      - text: Add API products {apiProducts} to key {keyId} of app {appId} for developer {developerId} in org {organizationId}.
        slots:
          apiProducts: requestBody.apiProducts
          keyId: path.keyId
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Update consumer key {keyId} on developer {developerId}'s app {appId} in organization {organizationId}.
        slots:
          keyId: path.keyId
          developerId: path.developerId
          appId: path.appId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}/keys/{keyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a developer app key
      effect: destructive
      questions:
      - Can a consumer key still call APIs after I delete it?
      - How do I remove a compromised key from a developer app?
      instructions:
      - text: Delete key {keyId} from app {appId} of developer {developerId} in organization {organizationId}.
        slots:
          keyId: path.keyId
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Revoke and remove consumer key {keyId} on developer {developerId}'s app {appId}, org {organizationId}.
        slots:
          keyId: path.keyId
          developerId: path.developerId
          appId: path.appId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'