# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Auth0 Management Flows API
  version: 1.0.0
extends: openapi/auth0-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: 13
- target: $.paths['/flows'].get
  update:
    x-apievangelist-phrasing:
      intent: List automation flows
      effect: read
      questions:
      - Which Forms flows have I built in my Auth0 tenant?
      - Can I list flows with their action details expanded?
      instructions:
      - text: List all my flows.
      - text: List flows with {hydrate} hydrated.
        slots:
          hydrate: query.hydrate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a flow
      effect: write
      questions:
      - How do I create a new flow with a sequence of actions?
      - Can I create an empty flow now and add actions later?
      instructions:
      - text: Create a flow named {name}.
        slots:
          name: requestBody.name
      - text: Create flow {name} with the actions {actions}.
        slots:
          name: requestBody.name
          actions: requestBody.actions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/vault/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List Flows Vault connections
      effect: read
      questions:
      - Which third-party credentials are stored in my Flows Vault?
      - What vault connections can my flows use?
      instructions:
      - text: List my Flows Vault connections.
      - text: Show page {page} of the vault connections used by flows.
        slots:
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/vault/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a Flows Vault connection
      effect: write
      questions:
      - How do I store a service credential in the Flows Vault for my flows to use?
      - Can I add a new vault connection for flow actions?
      instructions:
      - text: Create a new Flows Vault connection.
      - text: Add a vault connection so my flows can call an external service.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/vault/connections/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Flows Vault connection
      effect: read
      questions:
      - What are the details of a single Flows Vault connection?
      - Is a specific vault connection fully set up?
      instructions:
      - text: Get Flows Vault connection {id}.
        slots:
          id: path.id
      - text: Show the setup of vault connection {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/vault/connections/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Flows Vault connection
      effect: destructive
      questions:
      - Can I remove a stored credential from the Flows Vault?
      - What's the way to delete a vault connection my flows no longer need?
      instructions:
      - text: Delete Flows Vault connection {id}.
        slots:
          id: path.id
      - text: Remove vault connection {id} from my flows.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/vault/connections/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Flows Vault connection
      effect: write
      questions:
      - How do I rename or re-configure an existing vault connection?
      - Can I update the setup credentials of a Flows Vault connection?
      instructions:
      - text: Rename vault connection {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the setup of vault connection {id} to {setup}.
        slots:
          id: path.id
          setup: requestBody.setup
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flow_id}/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a flow's executions
      effect: read
      questions:
      - What runs has a specific flow had recently?
      - Can I page through a flow's execution history?
      instructions:
      - text: List the executions of flow {flow_id}.
        slots:
          flow_id: path.flow_id
      - text: Show the latest {take} runs of flow {flow_id}.
        slots:
          take: query.take
          flow_id: path.flow_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flow_id}/executions/{execution_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single flow execution
      effect: read
      questions:
      - What happened during one particular flow run?
      - Can I see the debug details of a single flow execution?
      instructions:
      - text: Get execution {execution_id} of flow {flow_id}.
        slots:
          execution_id: path.execution_id
          flow_id: path.flow_id
      - text: Show run {execution_id} of flow {flow_id} with {hydrate} hydrated.
        slots:
          execution_id: path.execution_id
          flow_id: path.flow_id
          hydrate: query.hydrate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{flow_id}/executions/{execution_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a flow execution record
      effect: destructive
      questions:
      - Can I delete the record of one flow run?
      - Is there a way to purge a specific execution from a flow's history?
      instructions:
      - text: Delete execution {execution_id} of flow {flow_id}.
        slots:
          execution_id: path.execution_id
          flow_id: path.flow_id
      - text: Remove the run record {execution_id} from flow {flow_id}.
        slots:
          execution_id: path.execution_id
          flow_id: path.flow_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a flow's definition
      effect: read
      questions:
      - What actions does a specific flow contain?
      - Can I fetch one flow's definition by its ID?
      instructions:
      - text: Get flow {id}.
        slots:
          id: path.id
      - text: Show the actions in flow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a flow
      effect: destructive
      questions:
      - Can I delete a flow I no longer use?
      - What's the way to permanently remove a flow?
      instructions:
      - text: Delete flow {id}.
        slots:
          id: path.id
      - text: Permanently remove the flow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/flows/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a flow
      effect: write
      questions:
      - How do I change the actions in an existing flow?
      - Can I rename a flow after creating it?
      instructions:
      - text: Rename flow {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Replace the actions of flow {id} with {actions}.
        slots:
          id: path.id
          actions: requestBody.actions
      method: generated
      generated: '2026-10-01'