Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Management Me API

7 actions 7 updates phrasing extends openapi/adyen-me-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 7

$.info
$.paths['/me'].get
$.paths['/me/allowedOrigins'].get
$.paths['/me/allowedOrigins'].post
$.paths['/me/allowedOrigins/{originId}'].get
$.paths['/me/allowedOrigins/{originId}'].delete
$.paths['/me/generateClientKey'].post

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 Adyen Management Me API
  version: 1.0.0
extends: openapi/adyen-me-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: 6
- target: $.paths['/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of my own API credential
      effect: read
      questions:
      - Which roles and accounts does the API key I'm using have?
      - Can I check which API credential my current key belongs to?
      instructions:
      - text: Show the details of the API credential I'm calling with.
      - text: Tell me which roles my current API key has.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/allowedOrigins'].get
  update:
    x-apievangelist-phrasing:
      intent: List my credential's allowed origins
      effect: read
      questions:
      - Which domains are allowed origins for the API key I'm using?
      - Can I see all allowed origins on my own credential?
      instructions:
      - text: List the allowed origins on my current API credential.
      - text: Show which domains my own key accepts client-side calls from.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/allowedOrigins'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an allowed origin to my credential
      effect: write
      questions:
      - Can I allow a new domain on the credential I'm authenticated with?
      - What do I need to add an allowed origin for my own key?
      instructions:
      - text: Add {domain} as an allowed origin on my API credential.
        slots:
          domain: requestBody.domain
      - text: Allow client-side requests from {domain} with my current key.
        slots:
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/allowedOrigins/{originId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my credential's allowed origins
      effect: read
      questions:
      - What domain is stored under a specific allowed origin on my credential?
      - Can I fetch one of my own allowed origins by ID?
      instructions:
      - text: Get allowed origin {origin} on my API credential.
        slots:
          origin: path.originId
      - text: Show the domain of my origin entry {origin}.
        slots:
          origin: path.originId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/allowedOrigins/{originId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an allowed origin from my credential
      effect: destructive
      questions:
      - Can I remove a domain from my own credential's allowed origins?
      - Will client-side requests from a removed origin stop working?
      instructions:
      - text: Remove allowed origin {origin} from my API credential.
        slots:
          origin: path.originId
      - text: Delete my origin {origin} so that domain is no longer accepted.
        slots:
          origin: path.originId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/me/generateClientKey'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a new client key for my credential
      effect: write
      questions:
      - Can I rotate the client key of the credential I'm using?
      - How long does my old client key work after generating a new one?
      instructions:
      - text: Generate a new client key for my API credential.
      - text: Rotate the client key on the credential I'm authenticated with.
      method: generated
      generated: '2026-09-26'