Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Management Stores API

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

$.info
$.paths['/stores'].get
$.paths['/stores'].post
$.paths['/stores/{storeId}'].get
$.paths['/stores/{storeId}'].patch
$.paths['/stores/{storeId}/terminalLogos'].get
$.paths['/stores/{storeId}/terminalLogos'].patch
$.paths['/stores/{storeId}/terminalSettings'].get
$.paths['/stores/{storeId}/terminalSettings'].patch

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 Stores API
  version: 1.0.0
extends: openapi/adyen-stores-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: 8
- target: $.paths['/stores'].get
  update:
    x-apievangelist-phrasing:
      intent: List stores
      effect: read
      questions:
      - Which stores are set up across my merchant accounts?
      - Can I filter stores by merchant account or store reference?
      instructions:
      - text: List all my stores.
      - text: List the stores for merchant account {merchant}.
        slots:
          merchant: query.merchantId
      - text: Find the store with reference {ref}.
        slots:
          ref: query.reference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a store
      effect: write
      questions:
      - How do I add a new physical store to a merchant account?
      - What does the shopper statement on a new store control?
      instructions:
      - text: Create a store {description} for merchant {merchant} at {address}, phone {phone}, statement {statement}.
        slots:
          description: requestBody.description
          merchant: requestBody.merchantId
          address: requestBody.address
          phone: requestBody.phoneNumber
          statement: requestBody.shopperStatement
      - text: Add store {description} with reference {ref} to merchant {merchant}, at {address}, {phone}, shown as {statement}.
        slots:
          description: requestBody.description
          ref: requestBody.reference
          merchant: requestBody.merchantId
          address: requestBody.address
          phone: requestBody.phoneNumber
          statement: requestBody.shopperStatement
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{storeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a store
      effect: read
      questions:
      - What address and status does a particular store have?
      - Can I look up a store by its ID?
      instructions:
      - text: Get store {store}.
        slots:
          store: path.storeId
      - text: Show the details of store {store}.
        slots:
          store: path.storeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{storeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a store
      effect: write
      questions:
      - Can I change a store's address or phone number?
      - Can I close a store by changing its status?
      instructions:
      - text: Update the phone number of store {store} to {phone}.
        slots:
          store: path.storeId
          phone: requestBody.phoneNumber
      - text: Set the status of store {store} to {status}.
        slots:
          store: path.storeId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{storeId}/terminalLogos'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a store's terminal logo
      effect: read
      questions:
      - What logo do terminals of a given model show in one store?
      - Can I retrieve a store-level terminal logo as an image?
      instructions:
      - text: Get the logo for {model} terminals in store {store}.
        slots:
          store: path.storeId
          model: query.model
      - text: Show store {store}'s configured logo on model {model}.
        slots:
          store: path.storeId
          model: query.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{storeId}/terminalLogos'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a store's terminal logo
      effect: write
      questions:
      - Can I give one store's terminals a different logo?
      - Does a store logo update apply to all terminals of that model in the store?
      instructions:
      - text: Set the logo for {model} terminals in store {store} to {data}.
        slots:
          store: path.storeId
          model: query.model
          data: requestBody.data
      - text: Replace store {store}'s logo on model {model} terminals.
        slots:
          store: path.storeId
          model: query.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{storeId}/terminalSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a store's terminal settings
      effect: read
      questions:
      - What terminal settings apply to the terminals in one store?
      - Which receipt and tipping settings are configured for a store?
      instructions:
      - text: Get the terminal settings for store {store}.
        slots:
          store: path.storeId
      - text: Show the terminal configuration that applies across store {store}.
        slots:
          store: path.storeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stores/{storeId}/terminalSettings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a store's terminal settings
      effect: write
      questions:
      - Can I turn on tipping just for the terminals in one store?
      - Do store terminal settings override individual terminal settings?
      instructions:
      - text: Update the gratuity settings for terminals in store {store} to {gratuities}.
        slots:
          store: path.storeId
          gratuities: requestBody.gratuities
      - text: Change store {store}'s terminal receipt printing to {printing}.
        slots:
          store: path.storeId
          printing: requestBody.receiptPrinting
      method: generated
      generated: '2026-09-26'