Apigee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Apigee API Management Shared Flows API

5 actions 5 updates phrasing extends openapi/apigee-shared-flows-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['/organizations/{organizationId}/sharedflows'].get
$.paths['/organizations/{organizationId}/sharedflows'].post
$.paths['/organizations/{organizationId}/sharedflows/{sharedFlowId}'].get
$.paths['/organizations/{organizationId}/sharedflows/{sharedFlowId}'].delete

OpenAPI Overlay

Raw ↑
# 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 Management Shared Flows API
  version: 1.0.0
extends: openapi/apigee-shared-flows-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['/organizations/{organizationId}/sharedflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List shared flows in an organization
      effect: read
      questions:
      - What reusable shared flows exist in my organization?
      - Which shared flows can my API proxies call?
      instructions:
      - text: List shared flows in organization {organizationId}.
        slots:
          organizationId: path.organizationId
      - text: Show every shared flow name for org {organizationId}.
        slots:
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/sharedflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a shared flow bundle
      effect: write
      questions:
      - How do I upload a ZIP bundle as a new shared flow?
      - Can I validate a shared flow bundle while importing it?
      instructions:
      - text: Import shared flow {name} into organization {organizationId}.
        slots:
          name: query.name
          organizationId: path.organizationId
      - text: Upload a shared flow bundle as {name} in org {organizationId} with action {action}.
        slots:
          name: query.name
          organizationId: path.organizationId
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/sharedflows/{sharedFlowId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared flow and its revisions
      effect: read
      questions:
      - Which revisions exist for a shared flow?
      - What metadata does a shared flow have?
      instructions:
      - text: Get shared flow {sharedFlowId} in organization {organizationId}.
        slots:
          sharedFlowId: path.sharedFlowId
          organizationId: path.organizationId
      - text: Show the revisions of shared flow {sharedFlowId} in org {organizationId}.
        slots:
          sharedFlowId: path.sharedFlowId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{organizationId}/sharedflows/{sharedFlowId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shared flow
      effect: destructive
      questions:
      - Must a shared flow be undeployed before it can be deleted?
      - How do I remove a shared flow with all its revisions?
      instructions:
      - text: Delete shared flow {sharedFlowId} from organization {organizationId}.
        slots:
          sharedFlowId: path.sharedFlowId
          organizationId: path.organizationId
      - text: Remove shared flow {sharedFlowId} and all its policies and revisions from org {organizationId}.
        slots:
          sharedFlowId: path.sharedFlowId
          organizationId: path.organizationId
      method: generated
      generated: '2026-10-01'