Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Organizations API

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

$.paths['/organizations'].post

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

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

$.paths['/organizations/{organizationId}'].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 Organizations API
  version: 1.0.0
extends: openapi/apigee-organizations-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Apigee organizations
      effect: read
      questions:
      - Which Apigee organizations can I access?
      - What orgs are available to my account?
      instructions:
      - text: List the Apigee organizations available to me.
      - text: Show every organization I can access with its metadata.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an Apigee organization
      effect: write
      questions:
      - How do I set up a new Apigee organization for a Google Cloud project?
      - Can I choose the analytics region and runtime type for a new org?
      instructions:
      - text: Create an Apigee organization under parent {parent}.
        slots:
          parent: query.parent
      - text: Create an org under {parent} with analytics region {analyticsRegion} and runtime type {runtimeType}.
        slots:
          parent: query.parent
          analyticsRegion: requestBody.analyticsRegion
          runtimeType: requestBody.runtimeType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's properties
      effect: read
      questions:
      - What subscription type and runtime does my organization use?
      - Where can I see an Apigee org's configuration settings?
      instructions:
      - text: Get organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show the subscription type and properties of org {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization's properties
      effect: write
      questions:
      - Can I change the display name or description of my Apigee org?
      - How do I update properties on an organization?
      instructions:
      - text: Update organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Set the display name of org {organizationId} to {displayName}.
        slots:
          organizationId: path.organizationId
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Apigee organization
      effect: destructive
      questions:
      - What gets removed when I delete an Apigee organization?
      - Is deleting an organization a long-running operation?
      instructions:
      - text: Delete organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Permanently remove org {organizationId} and all of its resources.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'