# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Billing benefits RP Savings Plan API
  version: 1.0.0
extends: openapi/microsoft-azure-savings-plan-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: 6
- target: $.paths['/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans'].get
  update:
    x-apievangelist-phrasing:
      intent: List the savings plans in an order
      effect: read
      questions:
      - Which savings plans were bought as part of a particular order?
      - Can I see all the plans under one savings plan order?
      instructions:
      - text: List the savings plans in order {savingsPlanOrderId}.
        slots:
          savingsPlanOrderId: path.savingsPlanOrderId
      - text: Show every plan that belongs to savings plan order {savingsPlanOrderId}.
        slots:
          savingsPlanOrderId: path.savingsPlanOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.BillingBenefits/savingsPlans'].get
  update:
    x-apievangelist-phrasing:
      intent: List all my savings plans
      effect: read
      questions:
      - What Azure savings plans do I have across every order?
      - Can I filter my savings plans to only the ones in a certain state?
      - Is there a way to sort the full savings plan list?
      instructions:
      - text: List all of my savings plans.
      - text: Show my savings plans in state {state}.
        slots:
          state: query.selectedState
      - text: List the first {take} savings plans matching {filter}, sorted by {orderby}.
        slots:
          take: query.take
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one savings plan
      effect: read
      questions:
      - What are the details of one specific savings plan?
      - Can I pull up a savings plan with extra expanded detail?
      instructions:
      - text: Show savings plan {savingsPlanId} in order {savingsPlanOrderId}.
        slots:
          savingsPlanId: path.savingsPlanId
          savingsPlanOrderId: path.savingsPlanOrderId
      - text: Get plan {savingsPlanId} from order {savingsPlanOrderId}, expanding {expand}.
        slots:
          savingsPlanId: path.savingsPlanId
          savingsPlanOrderId: path.savingsPlanOrderId
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a savings plan
      effect: write
      questions:
      - Can I change the settings of a savings plan I already own?
      - How do I patch an existing savings plan inside its order?
      instructions:
      - text: Apply update {changes} to savings plan {savingsPlanId} in order {savingsPlanOrderId}.
        slots:
          changes: body.body
          savingsPlanId: path.savingsPlanId
          savingsPlanOrderId: path.savingsPlanOrderId
      - text: Change the settings of plan {savingsPlanId} (order {savingsPlanOrderId}) to {changes}.
        slots:
          savingsPlanId: path.savingsPlanId
          savingsPlanOrderId: path.savingsPlanOrderId
          changes: body.body
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a savings plan change before applying it
      effect: read
      questions:
      - Will a change I'm planning to a savings plan be accepted?
      - Can I dry-run a savings plan patch first?
      instructions:
      - text: Validate the proposed patch {changes} for plan {savingsPlanId} in order {savingsPlanOrderId}.
        slots:
          changes: body.body
          savingsPlanId: path.savingsPlanId
          savingsPlanOrderId: path.savingsPlanOrderId
      - text: Dry-run my edits to savings plan {savingsPlanId}, order {savingsPlanOrderId}, without saving them.
        slots:
          savingsPlanId: path.savingsPlanId
          savingsPlanOrderId: path.savingsPlanOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/Microsoft.BillingBenefits/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a savings plan purchase
      effect: read
      questions:
      - Before I buy a savings plan, can I confirm the purchase would go through?
      - What would block a new savings plan purchase?
      instructions:
      - text: 'Validate this savings plan purchase before I commit: {purchase}.'
        slots:
          purchase: body.body
      - text: Check whether buying savings plan {purchase} is allowed.
        slots:
          purchase: body.body
      method: generated
      generated: '2026-09-26'