# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Journeys throttling configurations Throttling configuration…
  version: 1.0.0
extends: openapi/adobe-suite-throttling-configuration-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: 8
- target: $.paths['/list/throttlingConfigs'].post
  update:
    x-apievangelist-phrasing:
      intent: List throttling configurations
      effect: read
      questions:
      - Which throttling configurations exist in my sandbox?
      - Can I see all the endpoint rate caps we have set up?
      instructions:
      - text: List the throttling configurations in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show every throttling config for org {org}.
        slots:
          org: header.x-gw-ims-org-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/throttlingConfigs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a throttling configuration
      effect: write
      questions:
      - How do I cap how fast journeys call an external endpoint?
      - Can I create a new throttling configuration for a sandbox?
      instructions:
      - text: Create a throttling configuration in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Set up a new endpoint rate limit config for org {org}.
        slots:
          org: header.x-gw-ims-org-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/throttlingConfigs/{uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a throttling configuration
      effect: read
      questions:
      - How do I view the settings of one throttling configuration?
      - What does a single throttling config look like when I fetch it by ID?
      instructions:
      - text: Show throttling configuration {uid}.
        slots:
          uid: path.uid
      - text: Get the details of throttling config {uid} in sandbox {sandbox}.
        slots:
          uid: path.uid
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/throttlingConfigs/{uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a throttling configuration
      effect: write
      questions:
      - How do I change the rate cap on an existing throttling configuration?
      - Can I edit a throttling config after creating it?
      instructions:
      - text: Update throttling configuration {uid} with my new settings.
        slots:
          uid: path.uid
      - text: Edit throttling config {uid} in sandbox {sandbox}.
        slots:
          uid: path.uid
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/throttlingConfigs/{uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a throttling configuration
      effect: destructive
      questions:
      - How do I remove a throttling configuration I no longer need?
      - Can I force delete a throttling config that is still deployed?
      instructions:
      - text: Delete throttling configuration {uid}.
        slots:
          uid: path.uid
      - text: Force delete throttling config {uid} with forceDelete set to {force}.
        slots:
          uid: path.uid
          force: query.forceDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/throttlingConfigs/{uid}/canDeploy'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a throttling configuration can be deployed
      effect: read
      questions:
      - Is my throttling configuration valid and ready to deploy?
      - Can I check a throttling config for deploy blockers before activating it?
      instructions:
      - text: Check whether throttling configuration {uid} can be deployed.
        slots:
          uid: path.uid
      - text: Verify config {uid} is deployable in sandbox {sandbox}.
        slots:
          uid: path.uid
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/throttlingConfigs/{uid}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a throttling configuration
      effect: write
      questions:
      - How do I activate a throttling configuration so it starts limiting calls?
      - What makes a throttling config take effect?
      instructions:
      - text: Deploy throttling configuration {uid}.
        slots:
          uid: path.uid
      - text: Activate throttling config {uid} in sandbox {sandbox}.
        slots:
          uid: path.uid
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/throttlingConfigs/{uid}/undeploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Undeploy a throttling configuration
      effect: destructive
      questions:
      - How do I stop a deployed throttling configuration from limiting calls?
      - Can I deactivate a throttling config without deleting it?
      instructions:
      - text: Undeploy throttling configuration {uid}.
        slots:
          uid: path.uid
      - text: Deactivate throttling config {uid} in sandbox {sandbox}.
        slots:
          uid: path.uid
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'