Hilt · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hilt So Receipt API

11 actions 11 updates phrasing extends openapi/hilt-so-receipt-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hilt's API. It is a proposal applied on top of the contract, not a document Hilt publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/v1/receipt'].post
$.paths['/v1/receipt/{receipt_id}'].get
$.paths['/v1/receipt/{receipt_id}/public'].get
$.paths['/v1/receipt/{receipt_id}/verify'].get
$.paths['/v1/receipt/{receipt_id}/pdf'].get
$.paths['/v1/receipt/{receipt_id}/pdf/private'].get
$.paths['/v1/receipts'].get
$.paths['/v1/receipts/export.csv'].get
$.paths['/v1/receipt/{receipt_id}/invoice-metadata'].patch
$.paths['/v1/receipt/{receipt_id}/send-proof'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hilt So Receipt API
  version: 1.0.0
extends: openapi/hilt-so-receipt-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: 10
- target: $.paths['/v1/receipt'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a signed receipt for a transaction
      effect: write
      questions:
      - How do I get a signed receipt for a Solana transaction?
      - Will generating a receipt twice for the same transaction create a duplicate?
      instructions:
      - text: Generate a receipt for transaction {tx_sig}.
        slots:
          tx_sig: requestBody.tx_sig
      - text: Create a signed receipt for {tx_sig} with memo {memo}.
        slots:
          tx_sig: requestBody.tx_sig
          memo: requestBody.memo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a full signed receipt
      effect: read
      questions:
      - Can I retrieve the full signed receipt JSON?
      - Where do I get the complete receipt record as its owner?
      instructions:
      - text: Get receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Show the full signed JSON of receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}/public'].get
  update:
    x-apievangelist-phrasing:
      intent: View a receipt's public proof
      effect: read
      questions:
      - What does the public proof page of a receipt show?
      - Can someone without an account view a receipt's proof details?
      instructions:
      - text: Show the public proof for receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Get shareable proof details for receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}/verify'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a receipt's signature
      effect: read
      questions:
      - Is this receipt's signature genuine?
      - Can an auditor check a receipt without logging in?
      instructions:
      - text: Verify receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Check the Ed25519 signature on receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a public receipt PDF
      effect: read
      questions:
      - Can I download a receipt as a public PDF?
      - Is there a PDF proof I can share with a customer?
      instructions:
      - text: Download the public PDF for receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Get the shareable PDF proof of receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}/pdf/private'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a private receipt PDF
      effect: read
      questions:
      - Can I export a receipt PDF that includes my private invoice details?
      - Where's the signed-in version of a receipt PDF?
      instructions:
      - text: Export the private PDF of receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      - text: Download my authenticated PDF for receipt {receipt_id}.
        slots:
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipts'].get
  update:
    x-apievangelist-phrasing:
      intent: List my receipts
      effect: read
      questions:
      - Which receipts have I generated?
      - Can I search my receipts by wallet or product?
      instructions:
      - text: List my receipts.
      - text: Show receipts for wallet {wallet}.
        slots:
          wallet: query.wallet
      - text: Search my receipts for {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipts/export.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Export my receipt ledger to CSV
      effect: read
      questions:
      - How do I download my receipts as a CSV for accounting?
      - Can I export only one product's receipts to a spreadsheet?
      instructions:
      - text: Export my receipt ledger as CSV.
      - text: Export a CSV of receipts for product {product_id}.
        slots:
          product_id: query.product_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}/invoice-metadata'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add invoice details to a receipt
      effect: write
      questions:
      - Can I add an invoice number and customer name to a receipt?
      - Where do I store billing references on a receipt?
      instructions:
      - text: Set invoice number {invoice_number} on receipt {receipt_id}.
        slots:
          invoice_number: requestBody.invoice_number
          receipt_id: path.receipt_id
      - text: Add customer {customer_name} ({customer_email}) to receipt {receipt_id}.
        slots:
          customer_name: requestBody.customer_name
          customer_email: requestBody.customer_email
          receipt_id: path.receipt_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/receipt/{receipt_id}/send-proof'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a receipt's proof link
      effect: write
      questions:
      - Can I email a customer the proof link for their receipt?
      - Can I include a note when sending a receipt proof?
      instructions:
      - text: Email the proof for receipt {receipt_id} to {email}.
        slots:
          receipt_id: path.receipt_id
          email: requestBody.email
      - text: Send receipt {receipt_id}'s proof to {email} with note {note}.
        slots:
          receipt_id: path.receipt_id
          email: requestBody.email
          note: requestBody.note
      method: generated
      generated: '2026-09-26'