Adobe Suite · OpenAPI Overlay 1.0.0

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

7 actions 7 updates phrasing extends openapi/adobe-suite-connection-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 7

$.info
$.paths['/connectionSpecs'].get
$.paths['/connectionSpecs'].post
$.paths['/connectionSpecs/{CONNECTION_SPEC_ID}'].get
$.paths['/connectionSpecs/{CONNECTION_SPEC_ID}'].put
$.paths['/connectionSpecs/{CONNECTION_SPEC_ID}/explore'].get
$.paths['/connectionSpecs/{CONNECTION_SPEC_ID}/configs'].get

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 Connection specs API
  version: 1.0.0
extends: openapi/adobe-suite-connection-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: 6
- target: $.paths['/connectionSpecs'].get
  update:
    x-apievangelist-phrasing:
      intent: List source connection specs
      effect: read
      questions:
      - Which source connectors are available in my Experience Platform organization?
      - Can I filter connection specs by a property such as name?
      instructions:
      - text: List all connection specs in our org.
      - text: Show connection specs where {property}.
        slots:
          property: query.property
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectionSpecs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a connection spec for a source
      effect: write
      questions:
      - How do I define a new connection spec for a self-serve source connector?
      - What fields like auth spec and source spec does a new connection spec need?
      instructions:
      - text: Create a connection spec named {name} for provider {providerId}.
        slots:
          name: requestBody.name
          providerId: requestBody.providerId
      - text: Create connection spec {name} with auth spec {authSpec}.
        slots:
          name: requestBody.name
          authSpec: requestBody.authSpec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectionSpecs/{CONNECTION_SPEC_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a connection spec
      effect: read
      questions:
      - What auth and source settings does a specific connection spec define?
      - Can I look up one connection spec by its ID?
      instructions:
      - text: Show connection spec {spec}.
        slots:
          spec: path.CONNECTION_SPEC_ID
      - text: Get the details of connection spec {spec}.
        slots:
          spec: path.CONNECTION_SPEC_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectionSpecs/{CONNECTION_SPEC_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a connection spec
      effect: write
      questions:
      - How do I change an existing connection spec for my source?
      - Can I update the source spec of a connection spec after creating it?
      instructions:
      - text: Update connection spec {spec} with name {name} and provider {providerId}.
        slots:
          spec: path.CONNECTION_SPEC_ID
          name: requestBody.name
          providerId: requestBody.providerId
      - text: Change the source spec of connection spec {spec} to {sourceSpec}.
        slots:
          spec: path.CONNECTION_SPEC_ID
          sourceSpec: requestBody.sourceSpec
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectionSpecs/{CONNECTION_SPEC_ID}/explore'].get
  update:
    x-apievangelist-phrasing:
      intent: Explore objects of a connection spec
      effect: read
      questions:
      - What tables or files can I browse through a given connection spec?
      - Can I explore the objects a source connection spec exposes?
      instructions:
      - text: Explore the objects of connection spec {spec}.
        slots:
          spec: path.CONNECTION_SPEC_ID
      - text: Browse what connection spec {spec} can read.
        slots:
          spec: path.CONNECTION_SPEC_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/connectionSpecs/{CONNECTION_SPEC_ID}/configs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get config options for a connection spec
      effect: read
      questions:
      - Which configuration options are available for a connection spec?
      - What settings can I set when using a specific source connector?
      instructions:
      - text: Get the config options for connection spec {spec}.
        slots:
          spec: path.CONNECTION_SPEC_ID
      - text: List available configuration settings of connection spec {spec}.
        slots:
          spec: path.CONNECTION_SPEC_ID
      method: generated
      generated: '2026-09-26'