Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Deployments API

9 actions 9 updates phrasing extends openapi/apigee-deployments-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 9

$.info

$.paths['/projects/{projectId}/locations/{locationId}/deployments'].get

$.paths['/projects/{projectId}/locations/{locationId}/deployments'].post

$.paths['/projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'].get

$.paths['/projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'].delete

$.paths['/projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'].patch

$.paths['/organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/revisions/{revisionId}/deployments'].post

$.paths['/organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/revisions/{revisionId}/deployments'].delete

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

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 Deployments API
  version: 1.0.0
extends: openapi/apigee-deployments-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: 8
- target: $.paths['/projects/{projectId}/locations/{locationId}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List API Hub deployment records
      effect: read
      questions:
      - Which API deployments are recorded in my API Hub for a region?
      - Can I filter the API Hub deployment records I get back?
      instructions:
      - text: List API Hub deployments in project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show deployment records in project {projectId} at {locationId} that match {filter}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a new deployment in API Hub
      effect: write
      questions:
      - How do I track in API Hub where an API version is deployed?
      - Can I register a deployment record with endpoints and an environment in API Hub?
      instructions:
      - text: Create API Hub deployment {deploymentId} in project {projectId}, location {locationId}.
        slots:
          deploymentId: query.deploymentId
          projectId: path.projectId
          locationId: path.locationId
      - text: Register deployment {deploymentId} named {displayName} for environment {environment} in {projectId}/{locationId}.
        slots:
          deploymentId: query.deploymentId
          displayName: requestBody.displayName
          environment: requestBody.environment
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API Hub deployment record
      effect: read
      questions:
      - What details are stored for one deployment record in API Hub?
      - Where is a particular API Hub deployment pointing?
      instructions:
      - text: Get API Hub deployment {deploymentId} in project {projectId}, location {locationId}.
        slots:
          deploymentId: path.deploymentId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the endpoints and environment of deployment record {deploymentId} in {projectId}/{locationId}.
        slots:
          deploymentId: path.deploymentId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API Hub deployment record
      effect: destructive
      questions:
      - How do I remove a stale deployment record from API Hub?
      - Does deleting a deployment record in API Hub only remove the tracking entry?
      instructions:
      - text: Delete API Hub deployment record {deploymentId} in project {projectId}, location {locationId}.
        slots:
          deploymentId: path.deploymentId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove the tracked deployment {deploymentId} from API Hub in {projectId}/{locationId}.
        slots:
          deploymentId: path.deploymentId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/deployments/{deploymentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API Hub deployment record
      effect: write
      questions:
      - Can I change the endpoints listed on an existing API Hub deployment record?
      - How do I edit only certain fields of a deployment record in API Hub?
      instructions:
      - text: Update API Hub deployment {deploymentId} in project {projectId}, location {locationId}, changing {updateMask}.
        slots:
          deploymentId: path.deploymentId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      - text: Set the display name of deployment record {deploymentId} to {displayName} in {projectId}/{locationId} using mask {updateMask}.
        slots:
          deploymentId: path.deploymentId
          displayName: requestBody.displayName
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/revisions/{revisionId}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy an API proxy revision to an environment
      effect: write
      questions:
      - How do I deploy an API proxy revision so it starts accepting client requests?
      - Can I override a revision already deployed in the environment when deploying a new one?
      - Is a sequenced rollout available when deploying a proxy revision?
      instructions:
      - text: Deploy revision {revisionId} of API proxy {apiId} to environment {environmentId} in organization {organizationId}.
        slots:
          revisionId: path.revisionId
          apiId: path.apiId
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Deploy proxy {apiId} revision {revisionId} to {environmentId} in org {organizationId} with override set to {override}.
        slots:
          apiId: path.apiId
          revisionId: path.revisionId
          environmentId: path.environmentId
          organizationId: path.organizationId
          override: query.override
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/environments/{environmentId}/apis/{apiId}/revisions/{revisionId}/deployments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Undeploy an API proxy revision
      effect: destructive
      questions:
      - How do I stop an API proxy revision from serving traffic in an environment?
      - Can I undeploy a proxy revision using a sequenced rollout?
      instructions:
      - text: Undeploy revision {revisionId} of API proxy {apiId} from environment {environmentId} in organization {organizationId}.
        slots:
          revisionId: path.revisionId
          apiId: path.apiId
          environmentId: path.environmentId
          organizationId: path.organizationId
      - text: Take proxy {apiId} revision {revisionId} out of {environmentId} in org {organizationId}.
        slots:
          apiId: path.apiId
          revisionId: path.revisionId
          environmentId: path.environmentId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List proxy deployments across an organization
      effect: read
      questions:
      - Which API proxy revisions are deployed in which environments across my Apigee org?
      - Can I include shared flow deployments when listing everything deployed in an organization?
      instructions:
      - text: List all deployments across every environment in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show org {organizationId} deployments with sharedFlows set to {sharedFlows}.
        slots:
          organizationId: path.organizationId
          sharedFlows: query.sharedFlows
      method: generated
      generated: '2026-10-01'