# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Twilio Verify Rate Limits API
  version: 1.0.0
extends: openapi/twilio-rate-limits-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: 4
- target: $.paths['/Services/{ServiceSid}/RateLimits'].get
  update:
    x-apievangelist-phrasing:
      intent: List rate limits on a Verify service
      effect: read
      questions:
      - Which rate limits have I defined on my Verify service?
      - What throttling rules protect my verification flow from abuse?
      instructions:
      - text: List the rate limits on Verify service {service}.
        slots:
          service: path.ServiceSid
      - text: Show every throttling rule defined for service {service}.
        slots:
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/RateLimits'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a rate limit on a Verify service
      effect: write
      questions:
      - How do I cap how often verification codes can be requested on my service?
      - Can I define a named rate limit on my Verify service?
      instructions:
      - text: Create a rate limit called {unique_name} on Verify service {service}.
        slots:
          unique_name: requestBody.UniqueName
          service: path.ServiceSid
      - text: Add rate limit {unique_name} to service {service} described as {description}.
        slots:
          unique_name: requestBody.UniqueName
          service: path.ServiceSid
          description: requestBody.Description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets'].get
  update:
    x-apievangelist-phrasing:
      intent: List the buckets of a rate limit
      effect: read
      questions:
      - What maximums and time intervals are set on one of my rate limits?
      - Which buckets belong to a given Verify rate limit?
      instructions:
      - text: List the buckets of rate limit {rate_limit} on service {service}.
        slots:
          rate_limit: path.RateLimitSid
          service: path.ServiceSid
      - text: Show the max and interval settings for rate limit {rate_limit} in service {service}.
        slots:
          rate_limit: path.RateLimitSid
          service: path.ServiceSid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a bucket to a rate limit
      effect: write
      questions:
      - How do I allow at most a set number of verification requests per time window?
      - Can one rate limit have several buckets with different intervals?
      instructions:
      - text: Add a bucket to rate limit {rate_limit} on service {service} allowing {max} requests every {interval} seconds.
        slots:
          rate_limit: path.RateLimitSid
          service: path.ServiceSid
          max: requestBody.Max
          interval: requestBody.Interval
      - text: Limit rate limit {rate_limit} of service {service} to {max} per {interval}-second window.
        slots:
          rate_limit: path.RateLimitSid
          service: path.ServiceSid
          max: requestBody.Max
          interval: requestBody.Interval
      method: generated
      generated: '2026-09-26'