DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Connections API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/cloudflow/v1/connections'].get
$.paths['/cloudflow/v1/connections'].post
$.paths['/cloudflow/v1/connections/{connectionId}'].get
$.paths['/cloudflow/v1/connections/{connectionId}'].delete
$.paths['/cloudflow/v1/connections/{connectionId}'].patch

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 DoiT Connections API
  version: 1.0.0
extends: openapi/doit-connections-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: 5
- target: $.paths['/cloudflow/v1/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud connections
      effect: read
      questions:
      - Which cloud provider connections are set up for CloudFlow?
      - Can I page through all connections?
      instructions:
      - text: List all CloudFlow connections.
      - text: List connections, {n} at a time.
        slots:
          n: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cloud connection
      effect: write
      questions:
      - How do I connect a cloud account for CloudFlow to use?
      - Can a single connection have both a GCP and AWS config?
      instructions:
      - text: Create connection {name} with AWS config {awsConfig}.
        slots:
          name: requestBody.name
          awsConfig: requestBody.awsConfig
      - text: Create connection {name} with GCP config {gcpConfig}.
        slots:
          name: requestBody.name
          gcpConfig: requestBody.gcpConfig
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/connections/{connectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a connection
      effect: read
      questions:
      - How do I see one connection's configuration?
      - Is a particular connection enabled?
      instructions:
      - text: Get connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Show the config of connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/connections/{connectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a connection
      effect: destructive
      questions:
      - Why can't I delete a connection that flows still use?
      - How do I remove a cloud connection?
      instructions:
      - text: Delete connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Remove cloud connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/connections/{connectionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a connection
      effect: write
      questions:
      - How do I disable a connection without deleting it?
      - Can I rename a connection or change its collaborators?
      instructions:
      - text: Set connection {connectionId} enabled to {enabled}.
        slots:
          connectionId: path.connectionId
          enabled: requestBody.enabled
      - text: Rename connection {connectionId} to {name}.
        slots:
          connectionId: path.connectionId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'