Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations Suspensions API

4 actions 4 updates phrasing extends openapi/apigee-suspensions-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 4

$.info

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

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}/executions/{executionId}/suspensions/{suspensionId}:lift'].post

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}/executions/{executionId}/suspensions/{suspensionId}:resolve'].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 Suspensions API
  version: 1.0.0
extends: openapi/apigee-suspensions-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: 3
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}/executions/{executionId}/suspensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List suspensions on an integration execution
      effect: read
      questions:
      - Which steps of an integration run are paused waiting for approval?
      - Can I filter the suspensions on an execution?
      instructions:
      - text: List suspensions for execution {executionId} of integration {integrationId}, 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 pending approvals on run {executionId} of integration {integrationId} in {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'
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}/executions/{executionId}/suspensions/{suspensionId}:lift'].post
  update:
    x-apievangelist-phrasing:
      intent: Lift a suspension and resume the execution
      effect: write
      questions:
      - How do I let a paused integration run continue?
      - Can I resume an execution from where a suspension stopped it?
      instructions:
      - text: Lift suspension {suspensionId} on execution {executionId} of integration {integrationId} in {projectId}/{locationId}, product {productId}.
        slots:
          suspensionId: path.suspensionId
          executionId: path.executionId
          integrationId: path.integrationId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      - text: Resume run {executionId} of {integrationId} by lifting {suspensionId} with result {suspensionResult} in {projectId}/{locationId}, product {productId}.
        slots:
          executionId: path.executionId
          integrationId: path.integrationId
          suspensionId: path.suspensionId
          suspensionResult: requestBody.suspensionResult
          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}/suspensions/{suspensionId}:resolve'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve a suspension with a final decision
      effect: write
      questions:
      - How do I record an approval decision on a suspended task?
      - Can I complete a suspended step with a final outcome?
      instructions:
      - text: Resolve suspension {suspensionId} on execution {executionId} of integration {integrationId} in {projectId}/{locationId}, product {productId}.
        slots:
          suspensionId: path.suspensionId
          executionId: path.executionId
          integrationId: path.integrationId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      - text: Give a final decision {suspension} for suspension {suspensionId}, run {executionId}, integration {integrationId}, {projectId}/{locationId}, product {productId}.
        slots:
          suspension: requestBody.suspension
          suspensionId: path.suspensionId
          executionId: path.executionId
          integrationId: path.integrationId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'