Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Files API

4 actions 4 updates phrasing extends openapi/stripe-files-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v1/files'].get

$.paths['/v1/files'].post

$.paths['/v1/files/{file}'].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 Stripe Files API
  version: 1.0.0
extends: openapi/stripe-files-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: 3
- target: $.paths['/v1/files'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploaded files
      effect: read
      questions:
      - What files have been uploaded to my account?
      - Can I list only the files uploaded as dispute evidence?
      instructions:
      - text: List my uploaded files.
      - text: List files uploaded for purpose {purpose}.
        slots:
          purpose: query.purpose
      - text: Show files uploaded in {created}.
        slots:
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/files'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file
      effect: write
      questions:
      - How do I upload a document like dispute evidence or an ID?
      - Can I get a shareable link when I upload a file?
      instructions:
      - text: Upload {file} for purpose {purpose}.
        slots:
          file: requestBody.file
          purpose: requestBody.purpose
      - text: Upload {file} as {purpose} and create a file link with {file_link_data}.
        slots:
          file: requestBody.file
          purpose: requestBody.purpose
          file_link_data: requestBody.file_link_data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/files/{file}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an uploaded file
      effect: read
      questions:
      - How do I look up a file I uploaded earlier?
      - Where can I download the contents of an uploaded file?
      instructions:
      - text: Show file {file}.
        slots:
          file: path.file
      - text: Get the download details for file {file}.
        slots:
          file: path.file
      method: generated
      generated: '2026-09-26'