# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Thehiveryiq Com Edi API
  version: 1.0.0
extends: openapi/thehiveryiq-com-edi-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: 7
- target: $.paths['/v1/edi/mcp'].get
  update:
    x-apievangelist-phrasing:
      intent: Describe the EDI MCP server
      effect: read
      questions:
      - Is there an MCP server for wrapping receipts as EDI documents?
      - What does the EDI MCP endpoint advertise before I connect?
      instructions:
      - text: Show the EDI MCP server metadata.
      - text: Describe what the EDI MCP endpoint offers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/edi/mcp'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an MCP request to the EDI server
      effect: write
      questions:
      - How does an agent call the EDI tools over MCP?
      - Can I send JSON-RPC MCP messages to the EDI service?
      instructions:
      - text: Send this MCP request to the EDI server.
      - text: Call an EDI tool through the MCP JSON-RPC endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/edi/wrap'].post
  update:
    x-apievangelist-phrasing:
      intent: Wrap a receipt as an EDI document
      effect: write
      questions:
      - How do I turn a Hive receipt into an X12 or EDIFACT document for a trading partner?
      - Can I mark a wrapped EDI interchange as test rather than production?
      instructions:
      - text: Wrap receipt {receipt_id} as a {format} {document_type} from {sender_id} to {receiver_id}.
        slots:
          receipt_id: requestBody.receipt_id
          format: requestBody.format
          document_type: requestBody.document_type
          sender_id: requestBody.sender_id
          receiver_id: requestBody.receiver_id
      - text: Build a {format} {document_type} test interchange ({test_indicator}) from {sender_id} to {receiver_id}.
        slots:
          format: requestBody.format
          document_type: requestBody.document_type
          test_indicator: requestBody.test_indicator
          sender_id: requestBody.sender_id
          receiver_id: requestBody.receiver_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/edi/parse'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse an EDI payload
      effect: read
      questions:
      - Can I parse a raw EDI message into structured data?
      - How do I read an inbound EDI document from a partner?
      instructions:
      - text: 'Parse this {format} EDI payload: {edi_payload}.'
        slots:
          format: requestBody.format
          edi_payload: requestBody.edi_payload
      - text: Decode inbound EDI {edi_payload} as {format}.
        slots:
          edi_payload: requestBody.edi_payload
          format: requestBody.format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/edi/formats'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported EDI formats
      effect: read
      questions:
      - Which EDI formats and document types are supported?
      - Does the EDI service handle X12?
      instructions:
      - text: List the supported EDI formats.
      - text: Show which EDI document types I can wrap or parse.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/edi/pricing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get EDI service pricing
      effect: read
      questions:
      - How much does it cost to wrap or parse an EDI document?
      - Where is the EDI pricing listed?
      instructions:
      - text: Show EDI pricing.
      - text: List the price per EDI wrap and parse.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/edi/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check EDI service health
      effect: read
      questions:
      - Is the EDI service up?
      - How do I health-check the EDI endpoints?
      instructions:
      - text: Check EDI service health.
      - text: Ping the EDI health endpoint.
      method: generated
      generated: '2026-09-26'