DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Cloud Flow API

7 actions 7 updates phrasing extends openapi/doit-cloudflow-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 7

$.info
$.paths['/cloudflow/v1/trigger/{flowId}'].post
$.paths['/cloudflow/v1/flows/{flowId}/actions/refine'].post
$.paths['/cloudflow/v1/flows/actions/build'].post
$.paths['/cloudflow/v1/flows'].get
$.paths['/cloudflow/v1/templates'].get
$.paths['/cloudflow/v1/templates/{templateId}'].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 DoiT Cloud Flow API
  version: 1.0.0
extends: openapi/doit-cloudflow-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: 6
- target: $.paths['/cloudflow/v1/trigger/{flowId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a webhook CloudFlow
      effect: write
      questions:
      - How do I start a published CloudFlow from an external system?
      - Can I pass a JSON payload into a flow that starts with a webhook trigger?
      instructions:
      - text: Trigger CloudFlow {flowId}.
        slots:
          flowId: path.flowId
      - text: Run webhook flow {flowId} now.
        slots:
          flowId: path.flowId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/flows/{flowId}/actions/refine'].post
  update:
    x-apievangelist-phrasing:
      intent: Refine an existing CloudFlow with a prompt
      effect: write
      questions:
      - Can I change an existing CloudFlow by describing what I want in plain English?
      - How do I add steps to a flow I already have using natural language?
      instructions:
      - text: Refine CloudFlow {flowId} to {question}.
        slots:
          flowId: path.flowId
          question: requestBody.question
      - text: 'Update flow {flowId} by asking: {question}.'
        slots:
          flowId: path.flowId
          question: requestBody.question
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/flows/actions/build'].post
  update:
    x-apievangelist-phrasing:
      intent: Build a new CloudFlow from a prompt
      effect: write
      questions:
      - Can I generate a brand new automation flow just by describing it?
      - How do I create a CloudFlow from scratch with natural language?
      instructions:
      - text: Build a new CloudFlow that will {question}.
        slots:
          question: requestBody.question
      - text: 'Generate a fresh flow from this intent: {question}.'
        slots:
          question: requestBody.question
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List CloudFlows
      effect: read
      questions:
      - What automation flows do we have in CloudFlow?
      - Can I page through all our flows?
      instructions:
      - text: List all our CloudFlows.
      - text: List CloudFlows, {n} per page.
        slots:
          n: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List CloudFlow templates
      effect: read
      questions:
      - Which ready-made templates can I base a new flow on?
      - Are there prebuilt templates for CloudFlow automations?
      instructions:
      - text: List CloudFlow templates I can build flows from.
      - text: Show {n} CloudFlow templates per page.
        slots:
          n: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one CloudFlow template
      effect: read
      questions:
      - What does a particular CloudFlow template do?
      - Can I inspect a template before creating a flow from it?
      instructions:
      - text: Fetch CloudFlow template {templateId}.
        slots:
          templateId: path.templateId
      - text: Describe template {templateId} for me.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'