Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Instances API

8 actions 8 updates phrasing extends openapi/apigee-instances-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 8

$.info
$.paths['/organizations/{organizationId}/instances'].get
$.paths['/organizations/{organizationId}/instances'].post
$.paths['/organizations/{organizationId}/instances/{instanceId}'].get
$.paths['/organizations/{organizationId}/instances/{instanceId}'].delete
$.paths['/projects/{projectId}/locations/{locationId}/instances'].post
$.paths['/projects/{projectId}/locations/{locationId}/instances/{instanceId}'].get
$.paths['/projects/{projectId}/locations/{locationId}/instances/{instanceId}'].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 Instances API
  version: 1.0.0
extends: openapi/apigee-instances-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: 7
- target: $.paths['/organizations/{organizationId}/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List Apigee runtime instances
      effect: read
      questions:
      - Which runtime instances does my Apigee organization have?
      - Can I page through the runtime instances in an org?
      instructions:
      - text: List the runtime instances in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show up to {pageSize} runtime instances for org {organizationId}.
        slots:
          pageSize: query.pageSize
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision an Apigee runtime instance
      effect: write
      questions:
      - How do I provision runtime infrastructure for my Apigee organization?
      - Can I choose the IP range and disk encryption key for a new runtime instance?
      instructions:
      - text: Create a runtime instance named {name} in location {location} for organization {organizationId}.
        slots:
          name: requestBody.name
          location: requestBody.location
          organizationId: path.organizationId
      - text: Provision an Apigee runtime instance for org {organizationId} using peering CIDR range {peeringCidrRange}.
        slots:
          organizationId: path.organizationId
          peeringCidrRange: requestBody.peeringCidrRange
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/instances/{instanceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Apigee runtime instance
      effect: read
      questions:
      - What host and port is my Apigee runtime instance listening on?
      - Is my runtime instance in an active state yet?
      instructions:
      - text: Get runtime instance {instanceId} in organization {organizationId}.
        slots:
          instanceId: path.instanceId
          organizationId: path.organizationId
      - text: Show the state, host and port of runtime instance {instanceId} for org {organizationId}.
        slots:
          instanceId: path.instanceId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/instances/{instanceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deprovision an Apigee runtime instance
      effect: destructive
      questions:
      - How do I tear down an Apigee runtime instance and its infrastructure?
      - Is deleting a runtime instance a long-running operation?
      instructions:
      - text: Delete runtime instance {instanceId} from organization {organizationId}.
        slots:
          instanceId: path.instanceId
          organizationId: path.organizationId
      - text: Deprovision the runtime infrastructure for instance {instanceId} in org {organizationId}.
        slots:
          instanceId: path.instanceId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Provision an Apigee Registry instance
      effect: write
      questions:
      - How do I set up a Registry instance in a Google Cloud project?
      - Can I provision Apigee Registry in a specific region?
      instructions:
      - text: Create Registry instance {instanceId} in project {projectId}, location {locationId}.
        slots:
          instanceId: query.instanceId
          projectId: path.projectId
          locationId: path.locationId
      - text: Provision an Apigee Registry instance called {instanceId} for project {projectId} at {locationId}.
        slots:
          instanceId: query.instanceId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/instances/{instanceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Apigee Registry instance
      effect: read
      questions:
      - What state is my Apigee Registry instance in?
      - Where can I see the config of a Registry instance in a project?
      instructions:
      - text: Get Registry instance {instanceId} in project {projectId}, location {locationId}.
        slots:
          instanceId: path.instanceId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the status message of Registry instance {instanceId} for project {projectId} at {locationId}.
        slots:
          instanceId: path.instanceId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/instances/{instanceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Apigee Registry instance
      effect: destructive
      questions:
      - How do I remove the Registry instance from a project?
      - Can I delete an Apigee Registry instance in one region only?
      instructions:
      - text: Delete Registry instance {instanceId} in project {projectId}, location {locationId}.
        slots:
          instanceId: path.instanceId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove the Apigee Registry instance {instanceId} from project {projectId} at {locationId}.
        slots:
          instanceId: path.instanceId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'