Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Environments API

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

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

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

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

$.paths['/organizations/{organizationId}/environments/{environmentId}'].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 Environments API
  version: 1.0.0
extends: openapi/apigee-environments-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}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments in an organization
      effect: read
      questions:
      - What environments exist in my Apigee organization?
      - Which runtime environments can I deploy proxies to?
      instructions:
      - text: List the environments in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show every environment name for org {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment
      effect: write
      questions:
      - How do I add a new runtime environment like test or prod?
      - Can I set the deployment type when creating an environment?
      instructions:
      - text: Create environment {name} in organization {organizationId}.
        slots:
          name: requestBody.name
          organizationId: path.organizationId
      - text: Add environment {name} with deployment type {deploymentType} to org {organizationId}.
        slots:
          name: requestBody.name
          deploymentType: requestBody.deploymentType
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's profile
      effect: read
      questions:
      - What properties and deployment type does an environment have?
      - Is a given environment in an active state?
      instructions:
      - text: Get environment {environmentId} in organization {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Show the properties and state of environment {environmentId} in org {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an environment
      effect: write
      questions:
      - Must I send the full environment object to change its properties?
      - How do I set a forward proxy URI on an environment?
      instructions:
      - text: Update environment {environmentId} in organization {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Set forward proxy {forwardProxyUri} on existing environment {environmentId} in org {organizationId}.
        slots:
          forwardProxyUri: requestBody.forwardProxyUri
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - Do I have to undeploy all proxies before deleting an environment?
      - How do I remove an unused environment?
      instructions:
      - text: Delete environment {environmentId} from organization {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Remove the environment {environmentId} in org {organizationId}.
        slots:
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'