Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Developers API

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

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

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

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

$.paths['/organizations/{organizationId}/developers/{developerId}'].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 Developers API
  version: 1.0.0
extends: openapi/apigee-developers-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List developers in an organization
      effect: read
      questions:
      - Which developers are registered in my Apigee organization?
      - Can I find the developer who owns a particular app?
      instructions:
      - text: List developers in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Find the developer of app {app} in org {organizationId}.
        slots:
          app: query.app
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a developer
      effect: write
      questions:
      - How do I register a new API consumer in my organization?
      - What fields are required to create a developer?
      instructions:
      - text: Register developer {email} named {firstName} {lastName} with username {userName} in organization {organizationId}.
        slots:
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          userName: requestBody.userName
          organizationId: path.organizationId
      - text: Add developer {email} to org {organizationId} as {firstName} {lastName}, user {userName}, with status {status}.
        slots:
          email: requestBody.email
          organizationId: path.organizationId
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          userName: requestBody.userName
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a developer's profile
      effect: read
      questions:
      - Can I look up a developer by email address?
      - Which apps and custom attributes belong to a developer?
      instructions:
      - text: Get developer {developerId} in organization {organizationId}.
        slots:
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Show the profile and apps of developer {developerId} in org {organizationId}.
        slots:
          developerId: path.developerId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a developer's profile
      effect: write
      questions:
      - Do I need to send the whole developer profile to change one field?
      - How do I change a developer's name or status?
      instructions:
      - text: Update developer {developerId} in organization {organizationId} with email {email}, name {firstName} {lastName}, username {userName}.
        slots:
          developerId: path.developerId
          organizationId: path.organizationId
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          userName: requestBody.userName
      - text: Set status {status} on existing developer {developerId} in org {organizationId}, keeping email {email}, {firstName} {lastName}, user {userName}.
        slots:
          status: requestBody.status
          developerId: path.developerId
          organizationId: path.organizationId
          email: requestBody.email
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          userName: requestBody.userName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/developers/{developerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a developer
      effect: destructive
      questions:
      - What happens to a developer's apps and keys when I delete them?
      - How do I remove a developer from my organization?
      instructions:
      - text: Delete developer {developerId} from organization {organizationId}.
        slots:
          developerId: path.developerId
          organizationId: path.organizationId
      - text: Remove developer {developerId} and all their apps and keys from org {organizationId}.
        slots:
          developerId: path.developerId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'