Stripe · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Stripe Ephemeral Keys API

3 actions 3 updates phrasing extends openapi/stripe-ephemeral-keys-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/ephemeral_keys'].post
$.paths['/v1/ephemeral_keys/{key}'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Stripe Ephemeral Keys API
  version: 1.0.0
extends: openapi/stripe-ephemeral-keys-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/ephemeral_keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a short-lived client key
      effect: write
      questions:
      - How do I give a mobile app temporary access to a customer's saved payment details?
      - Can I issue a short-lived key scoped to one issuing card or verification session?
      instructions:
      - text: Create an ephemeral key for customer {customer}.
        slots:
          customer: requestBody.customer
      - text: Create an ephemeral key for issuing card {issuing_card} with nonce {nonce}.
        slots:
          issuing_card: requestBody.issuing_card
          nonce: requestBody.nonce
      - text: Create a short-lived key for verification session {verification_session}.
        slots:
          verification_session: requestBody.verification_session
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/ephemeral_keys/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a short-lived client key
      effect: destructive
      questions:
      - How do I invalidate an ephemeral key before it expires?
      - Can I revoke a client's temporary key when a user logs out?
      instructions:
      - text: Revoke ephemeral key {key}.
        slots:
          key: path.key
      - text: Invalidate short-lived key {key} now.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-26'