API Evangelist conversational phrasing for Core Executions 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 Executions API
  version: 1.0.0
extends: openapi/stedi-executions-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['/executions'].get
  update:
    x-apievangelist-phrasing:
      intent: List file executions
      effect: read
      questions:
      - Which EDI files did Stedi process recently?
      - Can I see only the file executions that failed for one trading partner?
      - What inbound files were processed between two dates?
      instructions:
      - text: List file executions with status {status}.
        slots:
          status: query.status
      - text: Show executions for partnership {partnershipId} from {from} to {to}.
        slots:
          partnershipId: query.partnershipId
          from: query.from
          to: query.to
      - text: Find executions for the file named {displayName}.
        slots:
          displayName: query.displayName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry failed file executions
      effect: write
      questions:
      - How do I reprocess all the EDI files that failed?
      - Can I retry file executions in bulk that match a condition?
      instructions:
      - text: Retry every file execution matching {condition}.
        slots:
          condition: requestBody.condition
      - text: Queue the failed executions matching {condition} to run again.
        slots:
          condition: requestBody.condition
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file execution
      effect: read
      questions:
      - What is the status of one specific file execution?
      - Can I see the details of a single processed EDI file?
      instructions:
      - text: Show file execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Get the status and details of execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/faults'].get
  update:
    x-apievangelist-phrasing:
      intent: List a file execution's faults
      effect: read
      questions:
      - Why did my EDI file fail to process?
      - What errors were recorded for a file execution?
      instructions:
      - text: List the faults for execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Show why execution {executionId} failed.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/input'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file execution's input document
      effect: read
      questions:
      - Can I see the original EDI file a file execution received before translation?
      - What did the raw inbound file look like for an execution?
      instructions:
      - text: Show the input document of execution {executionId} inline.
        slots:
          executionId: path.executionId
      - text: Fetch the untranslated input file content for execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/input-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for an execution's input
      effect: read
      questions:
      - How do I download a very large original input file from a file execution?
      - Is there a download link for an execution's raw input with no size limit?
      instructions:
      - text: Get a download URL for the input of execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Give me a link to download execution {executionId}'s original EDI file.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file execution's metadata document
      effect: read
      questions:
      - Where can I see the metadata Stedi recorded about a processed file?
      - Can I read a file execution's metadata inline?
      instructions:
      - text: Show the metadata document of execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Fetch the metadata content for file execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/metadata-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for execution metadata
      effect: read
      questions:
      - How do I download the metadata for a large X12 file execution?
      - Is there a link to fetch an execution's metadata document without a size limit?
      instructions:
      - text: Get a download URL for the metadata of execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Give me a link to the metadata file of X12 execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/output'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file execution's output document
      effect: read
      questions:
      - What did an outbound file execution produce?
      - Can I read the output document of an outbound execution inline?
      instructions:
      - text: Show the output document of execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Fetch the generated outbound file content for execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/output-url'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download URL for an execution's output
      effect: read
      questions:
      - How do I download a large output file from a file execution?
      - Is there a download link for an execution's output with no size restriction?
      instructions:
      - text: Get a download URL for the output of execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Give me a link to download execution {executionId}'s output file.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/executions/{executionId}/transactions'].get
  update:
    x-apievangelist-phrasing:
      intent: List transactions in a file execution
      effect: read
      questions:
      - Which transactions were inside a single EDI file?
      - Can I see the full details of every transaction a file execution contained?
      instructions:
      - text: List the transactions in execution {executionId}.
        slots:
          executionId: path.executionId
      - text: Show all transaction details from file execution {executionId}.
        slots:
          executionId: path.executionId
      method: generated
      generated: '2026-09-26'