# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon API Gateway REST API Keys Usage Plans API
  version: 1.0.0
extends: openapi/aws-api-gateway-usage-plans-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: 5
- target: $.paths['/usageplans'].get
  update:
    x-apievangelist-phrasing:
      intent: List usage plans
      effect: read
      questions:
      - What usage plans have I set up for my APIs?
      - Which usage plans is a particular API key attached to?
      instructions:
      - text: List all my usage plans.
      - text: List the usage plans that API key {keyId} belongs to.
        slots:
          keyId: query.keyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usageplans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a usage plan
      effect: write
      questions:
      - How do I set throttling and quota limits for my API consumers?
      - Can a usage plan be tied to specific API stages when I create it?
      instructions:
      - text: Create a usage plan named {name}.
        slots:
          name: requestBody.name
      - text: Create usage plan {name} with throttle {throttle} and quota {quota}.
        slots:
          name: requestBody.name
          throttle: requestBody.throttle
          quota: requestBody.quota
      - text: Create usage plan {name} covering API stages {apiStages}.
        slots:
          name: requestBody.name
          apiStages: requestBody.apiStages
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usageplans/{usageplan_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one usage plan
      effect: read
      questions:
      - How do I see the limits configured on a specific usage plan?
      - What quota and throttle does one of my usage plans enforce?
      instructions:
      - text: Show usage plan {usageplan_id}.
        slots:
          usageplan_id: path.usageplan_id
      - text: Get the quota and throttle settings of usage plan {usageplan_id}.
        slots:
          usageplan_id: path.usageplan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usageplans/{usageplan_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a usage plan
      effect: destructive
      questions:
      - How do I remove a usage plan I no longer offer?
      - Can I delete a usage plan permanently?
      instructions:
      - text: Delete usage plan {usageplan_id}.
        slots:
          usageplan_id: path.usageplan_id
      - text: Remove the retired usage plan {usageplan_id}.
        slots:
          usageplan_id: path.usageplan_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/usageplans/{usageplan_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a usage plan's limits
      effect: write
      questions:
      - Can I raise the quota on an existing usage plan?
      - How do I change throttling for a usage plan that's already live?
      instructions:
      - text: Update usage plan {usageplan_id} with patch operations {patchOperations}.
        slots:
          usageplan_id: path.usageplan_id
          patchOperations: requestBody.patchOperations
      - text: Raise the quota on existing usage plan {usageplan_id}.
        slots:
          usageplan_id: path.usageplan_id
      method: generated
      generated: '2026-10-01'