Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Hub Dependencies API

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

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

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

$.paths['/projects/{projectId}/locations/{locationId}/dependencies/{dependencyId}'].delete

$.paths['/projects/{projectId}/locations/{locationId}/dependencies/{dependencyId}'].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 Dependencies API
  version: 1.0.0
extends: openapi/apigee-dependencies-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}/dependencies'].get
  update:
    x-apievangelist-phrasing:
      intent: List API dependencies in API Hub
      effect: read
      questions:
      - Which APIs depend on each other according to API Hub?
      - Can I filter API Hub dependencies by consumer or supplier?
      instructions:
      - text: List API Hub dependencies in project {projectId}, location {locationId}.
        slots:
          projectId: path.projectId
          locationId: path.locationId
      - text: Show dependencies matching {filter} in {projectId}/{locationId}.
        slots:
          filter: query.filter
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/dependencies'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a dependency between APIs
      effect: write
      questions:
      - How do I record that one API consumes another in API Hub?
      - Can I describe a dependency's consumer and supplier when creating it?
      instructions:
      - text: Create dependency {dependencyId} in project {projectId}, location {locationId}.
        slots:
          dependencyId: query.dependencyId
          projectId: path.projectId
          locationId: path.locationId
      - text: Record dependency {dependencyId} where {consumer} consumes {supplier} in {projectId}/{locationId}.
        slots:
          dependencyId: query.dependencyId
          consumer: requestBody.consumer
          supplier: requestBody.supplier
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/dependencies/{dependencyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an API dependency
      effect: read
      questions:
      - What consumer and supplier does a recorded dependency link?
      - What state is a specific API Hub dependency in?
      instructions:
      - text: Get dependency {dependencyId} in project {projectId}, location {locationId}.
        slots:
          dependencyId: path.dependencyId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show the consumer and supplier of dependency {dependencyId} in {projectId}/{locationId}.
        slots:
          dependencyId: path.dependencyId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/dependencies/{dependencyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API dependency
      effect: destructive
      questions:
      - How do I remove a dependency link between two APIs in API Hub?
      - Is deleting a dependency in API Hub reversible?
      instructions:
      - text: Delete dependency {dependencyId} in project {projectId}, location {locationId}.
        slots:
          dependencyId: path.dependencyId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove the dependency link {dependencyId} from API Hub in {projectId}/{locationId}.
        slots:
          dependencyId: path.dependencyId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/dependencies/{dependencyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API dependency
      effect: write
      questions:
      - Can I change the description of an existing API Hub dependency?
      - How do I update only certain fields of a dependency?
      instructions:
      - text: Update dependency {dependencyId} in project {projectId}, location {locationId} with mask {updateMask}.
        slots:
          dependencyId: path.dependencyId
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      - text: Set the description of dependency {dependencyId} to {description} in {projectId}/{locationId}, mask {updateMask}.
        slots:
          dependencyId: path.dependencyId
          description: requestBody.description
          projectId: path.projectId
          locationId: path.locationId
          updateMask: query.updateMask
      method: generated
      generated: '2026-10-01'