Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Registry API Versions API

6 actions 6 updates phrasing extends openapi/apigee-api-versions-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['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions'].get

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

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

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

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

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 Versions API
  version: 1.0.0
extends: openapi/apigee-api-versions-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['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a registry API
      effect: read
      questions:
      - What versions of an API are recorded in the Apigee Registry?
      - Can I filter registry API versions by state?
      instructions:
      - text: List registry versions of API {apiId} in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show registry API {apiId} versions in {projectId}/{locationId} matching {filter}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a registry API version
      effect: write
      questions:
      - How do I add a new version to an API in the registry?
      - Can I set a state and labels on a new registry API version?
      instructions:
      - text: Create registry version {apiVersionId} for API {apiId} in project {projectId}, location {locationId}.
        slots:
          apiVersionId: query.apiVersionId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Add version {apiVersionId} with state {state} to registry API {apiId} in {projectId}/{locationId}.
        slots:
          apiVersionId: query.apiVersionId
          state: requestBody.state
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registry API version
      effect: read
      questions:
      - What details does the registry hold about one API version?
      - Which labels and annotations are on a registry API version?
      instructions:
      - text: Get registry API {apiId} version {versionId} in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show details of version {versionId} of registry API {apiId} in {projectId}/{locationId}.
        slots:
          versionId: path.versionId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions/{versionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registry API version
      effect: destructive
      questions:
      - Does deleting a registry API version remove its specs too?
      - Can I force delete a registry version that owns child resources?
      instructions:
      - text: Delete registry API {apiId} version {versionId} in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Force delete version {versionId} of registry API {apiId} in {projectId}/{locationId} with force {force}.
        slots:
          versionId: path.versionId
          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}/versions/{versionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a registry API version
      effect: write
      questions:
      - How do I change the state of a registry API version?
      - Can an update create the registry version if it is missing?
      instructions:
      - text: Update registry API {apiId} version {versionId} in project {projectId}, location {locationId} with mask {updateMask}.
        slots:
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      - text: Set state {state} on version {versionId} of registry API {apiId} in {projectId}/{locationId}, mask {updateMask}.
        slots:
          state: requestBody.state
          versionId: path.versionId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'