Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Flow Service API - Sources Flow specs API

6 actions 6 updates phrasing extends openapi/adobe-suite-flow-specs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/flowSpecs'].get
$.paths['/flowSpecs'].post
$.paths['/flowSpecs/{FLOW_SPEC_ID}'].get
$.paths['/flowSpecs/{FLOW_SPEC_ID}'].put
$.paths['/flowSpecs/search'].post

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 Flow Service API - Sources Flow specs API
  version: 1.0.0
extends: openapi/adobe-suite-flow-specs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/flowSpecs'].get
  update:
    x-apievangelist-phrasing:
      intent: List flow specifications
      effect: read
      questions:
      - What flow specs are available for building dataflows?
      - Can I return only certain properties of each flow spec?
      instructions:
      - text: List the flow specs.
      - text: List flow specs filtered by property {property}.
        slots:
          property: query.property
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flowSpecs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a flow spec
      effect: write
      questions:
      - How do I register a new flow spec for a connector?
      - What provider ID and name does a new flow spec need?
      instructions:
      - text: Create a flow spec named {name} for provider {provider}.
        slots:
          name: requestBody.name
          provider: requestBody.providerId
      - text: Create flow spec {name} for provider {provider} linking source specs {sources} to target specs {targets}.
        slots:
          name: requestBody.name
          provider: requestBody.providerId
          sources: requestBody.sourceConnectionSpecIds
          targets: requestBody.targetConnectionSpecIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flowSpecs/{FLOW_SPEC_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow spec
      effect: read
      questions:
      - How do I read the definition of one flow spec?
      - Which source and target connection specs does a flow spec support?
      instructions:
      - text: Show flow spec {spec}.
        slots:
          spec: path.FLOW_SPEC_ID
      - text: Get the supported connection specs of flow spec {spec}.
        slots:
          spec: path.FLOW_SPEC_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flowSpecs/{FLOW_SPEC_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a flow spec
      effect: write
      questions:
      - How do I change an existing flow spec's schedule or run settings?
      - Can I update the transformations in a flow spec?
      instructions:
      - text: Update flow spec {spec} with name {name} and provider {provider}.
        slots:
          spec: path.FLOW_SPEC_ID
          name: requestBody.name
          provider: requestBody.providerId
      - text: Change the schedule spec of flow spec {spec} to {schedule}; keep name {name} and provider {provider}.
        slots:
          spec: path.FLOW_SPEC_ID
          schedule: requestBody.scheduleSpec
          name: requestBody.name
          provider: requestBody.providerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/flowSpecs/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search flow specs by criteria
      effect: read
      questions:
      - Can I query flow specs with a filter string and group the results?
      - How do I search flow specs and get only a count?
      instructions:
      - text: Search flow specs matching {query}.
        slots:
          query: requestBody.queryString
      - text: Search flow specs for {query}, limited to {limit} results.
        slots:
          query: requestBody.queryString
          limit: requestBody.limit
      method: generated
      generated: '2026-09-26'