Spade · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Spade Category Action Triggers API

17 actions 17 updates phrasing extends openapi/spade-category-action-triggers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Spade's API. It is a proposal applied on top of the contract, not a document Spade publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info
$.paths['/category-action-triggers'].get
$.paths['/category-action-triggers'].put
$.paths['/category-action-triggers'].delete
$.paths['/category-action-triggers'].patch
$.paths['/programs/{programId}/category-action-triggers'].get
$.paths['/programs/{programId}/category-action-triggers'].put
$.paths['/programs/{programId}/category-action-triggers'].delete
$.paths['/programs/{programId}/category-action-triggers'].patch
$.paths['/users/{userId}/category-action-triggers'].get
$.paths['/users/{userId}/category-action-triggers'].put
$.paths['/users/{userId}/category-action-triggers'].delete
$.paths['/users/{userId}/category-action-triggers'].patch
$.paths['/users/{userId}/cards/{cardId}/category-action-triggers'].get
$.paths['/users/{userId}/cards/{cardId}/category-action-triggers'].put
$.paths['/users/{userId}/cards/{cardId}/category-action-triggers'].delete

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 Spade Category Action Triggers API
  version: 1.0.0
extends: openapi/spade-category-action-triggers-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 16
- target: $.paths['/category-action-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: Check account-wide category trigger status
      effect: read
      questions:
      - Have my account-wide category action triggers finished registering yet?
      - Which version of the category triggers applies to every user in my account?
      instructions:
      - text: Show the status and version of my account-level category triggers.
      - text: Confirm the account-wide category trigger registration has succeeded.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/category-action-triggers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace account-wide category triggers
      effect: write
      questions:
      - How do I flag every transaction in a spending category across my whole account with Spade?
      - Can I set an action that fires on a category for all my users at once?
      - What fields does each account-level category trigger need?
      instructions:
      - text: Register these category triggers {categoryTriggers} for my entire account.
        slots:
          categoryTriggers: requestBody.categoryTriggers
      - text: Overwrite the account-wide category trigger list with {categoryTriggers}.
        slots:
          categoryTriggers: requestBody.categoryTriggers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/category-action-triggers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all account-wide category triggers
      effect: destructive
      questions:
      - How do I wipe every category trigger set at the account level?
      - Does clearing account category triggers keep a version history?
      instructions:
      - text: Remove all category action triggers at my account scope.
      - text: Empty out the account-level category trigger list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/category-action-triggers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove individual account category triggers
      effect: write
      questions:
      - Can I add one category trigger to my account without resending the whole list?
      - Is there a way to delete just a few account-level category triggers by ID?
      instructions:
      - text: Add category triggers {categoryTriggers} to my account, keeping the existing ones ({operation}).
        slots:
          categoryTriggers: requestBody.categoryTriggers
          operation: requestBody.operation
      - text: Run a {operation} on account category triggers with IDs {triggerIds}.
        slots:
          operation: requestBody.operation
          triggerIds: requestBody.triggerIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{programId}/category-action-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a program's category trigger status
      effect: read
      questions:
      - Are the category triggers for one of my card programs active yet?
      - What version of category triggers is registered for a specific program?
      instructions:
      - text: Show the category trigger status for program {programId}.
        slots:
          programId: path.programId
      - text: Check whether program {programId} category trigger registration succeeded.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{programId}/category-action-triggers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a program's category triggers
      effect: write
      questions:
      - How do I attach category actions only to transactions tagged with one program?
      - Can different card programs have their own category trigger sets?
      instructions:
      - text: Register category triggers {categoryTriggers} for program {programId}.
        slots:
          categoryTriggers: requestBody.categoryTriggers
          programId: path.programId
      - text: Overwrite program {programId}'s category trigger list with {categoryTriggers}.
        slots:
          programId: path.programId
          categoryTriggers: requestBody.categoryTriggers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{programId}/category-action-triggers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a program's category triggers
      effect: destructive
      questions:
      - How do I remove every category trigger from a single program?
      - Can I reset one program's category actions without touching account-wide ones?
      instructions:
      - text: Clear all category triggers for program {programId}.
        slots:
          programId: path.programId
      - text: Empty the category trigger list on program {programId}.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/programs/{programId}/category-action-triggers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove a program's category triggers
      effect: write
      questions:
      - Can I add a single category trigger to a program incrementally?
      - How do I drop specific category trigger IDs from one program?
      instructions:
      - text: Add category triggers {categoryTriggers} to program {programId} using operation {operation}.
        slots:
          categoryTriggers: requestBody.categoryTriggers
          programId: path.programId
          operation: requestBody.operation
      - text: Apply {operation} to program {programId} category triggers {triggerIds}.
        slots:
          operation: requestBody.operation
          programId: path.programId
          triggerIds: requestBody.triggerIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/category-action-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a user's category trigger status
      effect: read
      questions:
      - Are the category triggers for one particular user registered successfully?
      - What category trigger version applies to all cards of a given user?
      instructions:
      - text: Show the category trigger status for user {userId}.
        slots:
          userId: path.userId
      - text: Check if user {userId}'s category triggers are active.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/category-action-triggers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a user's category triggers
      effect: write
      questions:
      - How do I set category actions that apply to every card a single user holds?
      - Can each end user have their own category trigger list?
      instructions:
      - text: Register category triggers {categoryTriggers} for user {userId}.
        slots:
          categoryTriggers: requestBody.categoryTriggers
          userId: path.userId
      - text: Overwrite user {userId}'s category trigger list with {categoryTriggers}.
        slots:
          userId: path.userId
          categoryTriggers: requestBody.categoryTriggers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/category-action-triggers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a user's category triggers
      effect: destructive
      questions:
      - How do I wipe out all category triggers for one user?
      - Can I reset a single user's category actions to nothing?
      instructions:
      - text: Clear all category triggers for user {userId}.
        slots:
          userId: path.userId
      - text: Empty the category trigger list for user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/category-action-triggers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove a user's category triggers
      effect: write
      questions:
      - Can I add one category trigger for a user without replacing their others?
      - How do I remove particular category trigger IDs for a single user?
      instructions:
      - text: Add category triggers {categoryTriggers} for user {userId} with operation {operation}.
        slots:
          categoryTriggers: requestBody.categoryTriggers
          userId: path.userId
          operation: requestBody.operation
      - text: Apply {operation} to user {userId}'s category triggers {triggerIds}.
        slots:
          operation: requestBody.operation
          userId: path.userId
          triggerIds: requestBody.triggerIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/category-action-triggers'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a card's category trigger status
      effect: read
      questions:
      - Are the category triggers on one specific card registered and active?
      - Which category trigger version applies to a single card only?
      instructions:
      - text: Show the category trigger status for card {cardId} of user {userId}.
        slots:
          cardId: path.cardId
          userId: path.userId
      - text: Check whether card {cardId} belonging to {userId} has succeeded category triggers.
        slots:
          cardId: path.cardId
          userId: path.userId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/category-action-triggers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a card's category triggers
      effect: write
      questions:
      - How do I set category actions that fire only on one card, not the user's other cards?
      - Can a single card carry its own category trigger list?
      instructions:
      - text: Register category triggers {categoryTriggers} on card {cardId} for user {userId}.
        slots:
          categoryTriggers: requestBody.categoryTriggers
          cardId: path.cardId
          userId: path.userId
      - text: Overwrite the category triggers on user {userId}'s card {cardId} with {categoryTriggers}.
        slots:
          userId: path.userId
          cardId: path.cardId
          categoryTriggers: requestBody.categoryTriggers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/category-action-triggers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a card's category triggers
      effect: destructive
      questions:
      - How do I remove every category trigger from one card?
      - Can I clear a card's category actions while keeping the user-level ones?
      instructions:
      - text: Clear all category triggers on card {cardId} for user {userId}.
        slots:
          cardId: path.cardId
          userId: path.userId
      - text: Empty the category trigger list for user {userId}'s card {cardId}.
        slots:
          userId: path.userId
          cardId: path.cardId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{userId}/cards/{cardId}/category-action-triggers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove a card's category triggers
      effect: write
      questions:
      - Can I add a category trigger to just one card incrementally?
      - How do I drop specific category trigger IDs from a single card?
      instructions:
      - text: Add category triggers {categoryTriggers} to card {cardId} of user {userId} via {operation}.
        slots:
          categoryTriggers: requestBody.categoryTriggers
          cardId: path.cardId
          userId: path.userId
          operation: requestBody.operation
      - text: Apply {operation} to card {cardId} (user {userId}) category triggers {triggerIds}.
        slots:
          operation: requestBody.operation
          cardId: path.cardId
          userId: path.userId
          triggerIds: requestBody.triggerIds
      method: generated
      generated: '2026-10-01'