Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Registry API Deployments API

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

$.info

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

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

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

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

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

$.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/deployments/{deploymentId}:rollback'].post

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 Registry API Deployments API
  version: 1.0.0
extends: openapi/apigee-api-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: 6
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment records for a registry API
      effect: read
      questions:
      - Where is a given API deployed according to the Apigee Registry?
      - Can I sort the deployment records of a registry API?
      instructions:
      - text: List registry deployments for API {apiId} in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show registry deployment records of API {apiId} in {projectId}/{locationId} ordered by {orderBy}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          orderBy: query.orderBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a deployment for a registry API
      effect: write
      questions:
      - How do I record an endpoint URI where a registry API is deployed?
      - Can I note the intended audience and access guidance on a registry deployment?
      instructions:
      - text: Create registry deployment {apiDeploymentId} for API {apiId} in project {projectId}, location {locationId}.
        slots:
          apiDeploymentId: query.apiDeploymentId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Record deployment {apiDeploymentId} at endpoint {endpointUri} for registry API {apiId} in {projectId}/{locationId}.
        slots:
          apiDeploymentId: query.apiDeploymentId
          endpointUri: requestBody.endpointUri
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/deployments/{deploymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registry API deployment record
      effect: read
      questions:
      - Which spec revision and endpoint does a registry deployment record point to?
      - What does one deployment record of a registry API contain?
      instructions:
      - text: Get registry deployment {deploymentId} of API {apiId} in project {projectId}, location {locationId}.
        slots:
          deploymentId: path.deploymentId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the endpoint URI of registry deployment {deploymentId} for API {apiId} in {projectId}/{locationId}.
        slots:
          deploymentId: path.deploymentId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/deployments/{deploymentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registry API deployment record
      effect: destructive
      questions:
      - How do I delete a deployment record from a registry API?
      - Can I force the removal of a registry deployment that has children?
      instructions:
      - text: Delete registry deployment {deploymentId} of API {apiId} in project {projectId}, location {locationId}.
        slots:
          deploymentId: path.deploymentId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Force delete registry deployment record {deploymentId} for API {apiId} in {projectId}/{locationId}, force {force}.
        slots:
          deploymentId: path.deploymentId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/deployments/{deploymentId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a registry API deployment record
      effect: write
      questions:
      - Can I change the endpoint URI on an existing registry deployment?
      - Is it possible to create the registry deployment on update if it is missing?
      instructions:
      - text: Update registry deployment {deploymentId} of API {apiId} in project {projectId}, location {locationId} with mask {updateMask}.
        slots:
          deploymentId: path.deploymentId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      - text: Set endpoint {endpointUri} on registry deployment {deploymentId} for API {apiId} in {projectId}/{locationId}, mask {updateMask}.
        slots:
          endpointUri: requestBody.endpointUri
          deploymentId: path.deploymentId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/deployments/{deploymentId}:rollback'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll a registry deployment back to a revision
      effect: write
      questions:
      - How do I revert a registry deployment record to an earlier revision?
      - Can I undo recent changes to a deployment record in the registry?
      instructions:
      - text: Roll back registry deployment {deploymentId} of API {apiId} to revision {revisionId} in project {projectId}, location {locationId}.
        slots:
          deploymentId: path.deploymentId
          apiId: path.apiId
          revisionId: requestBody.revisionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Restore deployment record {deploymentId} for registry API {apiId} to revision {revisionId} in {projectId}/{locationId}.
        slots:
          deploymentId: path.deploymentId
          apiId: path.apiId
          revisionId: requestBody.revisionId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'