Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Reviews API

4 actions 4 updates phrasing extends openapi/stripe-reviews-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/reviews'].get

$.paths['/v1/reviews/{review}'].get

$.paths['/v1/reviews/{review}/approve'].post

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 Reviews API
  version: 1.0.0
extends: openapi/stripe-reviews-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/reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments awaiting fraud review
      effect: read
      questions:
      - How do I see the payments my fraud rules have held for manual review?
      - Does the reviews list include reviews that are already closed?
      instructions:
      - text: List my open fraud reviews.
      - text: Show open reviews created in {created}.
        slots:
          created: query.created
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reviews/{review}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a fraud review
      effect: read
      questions:
      - How do I see why a particular payment was flagged for review?
      - What details are recorded on a single fraud review?
      instructions:
      - text: Get review {review}.
        slots:
          review: path.review
      - text: Show me why review {review} was opened.
        slots:
          review: path.review
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/reviews/{review}/approve'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a payment held for review
      effect: write
      questions:
      - How do I clear a payment that was held for fraud review?
      - What happens to a review after I approve it?
      instructions:
      - text: Approve review {review}.
        slots:
          review: path.review
      - text: Mark the payment under review {review} as legitimate and close the review.
        slots:
          review: path.review
      method: generated
      generated: '2026-09-26'