# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Remote Benefits Benefit Renewals API
  version: 1.0.0
extends: openapi/remote-com-benefit-renewals-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['/benefit_renewal_requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List benefit renewal requests
      effect: read
      questions:
      - Which benefit plans are up for renewal and waiting on my decision?
      - Can I filter benefit renewal requests by country or status?
      instructions:
      - text: List benefit renewal requests in {country_code} with status {status}.
        slots:
          country_code: query.country_code
          status: query.status
      - text: Show all open benefit renewal requests for my company.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benefit_renewal_requests/{benefit_renewal_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a benefit renewal request
      effect: read
      questions:
      - What does a specific benefit renewal request propose for next year?
      - How do I look up the details of one benefit renewal request?
      instructions:
      - text: Show benefit renewal request {benefit_renewal_request_id}.
        slots:
          benefit_renewal_request_id: path.benefit_renewal_request_id
      - text: Get the details of renewal request {benefit_renewal_request_id}.
        slots:
          benefit_renewal_request_id: path.benefit_renewal_request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benefit_renewal_requests/{benefit_renewal_request_id}/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the response form for a benefit renewal
      effect: read
      questions:
      - What fields are required when answering a benefit renewal request?
      - Is there a JSON Schema describing how to respond to a renewal request?
      instructions:
      - text: Fetch the response form schema for benefit renewal request {benefit_renewal_request_id}.
        slots:
          benefit_renewal_request_id: path.benefit_renewal_request_id
      - text: Show what I need to submit to answer renewal {benefit_renewal_request_id}.
        slots:
          benefit_renewal_request_id: path.benefit_renewal_request_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/benefit_renewal_requests/{benefit_renewal_request_id}/response'].post
  update:
    x-apievangelist-phrasing:
      intent: Respond to a benefit renewal request
      effect: write
      questions:
      - How do I accept or respond to a benefit renewal that Remote sent me?
      - Can I submit my company's decision on a pending benefits renewal?
      instructions:
      - text: Submit our response to benefit renewal request {benefit_renewal_request_id}.
        slots:
          benefit_renewal_request_id: path.benefit_renewal_request_id
      - text: Record my decision on renewal {benefit_renewal_request_id}.
        slots:
          benefit_renewal_request_id: path.benefit_renewal_request_id
      method: generated
      generated: '2026-09-26'