Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management App Groups API

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

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

$.paths['/organizations/{organizationId}/appgroups/{appGroupId}'].get

$.paths['/organizations/{organizationId}/appgroups/{appGroupId}'].put

$.paths['/organizations/{organizationId}/appgroups/{appGroupId}'].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 App Groups API
  version: 1.0.0
extends: openapi/apigee-app-groups-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}/appgroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List app groups in an organization
      effect: read
      questions:
      - What app groups exist in my Apigee organization?
      - Can I page through all the app groups in an org?
      instructions:
      - text: List app groups in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show up to {pageSize} app groups for org {organizationId}.
        slots:
          pageSize: query.pageSize
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/appgroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an app group
      effect: write
      questions:
      - How do I group developers and their apps together in Apigee?
      - Can I add custom attributes when creating an app group?
      instructions:
      - text: Create app group {name} in organization {organizationId}.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
      - text: Create app group {name} with display name {displayName} in org {organizationId}.
        slots:
          name: requestBody.name
          displayName: requestBody.displayName
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/appgroups/{appGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app group
      effect: read
      questions:
      - What are the details and status of one app group?
      - Which attributes are set on a given app group?
      instructions:
      - text: Get app group {appGroupId} in organization {organizationId}.
        slots:
          appGroupId: path.appGroupId
          organizationId: path.organizationId
      - text: Show the status and attributes of app group {appGroupId} in org {organizationId}.
        slots:
          appGroupId: path.appGroupId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/appgroups/{appGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an app group
      effect: write
      questions:
      - Do I have to send the full app group object to update it?
      - How do I change the status of an existing app group?
      instructions:
      - text: Update app group {appGroupId} in organization {organizationId}.
        slots:
          appGroupId: path.appGroupId
          organizationId: path.organizationId
      - text: Set status {status} on existing app group {appGroupId} in org {organizationId}.
        slots:
          status: requestBody.status
          appGroupId: path.appGroupId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/appgroups/{appGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an app group
      effect: destructive
      questions:
      - How do I remove an app group from my organization?
      - Is deleting an app group permanent?
      instructions:
      - text: Delete app group {appGroupId} from organization {organizationId}.
        slots:
          appGroupId: path.appGroupId
          organizationId: path.organizationId
      - text: Remove the app group {appGroupId} in org {organizationId}.
        slots:
          appGroupId: path.appGroupId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'