# 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 Capping configuration API
  version: 1.0.0
extends: openapi/adobe-suite-capping-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['/endpointConfigs'].post
  update:
    x-apievangelist-phrasing:
      intent: Cap calls journeys make to an endpoint
      effect: write
      questions:
      - How do I limit how many calls my journeys send to an external endpoint URL?
      - Can one capping configuration cover several HTTP methods on the same endpoint?
      instructions:
      - text: Create a capping configuration for endpoint {url} on methods {methods} for org {orgId} with {services}.
        slots:
          url: requestBody.url
          methods: requestBody.methods
          orgId: requestBody.orgId
          services: requestBody.services
      - text: Throttle calls to {url} with capping settings {services}.
        slots:
          url: requestBody.url
          services: requestBody.services
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpointConfigs/{uid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endpoint capping configuration
      effect: read
      questions:
      - What rate limit is currently defined for a given capping configuration?
      - Can I see whether an endpoint capping configuration is deployed?
      instructions:
      - text: Show endpoint capping configuration {uid}.
        slots:
          uid: path.uid
      - text: Get the latest definition and state of capping config {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpointConfigs/{uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Overwrite an endpoint capping configuration
      effect: write
      questions:
      - Can I change the call limit on an existing capping configuration?
      - Do I have to resend every field when updating a capping configuration?
      instructions:
      - text: Update capping configuration {uid} for endpoint {url} with {services}.
        slots:
          uid: path.uid
          url: requestBody.url
          services: requestBody.services
      - text: Replace capping config {uid} with methods {methods} for org {orgId}.
        slots:
          uid: path.uid
          methods: requestBody.methods
          orgId: requestBody.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpointConfigs/{uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endpoint capping configuration
      effect: destructive
      questions:
      - Can I delete a capping configuration that is still deployed?
      - What does the force delete option do for a capping configuration?
      instructions:
      - text: Delete capping configuration {uid}.
        slots:
          uid: path.uid
      - text: Force-delete capping config {uid} with forceDelete {force}.
        slots:
          uid: path.uid
          force: query.forceDelete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpointConfigs/{uid}/canDeploy'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a capping configuration can deploy
      effect: read
      questions:
      - Is my endpoint capping configuration valid enough to deploy?
      - Can I validate a capping configuration before deploying it?
      instructions:
      - text: Check whether capping configuration {uid} can be deployed.
        slots:
          uid: path.uid
      - text: Validate capping config {uid} for deployment.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpointConfigs/{uid}/deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy an endpoint capping configuration
      effect: write
      questions:
      - How do I make a capping configuration take effect on live journeys?
      - What state does a capping configuration move to after deployment?
      instructions:
      - text: Deploy capping configuration {uid}.
        slots:
          uid: path.uid
      - text: Activate the endpoint throttle in config {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endpointConfigs/{uid}/undeploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Undeploy an endpoint capping configuration
      effect: write
      questions:
      - Can I temporarily stop enforcing a capping configuration without deleting it?
      - Do I need to undeploy a capping configuration before removing it?
      instructions:
      - text: Undeploy capping configuration {uid}.
        slots:
          uid: path.uid
      - text: Stop enforcing endpoint capping config {uid}.
        slots:
          uid: path.uid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/list/endpointConfigs'].post
  update:
    x-apievangelist-phrasing:
      intent: List all endpoint capping configurations
      effect: read
      questions:
      - Which endpoint capping configurations exist in my organization and sandbox?
      - Can I see every throttle defined for Journey Optimizer endpoints?
      instructions:
      - text: List endpoint capping configurations in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      - text: Show all capping configs defined for our org.
      method: generated
      generated: '2026-09-26'