Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stedi Enrollment Documents API

3 actions 3 updates phrasing extends openapi/stedi-documents-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Stedi's API. It is a proposal applied on top of the contract, not a document Stedi publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/documents/{documentId}'].delete

$.paths['/documents/{documentId}/download'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stedi Enrollment Documents API
  version: 1.0.0
extends: openapi/stedi-documents-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: 2
- target: $.paths['/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an enrollment document
      effect: destructive
      questions:
      - How do I remove a PDF I uploaded to a transaction enrollment?
      - Can I delete the wrong document attached to a payer enrollment?
      instructions:
      - text: Delete enrollment document {documentId}.
        slots:
          documentId: path.documentId
      - text: Remove the PDF {documentId} from its enrollment.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/documents/{documentId}/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a download link for an enrollment document
      effect: read
      questions:
      - How do I download a PDF that's attached to an enrollment?
      - Can I get a temporary link to an enrollment document?
      instructions:
      - text: Get a download link for enrollment document {documentId}.
        slots:
          documentId: path.documentId
      - text: Download the enrollment PDF {documentId}.
        slots:
          documentId: path.documentId
      method: generated
      generated: '2026-09-26'