PAY.JP · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for PAY.JP Events API

3 actions 3 updates phrasing extends openapi/payjp-events-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/events'].get

$.paths['/events/{id}'].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 PAY.JP Events API
  version: 1.0.0
extends: openapi/payjp-events-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['/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook events
      effect: read
      questions:
      - How do I see the events that were sent to my webhooks?
      - Can I catch up on events my webhook endpoint missed?
      instructions:
      - text: List my recent events.
      - text: Show the webhook event backlog.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/events/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event
      effect: read
      questions:
      - How do I look up one event by its id?
      - What data was included in a specific webhook event?
      instructions:
      - text: Show event {id}.
        slots:
          id: path.id
      - text: Get the payload of event {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'