Adyen · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adyen Configuration Rules API

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

$.info
$.paths['/transactionRules'].post
$.paths['/transactionRules/{transactionRuleId}'].get
$.paths['/transactionRules/{transactionRuleId}'].delete
$.paths['/transactionRules/{transactionRuleId}'].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 Configuration Rules API
  version: 1.0.0
extends: openapi/adyen-rules-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: 4
- target: $.paths['/transactionRules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a spending rule for issued cards
      effect: write
      questions:
      - How do I block card transactions that break a condition I set?
      - Can a transaction rule have a start and end date?
      instructions:
      - text: Create transaction rule {reference} of type {type} on {entityKey} with interval {interval} and restrictions {ruleRestrictions}, described as {description}.
        slots:
          reference: requestBody.reference
          type: requestBody.type
          entityKey: requestBody.entityKey
          interval: requestBody.interval
          ruleRestrictions: requestBody.ruleRestrictions
          description: requestBody.description
      - text: Add a new card rule that runs from {startDate} to {endDate}.
        slots:
          startDate: requestBody.startDate
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactionRules/{transactionRuleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transaction rule
      effect: read
      questions:
      - What conditions does a specific transaction rule check?
      - Is a particular card rule active right now?
      instructions:
      - text: Get transaction rule {transactionRuleId}.
        slots:
          transactionRuleId: path.transactionRuleId
      - text: Show the restrictions of rule {transactionRuleId}.
        slots:
          transactionRuleId: path.transactionRuleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactionRules/{transactionRuleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transaction rule
      effect: destructive
      questions:
      - How do I permanently remove a spending rule from issued cards?
      - Can I delete a transaction rule instead of just deactivating it?
      instructions:
      - text: Delete transaction rule {transactionRuleId}.
        slots:
          transactionRuleId: path.transactionRuleId
      - text: Remove card rule {transactionRuleId} for good.
        slots:
          transactionRuleId: path.transactionRuleId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/transactionRules/{transactionRuleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update or deactivate a transaction rule
      effect: write
      questions:
      - Can I switch an existing transaction rule to inactive by changing only its status?
      - What happens to fields I leave out when updating a rule?
      instructions:
      - text: Set the status of transaction rule {transactionRuleId} to {status}.
        slots:
          transactionRuleId: path.transactionRuleId
          status: requestBody.status
      - text: Change the end date of existing rule {transactionRuleId} to {endDate}.
        slots:
          transactionRuleId: path.transactionRuleId
          endDate: requestBody.endDate
      method: generated
      generated: '2026-09-26'