Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Configuration Card Orders API

3 actions 3 updates phrasing extends openapi/adyen-card-orders-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/cardorders'].get

$.paths['/cardorders/{id}/items'].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 Adyen Configuration Card Orders API
  version: 1.0.0
extends: openapi/adyen-card-orders-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['/cardorders'].get
  update:
    x-apievangelist-phrasing:
      intent: List card manufacturing orders
      effect: read
      questions:
      - Which physical card orders have been sent for manufacturing?
      - Can I filter card orders by status or creation date?
      instructions:
      - text: List all card orders.
      - text: List card orders with status {status} created since {createdSince}.
        slots:
          status: query.status
          createdSince: query.createdSince
      - text: Show card orders for manufacturing profile {cardManufacturingProfileId}.
        slots:
          cardManufacturingProfileId: query.cardManufacturingProfileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cardorders/{id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the cards inside a card order
      effect: read
      questions:
      - Which individual cards are part of one card order?
      - Can I page through the items of a large card order?
      instructions:
      - text: List the items in card order {id}.
        slots:
          id: path.id
      - text: Show {limit} items of card order {id} starting at {offset}.
        slots:
          limit: query.limit
          id: path.id
          offset: query.offset
      method: generated
      generated: '2026-09-26'