# 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 Actions API
  version: 1.0.0
extends: openapi/auth0-actions-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: 24
- target: $.paths['/actions/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Actions in the tenant
      effect: read
      questions:
      - Which Actions do I have that run on the post-login trigger?
      - Can I filter my Actions to only the ones that are deployed?
      - What Actions have been installed from the marketplace in my tenant?
      instructions:
      - text: List all my Actions.
      - text: List Actions that support trigger {triggerId}.
        slots:
          triggerId: query.triggerId
      - text: Find Actions named {actionName}.
        slots:
          actionName: query.actionName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new Action
      effect: write
      questions:
      - How do I write a custom Action that runs during login?
      - Can I create an Action with npm dependencies and secrets in one step?
      - Is it possible to create and deploy an Action at the same time?
      instructions:
      - text: Create an Action called {name} for triggers {supported_triggers}.
        slots:
          name: requestBody.name
          supported_triggers: requestBody.supported_triggers
      - text: 'Create Action {name} on {supported_triggers} with this code: {code}.'
        slots:
          name: requestBody.name
          supported_triggers: requestBody.supported_triggers
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{actionId}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an Action's deployed versions
      effect: read
      questions:
      - What is the deployment history of one of my Actions?
      - How many versions of an Action have been deployed so far?
      instructions:
      - text: List every deployed version of Action {actionId}.
        slots:
          actionId: path.actionId
      - text: Show the version history for Action {actionId}.
        slots:
          actionId: path.actionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{actionId}/versions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one specific version of an Action
      effect: read
      questions:
      - What code was running in a particular earlier version of my Action?
      - Can I inspect a single immutable Action version by its ID?
      instructions:
      - text: Show me version {id} of Action {actionId}.
        slots:
          id: path.id
          actionId: path.actionId
      - text: Fetch the code of Action {actionId} at version {id}.
        slots:
          actionId: path.actionId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{actionId}/versions/{id}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll an Action back to an earlier version
      effect: write
      questions:
      - How do I roll back an Action after a bad deploy?
      - Can rolling back an Action also reset its draft to the old code?
      instructions:
      - text: Roll Action {actionId} back to version {id}.
        slots:
          actionId: path.actionId
          id: path.id
      - text: Redeploy version {id} of Action {actionId} and set update_draft to {update_draft}.
        slots:
          id: path.id
          actionId: path.actionId
          update_draft: requestBody.update_draft
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Action's details
      effect: read
      questions:
      - What triggers, runtime and code does a given Action have?
      - Can I view an Action's current draft by its ID?
      instructions:
      - text: Show me Action {id}.
        slots:
          id: path.id
      - text: Get the runtime and supported triggers of Action {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an Action and all its versions
      effect: destructive
      questions:
      - Why can't I delete an Action that's still bound to a trigger?
      - Can I force-delete an Action even if it is bound?
      instructions:
      - text: Delete Action {id}.
        slots:
          id: path.id
      - text: Force-delete Action {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an Action's draft code or settings
      effect: write
      questions:
      - Will editing an Action's code affect live logins before I deploy it?
      - How do I add a secret to an existing Action?
      instructions:
      - text: Update the code of Action {id} to {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Rename Action {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the secrets on Action {id} to {secrets}.
        slots:
          id: path.id
          secrets: requestBody.secrets
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{id}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy an Action's current draft
      effect: write
      questions:
      - How do I publish my Action changes so they start running in the flow?
      - Does deploying an Action create a new version?
      instructions:
      - text: Deploy Action {id}.
        slots:
          id: path.id
      - text: Ship the latest draft of Action {id} as a new version.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/actions/{id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test-run an Action with a sample payload
      effect: write
      questions:
      - Can I try out my Action code before deploying it?
      - What event payload do I pass to dry-run an Action?
      instructions:
      - text: Test Action {id} with payload {payload}.
        slots:
          id: path.id
          payload: requestBody.payload
      - text: Run a dry test of Action {id} using sample event {payload}.
        slots:
          id: path.id
          payload: requestBody.payload
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/executions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of an Action execution
      effect: read
      questions:
      - Where can I see what my Actions did during a specific login?
      - How long are Action execution records kept?
      instructions:
      - text: Show me execution {id}.
        slots:
          id: path.id
      - text: Get the Action results for the execution ID {id} from my tenant logs.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules'].get
  update:
    x-apievangelist-phrasing:
      intent: List Actions Modules
      effect: read
      questions:
      - What shared code modules exist for my Actions?
      - Can I page through all Actions Modules in the tenant?
      instructions:
      - text: List all Actions Modules.
      - text: Show page {page} of Actions Modules with {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reusable Actions Module
      effect: write
      questions:
      - How do I share helper code across several Actions?
      - Can I create a module and publish its first version immediately?
      instructions:
      - text: Create an Actions Module named {name} with code {code}.
        slots:
          name: requestBody.name
          code: requestBody.code
      - text: Create module {name} from {code} with dependencies {dependencies}.
        slots:
          name: requestBody.name
          code: requestBody.code
          dependencies: requestBody.dependencies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an Actions Module's details
      effect: read
      questions:
      - What code and dependencies does a given Actions Module contain?
      - Can I look up a shared module by its ID?
      instructions:
      - text: Show me Actions Module {id}.
        slots:
          id: path.id
      - text: Get the current draft code of module {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete an Actions Module
      effect: destructive
      questions:
      - Why does deleting an Actions Module fail?
      - Can I remove a shared module that no Action uses anymore?
      instructions:
      - text: Delete Actions Module {id}.
        slots:
          id: path.id
      - text: Permanently remove the unused module {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an Actions Module's draft
      effect: write
      questions:
      - How do I change the code in a shared Actions Module?
      - Can I update a module's secrets without touching its code?
      instructions:
      - text: Update the code of Actions Module {id} to {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Set the dependencies of module {id} to {dependencies}.
        slots:
          id: path.id
          dependencies: requestBody.dependencies
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Actions that use a module
      effect: read
      questions:
      - Which Actions depend on a particular shared module?
      - Before deleting a module, how can I see what still references it?
      instructions:
      - text: List the Actions that use module {id}.
        slots:
          id: path.id
      - text: Show which deployed Action versions reference module {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}/rollback'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore an Actions Module draft from a version
      effect: write
      questions:
      - How do I revert a shared module's draft to an earlier published version?
      - Does rolling back a module also restore its secrets and dependencies?
      instructions:
      - text: Roll module {id} back to version {module_version_id}.
        slots:
          id: path.id
          module_version_id: requestBody.module_version_id
      - text: Copy version {module_version_id} into the draft of Actions Module {id}.
        slots:
          module_version_id: requestBody.module_version_id
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an Actions Module's published versions
      effect: read
      questions:
      - What published versions exist for a shared Actions Module?
      - Can I page through a module's version history?
      instructions:
      - text: List the published versions of module {id}.
        slots:
          id: path.id
      - text: Show the version history of Actions Module {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish an Actions Module draft as a version
      effect: write
      questions:
      - How do I publish my module draft so Actions can reference it?
      - Does publishing a module version keep the draft editable?
      instructions:
      - text: Publish the draft of Actions Module {id} as a new version.
        slots:
          id: path.id
      - text: Cut a new immutable version of module {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/modules/{id}/versions/{versionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one published version of an Actions Module
      effect: read
      questions:
      - What code was in a specific published version of a module?
      - Can I fetch an immutable module version by its version ID?
      instructions:
      - text: Show version {versionId} of Actions Module {id}.
        slots:
          versionId: path.versionId
          id: path.id
      - text: Fetch the code of module {id} at version {versionId}.
        slots:
          id: path.id
          versionId: path.versionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: List available Action triggers
      effect: read
      questions:
      - Which extensibility points can I attach Actions to?
      - What triggers are available for Actions in my tenant?
      instructions:
      - text: List all available Action triggers.
      - text: Show me the triggers I can bind Actions to.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/triggers/{triggerId}/bindings'].get
  update:
    x-apievangelist-phrasing:
      intent: List Actions bound to a trigger, in order
      effect: read
      questions:
      - Which Actions run on the post-login trigger and in what order?
      - How can I see the execution order of Actions in a flow?
      instructions:
      - text: List the Actions bound to trigger {triggerId}.
        slots:
          triggerId: path.triggerId
      - text: Show the execution order of bindings on {triggerId}.
        slots:
          triggerId: path.triggerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/actions/triggers/{triggerId}/bindings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Attach or reorder Actions on a trigger
      effect: write
      questions:
      - How do I add a deployed Action to the login flow?
      - Can I change the order my Actions execute in on a trigger?
      instructions:
      - text: Set the bindings on trigger {triggerId} to {bindings}.
        slots:
          triggerId: path.triggerId
          bindings: requestBody.bindings
      - text: 'Bind my Actions to {triggerId} in this order: {bindings}.'
        slots:
          triggerId: path.triggerId
          bindings: requestBody.bindings
      method: generated
      generated: '2026-10-01'