Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Registry API Specs API

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

$.info

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

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

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

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

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

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

$.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions/{versionId}/specs/{specId}: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 Specs API
  version: 1.0.0
extends: openapi/apigee-api-specs-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: 7
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions/{versionId}/specs'].get
  update:
    x-apievangelist-phrasing:
      intent: List specs for a registry API version
      effect: read
      questions:
      - What spec files are attached to a version of an API in Apigee Registry?
      - Can I sort or filter the specs listed for an API version in the registry?
      instructions:
      - text: List registry specs for API {apiId} version {versionId} in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show specs of registry API {apiId} version {versionId} in {projectId}/{locationId} ordered by {orderBy}.
        slots:
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
          orderBy: query.orderBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions/{versionId}/specs'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a spec to a registry API version
      effect: write
      questions:
      - How do I add an OpenAPI file to an API version in the registry?
      - Can I set the MIME type and source URI when adding a registry spec?
      instructions:
      - text: Create registry spec {apiSpecId} for API {apiId} version {versionId} in project {projectId}, location {locationId}.
        slots:
          apiSpecId: query.apiSpecId
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Add spec {apiSpecId} with filename {filename} to registry API {apiId} version {versionId} in {projectId}/{locationId}.
        slots:
          apiSpecId: query.apiSpecId
          filename: requestBody.filename
          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}/specs/{specId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registry spec's metadata
      effect: read
      questions:
      - What metadata does the registry hold for one spec, like its hash and revision?
      - When was a given registry spec revision created?
      instructions:
      - text: Get registry spec {specId} of API {apiId} version {versionId} in project {projectId}, location {locationId}.
        slots:
          specId: path.specId
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show metadata for spec {specId} under registry API {apiId} version {versionId} in {projectId}/{locationId}.
        slots:
          specId: path.specId
          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}/specs/{specId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registry spec and its revisions
      effect: destructive
      questions:
      - Does deleting a registry spec remove all of its revisions too?
      - Can I force-delete a spec that still has child resources?
      instructions:
      - text: Delete registry spec {specId} from API {apiId} version {versionId} in project {projectId}, location {locationId}.
        slots:
          specId: path.specId
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Force delete spec {specId} of registry API {apiId} version {versionId} in {projectId}/{locationId} with force {force}.
        slots:
          specId: path.specId
          apiId: path.apiId
          versionId: path.versionId
          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}/specs/{specId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a registry spec
      effect: write
      questions:
      - Will changing a registry spec's contents create a new revision?
      - Can an update create the registry spec if it does not exist yet?
      instructions:
      - text: Update registry spec {specId} of API {apiId} version {versionId} in project {projectId}, location {locationId} using mask {updateMask}.
        slots:
          specId: path.specId
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      - text: Change the description of registry spec {specId} to {description} for API {apiId} version {versionId} in {projectId}/{locationId}, mask {updateMask}.
        slots:
          specId: path.specId
          description: requestBody.description
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}/versions/{versionId}/specs/{specId}:getContents'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a registry spec's raw contents
      effect: read
      questions:
      - How do I fetch the actual spec file content stored in the registry?
      - Can I read the raw text of a spec rather than just its metadata?
      instructions:
      - text: Get the raw contents of registry spec {specId} for API {apiId} version {versionId} in project {projectId}, location {locationId}.
        slots:
          specId: path.specId
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Download spec file {specId} of registry API {apiId} version {versionId} from {projectId}/{locationId}.
        slots:
          specId: path.specId
          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}/specs/{specId}:rollback'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll a registry spec back to a revision
      effect: write
      questions:
      - How do I revert a registry spec to an earlier revision?
      - Can I restore a previous revision of a spec in the registry?
      instructions:
      - text: Roll back registry spec {specId} of API {apiId} version {versionId} to revision {revisionId} in project {projectId}, location {locationId}.
        slots:
          specId: path.specId
          apiId: path.apiId
          versionId: path.versionId
          revisionId: requestBody.revisionId
          projectId: path.projectId
          locationId: path.locationId
      - text: Restore spec {specId} to revision {revisionId} for registry API {apiId} version {versionId} in {projectId}/{locationId}.
        slots:
          specId: path.specId
          revisionId: requestBody.revisionId
          apiId: path.apiId
          versionId: path.versionId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'