Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Hub Versions API

6 actions 6 updates phrasing extends openapi/apigee-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 API Hub Versions API
  version: 1.0.0
extends: openapi/apigee-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 an API in API Hub
      effect: read
      questions:
      - What releases of an API are recorded in API Hub?
      - Can I filter the API Hub versions of an API?
      instructions:
      - text: List API Hub versions of API {apiId} in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show versions of hub API {apiId} 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 an API version in API Hub
      effect: write
      questions:
      - How do I add a new release of an API to API Hub?
      - Can I set lifecycle and compliance details on a new API Hub version?
      instructions:
      - text: Create API Hub version {versionId} for API {apiId} in project {projectId}, location {locationId}.
        slots:
          versionId: query.versionId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Add version {versionId} named {displayName} to hub API {apiId} in {projectId}/{locationId}.
        slots:
          versionId: query.versionId
          displayName: requestBody.displayName
          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 an API version from API Hub
      effect: read
      questions:
      - What lifecycle state and compliance status does an API Hub version have?
      - Which specs and operations belong to a version in API Hub?
      instructions:
      - text: Get API Hub version {versionId} of API {apiId} in project {projectId}, location {locationId}.
        slots:
          versionId: path.versionId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show lifecycle and compliance of hub API {apiId} version {versionId} in {projectId}/{locationId}.
        slots:
          apiId: path.apiId
          versionId: path.versionId
          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 an API version from API Hub
      effect: destructive
      questions:
      - Does deleting an API Hub version also remove its specs and operations?
      - How do I remove an old release from API Hub?
      instructions:
      - text: Delete API Hub version {versionId} of API {apiId} in project {projectId}, location {locationId}.
        slots:
          versionId: path.versionId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove version {versionId} and its specs from hub 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}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API version in API Hub
      effect: write
      questions:
      - Can I change the lifecycle stage of an API Hub version?
      - How do I edit only selected fields of a version in API Hub?
      instructions:
      - text: Update API Hub version {versionId} of API {apiId} in project {projectId}, location {locationId} with mask {updateMask}.
        slots:
          versionId: path.versionId
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      - text: Set lifecycle {lifecycle} on hub API {apiId} version {versionId} in {projectId}/{locationId}, mask {updateMask}.
        slots:
          lifecycle: requestBody.lifecycle
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'