Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Sigma API

3 actions 3 updates phrasing extends openapi/stripe-sigma-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 3

$.info

$.paths['/v1/sigma/scheduled_query_runs'].get

$.paths['/v1/sigma/scheduled_query_runs/{scheduled_query_run}'].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 Sigma API
  version: 1.0.0
extends: openapi/stripe-sigma-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['/v1/sigma/scheduled_query_runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled report query runs
      effect: read
      questions:
      - How do I see the results of my scheduled SQL reports?
      - Which scheduled queries have run recently?
      instructions:
      - text: List my scheduled query runs.
      - text: Show the last {limit} scheduled query runs.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/sigma/scheduled_query_runs/{scheduled_query_run}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a scheduled query run
      effect: read
      questions:
      - How do I get the result file from one scheduled query run?
      - Did a particular scheduled report run succeed or fail?
      instructions:
      - text: Get scheduled query run {scheduled_query_run}.
        slots:
          scheduled_query_run: path.scheduled_query_run
      - text: Show me the status and results of query run {scheduled_query_run}.
        slots:
          scheduled_query_run: path.scheduled_query_run
      method: generated
      generated: '2026-09-26'