Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations API

5 actions 5 updates phrasing extends openapi/apigee-integrations-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 5

$.info

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations'].get

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}'].delete

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}:execute'].post

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}:schedule'].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 Integrations API
  version: 1.0.0
extends: openapi/apigee-integrations-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: 4
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List integrations for a product
      effect: read
      questions:
      - What integrations exist in my Apigee project and region?
      - Can I sort or filter the list of integrations?
      instructions:
      - text: List integrations for product {productId} in project {projectId}, location {locationId}.
        slots:
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show integrations matching {filter} for product {productId} in {projectId}/{locationId}.
        slots:
          filter: query.filter
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration
      effect: destructive
      questions:
      - Can I delete an integration that still has an active version?
      - Does deleting an integration remove all of its versions?
      instructions:
      - text: Delete integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove integration {integrationId} and every version from {projectId}/{locationId}, product {productId}.
        slots:
          integrationId: path.integrationId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}:execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an integration and wait for the result
      effect: write
      questions:
      - How do I run an integration synchronously and get its output?
      - Can I pass input parameters when triggering an integration run now?
      instructions:
      - text: Execute integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Run integration {integrationId} now with trigger {triggerId} and inputs {inputParameters} in {projectId}/{locationId}, product {productId}.
        slots:
          integrationId: path.integrationId
          triggerId: requestBody.triggerId
          inputParameters: requestBody.inputParameters
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}:schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule an integration run for later
      effect: write
      questions:
      - Can I schedule an integration to run at a specific time?
      - How do I queue an asynchronous integration execution?
      instructions:
      - text: Schedule integration {integrationId} to run at {scheduleTime} for product {productId} in project {projectId}, location {locationId}.
        slots:
          integrationId: path.integrationId
          scheduleTime: requestBody.scheduleTime
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Queue a later run of integration {integrationId} with trigger {triggerId} at {scheduleTime} in {projectId}/{locationId}, product {productId}.
        slots:
          integrationId: path.integrationId
          triggerId: requestBody.triggerId
          scheduleTime: requestBody.scheduleTime
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'