API Evangelist conversational phrasing for Core Transactions API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Core Transactions API
  version: 1.0.0
extends: openapi/stedi-transactions-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: 11
- target: $.paths['/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions
      effect: read
      questions:
      - Which EDI transactions did I exchange with a trading partner this month?
      - Can I find transactions by business identifier like a PO number?
      - Which inbound transactions failed processing?
      instructions:
      - text: List transactions from {from} to {to}.
        slots:
          from: query.from
          to: query.to
      - text: Find transactions with business identifier {businessIdentifier}.
        slots:
          businessIdentifier: query.businessIdentifier
      - text: Show {direction} transactions of set {transactionSetId} with status {status}.
        slots:
          direction: query.direction
          transactionSetId: query.transactionSetId
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction
      effect: read
      questions:
      - What are the details of one processed transaction?
      - Can I look up a single transaction by its ID?
      instructions:
      - text: Show transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Get the details of transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/attachment/{artifactId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction attachment document
      effect: read
      questions:
      - How do I read an attachment artifact produced for a transaction?
      - Can I fetch a transaction's attachment content inline by artifact ID?
      instructions:
      - text: Show attachment {artifactId} of transaction {transactionId}.
        slots:
          artifactId: path.artifactId
          transactionId: path.transactionId
      - text: Fetch the content of artifact {artifactId} on transaction {transactionId}.
        slots:
          artifactId: path.artifactId
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/attachment/{artifactId}/url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for a transaction attachment
      effect: read
      questions:
      - How do I download a large transaction attachment?
      - Is there a download link for a transaction artifact with no size limit?
      instructions:
      - text: Get a download URL for attachment {artifactId} of transaction {transactionId}.
        slots:
          artifactId: path.artifactId
          transactionId: path.transactionId
      - text: Give me a link to download artifact {artifactId} from transaction {transactionId}.
        slots:
          artifactId: path.artifactId
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/fragments/{fragmentIndex}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction fragment's metadata
      effect: read
      questions:
      - What metadata is recorded for one fragment of a large transaction?
      - Can I inspect a single fragment of a fragmented transaction?
      instructions:
      - text: Show metadata for fragment {fragmentIndex} of transaction {transactionId}.
        slots:
          fragmentIndex: path.fragmentIndex
          transactionId: path.transactionId
      - text: Describe fragment number {fragmentIndex} in transaction {transactionId}.
        slots:
          fragmentIndex: path.fragmentIndex
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/fragments/{fragmentIndex}/output'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fragment's translated output
      effect: read
      questions:
      - What does a single transaction fragment look like after translation?
      - Can I read one fragment's translated output inline?
      instructions:
      - text: Show the translated output of fragment {fragmentIndex} in transaction {transactionId}.
        slots:
          fragmentIndex: path.fragmentIndex
          transactionId: path.transactionId
      - text: Fetch fragment {fragmentIndex}'s output content for transaction {transactionId}.
        slots:
          fragmentIndex: path.fragmentIndex
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/fragments/{fragmentIndex}/output-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for a fragment's output
      effect: read
      questions:
      - How do I download the translated output of a large transaction fragment?
      - Is there a download link for a fragment's output with no size restriction?
      instructions:
      - text: Get a download URL for fragment {fragmentIndex} output of transaction {transactionId}.
        slots:
          fragmentIndex: path.fragmentIndex
          transactionId: path.transactionId
      - text: Give me a link to fragment {fragmentIndex}'s translated file in transaction {transactionId}.
        slots:
          fragmentIndex: path.fragmentIndex
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/input'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction's input document
      effect: read
      questions:
      - What did a transaction look like before Stedi translated it?
      - Can I read a transaction's original input inline?
      instructions:
      - text: Show the input document of transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Fetch the untranslated input for transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/input-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for a transaction's input
      effect: read
      questions:
      - How do I download the original EDI of a large transaction?
      - Is there a download link for a transaction's raw input with no size limit?
      instructions:
      - text: Get a download URL for the input of transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Give me a link to transaction {transactionId}'s original EDI.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/output'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction's output document
      effect: read
      questions:
      - What is the translated result of a transaction?
      - Can I read a transaction's output JSON inline?
      instructions:
      - text: Show the output document of transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Fetch the translated output content for transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactions/{transactionId}/output-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for a transaction's output
      effect: read
      questions:
      - How do I download the translated output of a very large transaction?
      - Can I get a link to the whole translated transaction when it is too big to return inline?
      instructions:
      - text: Get a download URL for the output of transaction {transactionId}.
        slots:
          transactionId: path.transactionId
      - text: Give me a link to transaction {transactionId}'s translated file.
        slots:
          transactionId: path.transactionId
      method: generated
      generated: '2026-09-26'