Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Projects API

6 actions 6 updates phrasing extends openapi/apigee-projects-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'].get

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

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

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

$.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}'].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 Projects API
  version: 1.0.0
extends: openapi/apigee-projects-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List APIs in API Hub
      effect: read
      questions:
      - What APIs are cataloged in API Hub for my project?
      - Can I filter the API Hub catalog by a field?
      instructions:
      - text: List APIs in API Hub for project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show API Hub APIs in {projectId}/{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}/apis'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an API in API Hub
      effect: write
      questions:
      - How do I add a new API to the API Hub catalog?
      - Can I set an owner, team and maturity level when registering an API?
      instructions:
      - text: Create API {apiId} in API Hub for project {projectId}, location {locationId}.
        slots:
          apiId: query.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Register API {apiId} named {displayName} owned by {owner} in {projectId}/{locationId}.
        slots:
          apiId: query.apiId
          displayName: requestBody.displayName
          owner: requestBody.owner
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API from API Hub
      effect: read
      questions:
      - Who owns a particular API in API Hub?
      - What description and metadata does an API Hub entry have?
      instructions:
      - text: Get API {apiId} from API Hub in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the owner and description of API Hub API {apiId} in {projectId}/{locationId}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API from API Hub
      effect: destructive
      questions:
      - Does deleting an API from API Hub also delete its versions and specs?
      - How do I remove an API from the hub catalog?
      instructions:
      - text: Delete API {apiId} from API Hub in project {projectId}, location {locationId}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove API Hub API {apiId} with all versions and specs from {projectId}/{locationId}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/apis/{apiId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API in API Hub
      effect: write
      questions:
      - Can I change only the owner of an API in API Hub?
      - How do I edit an API Hub entry's description?
      instructions:
      - text: Update API {apiId} in API Hub for project {projectId}, location {locationId} with mask {updateMask}.
        slots:
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      - text: Set owner {owner} on API Hub API {apiId} in {projectId}/{locationId}, mask {updateMask}.
        slots:
          owner: requestBody.owner
          apiId: path.apiId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'