Stedi · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stedi Enrollment Providers API

6 actions 6 updates phrasing extends openapi/stedi-providers-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 6

$.info

$.paths['/providers'].get

$.paths['/providers'].post

$.paths['/providers/{providerId}'].get

$.paths['/providers/{providerId}'].post

$.paths['/providers/{providerId}'].delete

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 Providers API
  version: 1.0.0
extends: openapi/stedi-providers-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: 5
- target: $.paths['/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List providers
      effect: read
      questions:
      - Which providers have I set up for enrollment?
      - Can I find provider records by NPI or tax ID?
      instructions:
      - text: List my provider records.
      - text: Find providers with NPI {providerNpis}.
        slots:
          providerNpis: query.providerNpis
      - text: Show providers with tax ID {providerTaxIds}.
        slots:
          providerTaxIds: query.providerTaxIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a provider record
      effect: write
      questions:
      - How do I add a new provider before enrolling them with payers?
      - What NPI and tax ID details does a provider record need?
      instructions:
      - text: Create provider {name} with NPI {npi} and tax ID {taxId} ({taxIdType}).
        slots:
          name: requestBody.name
          npi: requestBody.npi
          taxId: requestBody.taxId
          taxIdType: requestBody.taxIdType
      - text: Add provider {name} (NPI {npi}, {taxIdType} {taxId}) with contacts {contacts}.
        slots:
          name: requestBody.name
          npi: requestBody.npi
          taxIdType: requestBody.taxIdType
          taxId: requestBody.taxId
          contacts: requestBody.contacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/{providerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a provider
      effect: read
      questions:
      - What contact details are on a specific provider record?
      - Can I look up one provider by its ID?
      instructions:
      - text: Show provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Get the full record for provider {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/{providerId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a provider's name or contacts
      effect: write
      questions:
      - Can I change a provider's NPI or tax ID after creating it?
      - How do I update the contacts on an existing provider?
      instructions:
      - text: Rename provider {providerId} to {name}.
        slots:
          providerId: path.providerId
          name: requestBody.name
      - text: Update provider {providerId} named {name} with contacts {contacts}.
        slots:
          providerId: path.providerId
          name: requestBody.name
          contacts: requestBody.contacts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/providers/{providerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a provider
      effect: destructive
      questions:
      - How do I remove a provider record I no longer need?
      - Can I delete a provider that still has enrollments?
      instructions:
      - text: Delete provider {providerId}.
        slots:
          providerId: path.providerId
      - text: Remove the provider record {providerId}.
        slots:
          providerId: path.providerId
      method: generated
      generated: '2026-09-26'