Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Hub External APIs API

3 actions 3 updates phrasing extends openapi/apigee-external-apis-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 3

$.info

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

$.paths['/projects/{projectId}/locations/{locationId}/externalApis'].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 API Hub External APIs API
  version: 1.0.0
extends: openapi/apigee-external-apis-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: 2
- target: $.paths['/projects/{projectId}/locations/{locationId}/externalApis'].get
  update:
    x-apievangelist-phrasing:
      intent: List external API references in API Hub
      effect: read
      questions:
      - Which third-party APIs are referenced in my API Hub?
      - Can I page through the external API entries?
      instructions:
      - text: List external APIs in API Hub for project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show up to {pageSize} external API references in {projectId}/{locationId}.
        slots:
          pageSize: query.pageSize
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/externalApis'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an external API reference to API Hub
      effect: write
      questions:
      - How do I record an API we consume but do not own in API Hub?
      - Can I list endpoints and paths on an external API reference?
      instructions:
      - text: Create external API {externalApiId} in API Hub for project {projectId}, location {locationId}.
        slots:
          externalApiId: query.externalApiId
          projectId: path.projectId
          locationId: path.locationId
      - text: Add external API {externalApiId} named {displayName} with endpoints {endpoints} in {projectId}/{locationId}.
        slots:
          externalApiId: query.externalApiId
          displayName: requestBody.displayName
          endpoints: requestBody.endpoints
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'