API Evangelist conversational phrasing for Overview Coverages API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Overview Coverages API
  version: 1.0.0
extends: openapi/aftership-coverages-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['/coverages'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping protection coverages
      effect: read
      questions:
      - How do I see all the shipping protection coverages I've issued?
      - Can I find the coverage attached to a particular order source ID?
      instructions:
      - text: List my coverages.
      - text: Find coverages for order source ID {source_id}.
        slots:
          source_id: query.source_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/coverages'].post
  update:
    x-apievangelist-phrasing:
      intent: Create shipping protection coverage for an order
      effect: write
      questions:
      - How do I add shipping protection to a new order?
      - Can I create a coverage from an order's details?
      instructions:
      - text: Create a coverage for order {order}.
        slots:
          order: requestBody.order
      - text: Insure order {order} with shipping protection.
        slots:
          order: requestBody.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/coverages/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a coverage by ID
      effect: read
      questions:
      - What's the status of a specific shipping protection coverage?
      - Can I fetch one coverage's details by its ID?
      instructions:
      - text: Show coverage {id}.
        slots:
          id: path.id
      - text: Get the details of coverage {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/coverages/update-tracking'].post
  update:
    x-apievangelist-phrasing:
      intent: Add tracking info to a coverage
      effect: write
      questions:
      - How do I attach tracking information to a coverage so it becomes active?
      - Can I update a coverage's tracking by order source ID instead of coverage ID?
      instructions:
      - text: Update the tracking on coverage {id} with order {order}.
        slots:
          id: query.id
          order: requestBody.order
      - text: Add tracking to the coverage for order source {source_id} using {order}.
        slots:
          source_id: query.source_id
          order: requestBody.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/coverages/void'].post
  update:
    x-apievangelist-phrasing:
      intent: Void an inactive coverage
      effect: destructive
      questions:
      - How do I void a coverage so it won't be charged?
      - Can I only void a coverage while it's still inactive?
      instructions:
      - text: Void coverage {id}.
        slots:
          id: query.id
      - text: Void the coverage for order source {source_id}.
        slots:
          source_id: query.source_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/coverages/calculate'].post
  update:
    x-apievangelist-phrasing:
      intent: Calculate a shipping protection premium
      effect: read
      questions:
      - How much would shipping protection cost for an order of a given value?
      - Does the shipping total change the protection premium?
      instructions:
      - text: Calculate the premium for a subtotal of {subtotal}.
        slots:
          subtotal: requestBody.subtotal
      - text: Quote protection for subtotal {subtotal} with shipping {shipping_total}.
        slots:
          subtotal: requestBody.subtotal
          shipping_total: requestBody.shipping_total
      method: generated
      generated: '2026-09-26'