Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Developer Apps API

6 actions 6 updates phrasing extends openapi/apigee-developer-apps-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'].get

$.paths['/organizations/{organizationId}/developers/{developerId}/apps'].post

$.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}'].get

$.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}'].put

$.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}'].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 Developer Apps API
  version: 1.0.0
extends: openapi/apigee-developer-apps-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List a developer's apps
      effect: read
      questions:
      - What apps has a particular developer registered?
      - Can I get full app details instead of just app IDs for a developer?
      instructions:
      - text: List apps for developer {developerId} in organization {organizationId}.
        slots:
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Show developer {developerId}'s apps in org {organizationId} with expand set to {expand}.
        slots:
          developerId: path.developerId
          organizationId: path.organizationId
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an app for a developer
      effect: write
      questions:
      - How do I create an app for a developer so they get an API key?
      - Can I link a new developer app to specific API products?
      instructions:
      - text: Create app {name} for developer {developerId} in organization {organizationId}.
        slots:
          name: requestBody.name
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Register app {name} for developer {developerId} in org {organizationId} with API products {apiProducts}.
        slots:
          name: requestBody.name
          developerId: path.developerId
          organizationId: path.organizationId
          apiProducts: requestBody.apiProducts
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a developer app
      effect: read
      questions:
      - Which API keys and products are tied to a developer's app?
      - What callback URL is set on a developer app?
      instructions:
      - text: Get app {appId} of developer {developerId} in organization {organizationId}.
        slots:
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Show the keys and API products 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}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a developer app's attributes
      effect: write
      questions:
      - Does updating a developer app replace all of its attributes?
      - How do I change the callback URL on a developer app?
      instructions:
      - text: Update app {appId} of developer {developerId} in organization {organizationId}.
        slots:
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Set callback URL {callbackUrl} on developer {developerId}'s app {appId} in org {organizationId}.
        slots:
          callbackUrl: requestBody.callbackUrl
          developerId: path.developerId
          appId: path.appId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}/apps/{appId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a developer app
      effect: destructive
      questions:
      - What happens to the app's API keys when I delete a developer app?
      - How do I remove an app registered by a developer?
      instructions:
      - text: Delete app {appId} of developer {developerId} in organization {organizationId}.
        slots:
          appId: path.appId
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Remove developer {developerId}'s app {appId} and its keys from org {organizationId}.
        slots:
          developerId: path.developerId
          appId: path.appId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'