Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Reporting API

6 actions 6 updates phrasing extends openapi/stripe-reporting-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 6

$.info

$.paths['/v1/reporting/report_runs'].get

$.paths['/v1/reporting/report_runs'].post

$.paths['/v1/reporting/report_runs/{report_run}'].get

$.paths['/v1/reporting/report_types'].get

$.paths['/v1/reporting/report_types/{report_type}'].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 Reporting API
  version: 1.0.0
extends: openapi/stripe-reporting-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['/v1/reporting/report_runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List report runs
      effect: read
      questions:
      - How do I see the financial reports I've run?
      - Which reports did I run within a date range?
      instructions:
      - text: List my report runs.
      - text: List report runs created in {created}.
        slots:
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting/report_runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a financial report
      effect: write
      questions:
      - How do I generate a balance or payout reconciliation report?
      - Can I run a report for a specific date range?
      - Do some reports need a live-mode key to run?
      instructions:
      - text: Run report type {report_type}.
        slots:
          report_type: requestBody.report_type
      - text: Run report {report_type} with parameters {parameters}.
        slots:
          report_type: requestBody.report_type
          parameters: requestBody.parameters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting/report_runs/{report_run}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report run
      effect: read
      questions:
      - How do I check if my report has finished and get the file?
      - Did my report run succeed or fail?
      instructions:
      - text: Show report run {report_run}.
        slots:
          report_run: path.report_run
      - text: Get the result file for report run {report_run}.
        slots:
          report_run: path.report_run
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting/report_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List available report types
      effect: read
      questions:
      - What kinds of financial reports can I run?
      - Which report types are available on my account?
      instructions:
      - text: List all report types.
      - text: Show every report I can run.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reporting/report_types/{report_type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report type
      effect: read
      questions:
      - What date range of data does a report type cover?
      - Which columns does a given report type include?
      instructions:
      - text: Show report type {report_type}.
        slots:
          report_type: path.report_type
      - text: Check the available data range for report type {report_type}.
        slots:
          report_type: path.report_type
      method: generated
      generated: '2026-09-26'