Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee Integrations Integration Versions API

10 actions 10 updates phrasing extends openapi/apigee-integration-versions-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 10

$.info

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

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

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

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

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

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

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

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}/versions/{versionId}:download'].get

$.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}/versions:upload'].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 Integration Versions API
  version: 1.0.0
extends: openapi/apigee-integration-versions-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: 9
- target: $.paths['/projects/{projectId}/locations/{locationId}/products/{productId}/integrations/{integrationId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the versions of an integration
      effect: read
      questions:
      - What versions exist for one of my Apigee integrations?
      - Can I see which integration versions are drafts and which one is published?
      - Which snapshot number and creation time does each version of an integration have?
      instructions:
      - text: List all versions 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 versions of integration {integrationId} sorted by {orderBy}, in project {projectId} at {locationId} under product {productId}.
        slots:
          integrationId: path.integrationId
          orderBy: query.orderBy
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      - text: List integration {integrationId} versions matching {filter} in project {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}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new integration version
      effect: write
      questions:
      - How do I save a new version of an integration with its triggers and tasks?
      - Can I create an integration version that starts as a brand-new integration?
      instructions:
      - text: Create a new version 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: Add a version of integration {integrationId} described as {description} in project {projectId}, {locationId}, product {productId}.
        slots:
          integrationId: path.integrationId
          description: requestBody.description
          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}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one integration version's configuration
      effect: read
      questions:
      - Where can I see the full trigger, task and parameter setup of a single integration version?
      - What does a specific version of my integration contain?
      instructions:
      - text: Show integration {integrationId} version {versionId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          integrationId: path.integrationId
          versionId: path.versionId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Get the configuration of version {versionId} of integration {integrationId} in {projectId}/{locationId}, product {productId}.
        slots:
          versionId: path.versionId
          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}/versions/{versionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration version
      effect: destructive
      questions:
      - Can I delete an integration version that is currently published?
      - How do I remove an old draft version of an integration?
      instructions:
      - text: Delete version {versionId} of integration {integrationId} under product {productId} in project {projectId}, location {locationId}.
        slots:
          versionId: path.versionId
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Remove draft integration version {versionId} from integration {integrationId} in {projectId}/{locationId}, product {productId}.
        slots:
          versionId: path.versionId
          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}/versions/{versionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a draft integration version
      effect: write
      questions:
      - Is it possible to edit an integration version after it has been published?
      - How do I change the tasks or triggers on a draft integration version?
      instructions:
      - text: Update draft version {versionId} of integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          versionId: path.versionId
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Change the description of draft integration version {versionId} of {integrationId} to {description} in {projectId}/{locationId}, product {productId}.
        slots:
          versionId: path.versionId
          integrationId: path.integrationId
          description: requestBody.description
          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}/versions/{versionId}:publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an integration version
      effect: write
      questions:
      - How do I make a draft integration version the active one that runs new executions?
      - What happens to new execution requests when I publish an integration version?
      instructions:
      - text: Publish version {versionId} of integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          versionId: path.versionId
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Make draft {versionId} the live version of integration {integrationId} in {projectId}/{locationId}, product {productId}.
        slots:
          versionId: path.versionId
          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}/versions/{versionId}:unpublish'].post
  update:
    x-apievangelist-phrasing:
      intent: Unpublish an integration version
      effect: write
      questions:
      - How do I stop a published integration version from receiving executions?
      - Can I take an integration version back to draft status?
      instructions:
      - text: Unpublish version {versionId} of integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          versionId: path.versionId
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Return live integration version {versionId} of {integrationId} to draft in {projectId}/{locationId}, product {productId}.
        slots:
          versionId: path.versionId
          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}/versions/{versionId}:download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an integration version bundle
      effect: read
      questions:
      - Can I export an integration version as a JSON file?
      - Which file format options exist when downloading an integration version?
      instructions:
      - text: Download integration {integrationId} version {versionId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          integrationId: path.integrationId
          versionId: path.versionId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Export version {versionId} of integration {integrationId} as {fileFormat} from {projectId}/{locationId}, product {productId}.
        slots:
          versionId: path.versionId
          integrationId: path.integrationId
          fileFormat: query.fileFormat
          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}/versions:upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an integration version bundle
      effect: write
      questions:
      - How do I import an integration configuration file as a new version?
      - Can I upload an exported integration bundle to create a version?
      instructions:
      - text: Upload {content} as a new version of integration {integrationId} for product {productId} in project {projectId}, location {locationId}.
        slots:
          content: requestBody.content
          integrationId: path.integrationId
          productId: path.productId
          projectId: path.projectId
          locationId: path.locationId
      - text: Import an integration bundle in {fileFormat} format into integration {integrationId} in {projectId}/{locationId}, product {productId}.
        slots:
          fileFormat: requestBody.fileFormat
          integrationId: path.integrationId
          projectId: path.projectId
          locationId: path.locationId
          productId: path.productId
      method: generated
      generated: '2026-10-01'