Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations Executions API

3 actions 3 updates phrasing extends openapi/apigee-executions-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}/products/{productId}/integrations/{integrationId}/executions'].get

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

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 Executions API
  version: 1.0.0
extends: openapi/apigee-executions-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}/products/{productId}/integrations/{integrationId}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List runs of an integration
      effect: read
      questions:
      - Which runs of my integration failed recently?
      - Can I sort integration executions by start time?
      instructions:
      - text: List executions of integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show runs of integration {integrationId} matching {filter} in {projectId}/{locationId}, product {productId}.
        slots:
          integrationId: path.integrationId
          filter: query.filter
          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}/executions/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration run's details
      effect: read
      questions:
      - What inputs and outputs did a specific integration run have?
      - Which steps executed in one integration run?
      instructions:
      - text: Get execution {executionId} of integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          executionId: path.executionId
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Show inputs, outputs and steps of run {executionId}, integration {integrationId}, {projectId}/{locationId}, product {productId}.
        slots:
          executionId: path.executionId
          integrationId: path.integrationId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'