Drippay · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drip Coupons API

8 actions 8 updates phrasing extends openapi/drippay-coupons-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Drippay's API. It is a proposal applied on top of the contract, not a document Drippay publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/v1/coupons'].get
$.paths['/v1/coupons'].post
$.paths['/v1/coupons/{id}'].get
$.paths['/v1/coupons/{id}'].delete
$.paths['/v1/promotion-codes'].get
$.paths['/v1/promotion-codes'].post
$.paths['/v1/promotion-codes/redeem'].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 Drip Coupons API
  version: 1.0.0
extends: openapi/drippay-coupons-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: 7
- target: $.paths['/v1/coupons'].get
  update:
    x-apievangelist-phrasing:
      intent: List coupons
      effect: read
      questions:
      - Which discount coupons have I created?
      - Can I see all my coupons in one place?
      instructions:
      - text: List my coupons.
      - text: Show every discount coupon on the account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/coupons'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a coupon
      effect: write
      questions:
      - How do I set up a new discount coupon?
      - Can I create a coupon that promotion codes can later point to?
      instructions:
      - text: Create a new coupon.
      - text: Set up a discount coupon for my customers.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/coupons/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a coupon
      effect: read
      questions:
      - What discount does a specific coupon give, and how often has it been redeemed?
      - Can I look up a single coupon by ID?
      instructions:
      - text: Show coupon {id}.
        slots:
          id: path.id
      - text: Get the details of coupon {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/coupons/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deactivate a coupon
      effect: destructive
      questions:
      - How do I switch off a coupon so nobody can use it anymore?
      - Is deleting a coupon a hard delete or a deactivation?
      instructions:
      - text: Deactivate coupon {id}.
        slots:
          id: path.id
      - text: Turn off coupon {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/promotion-codes'].get
  update:
    x-apievangelist-phrasing:
      intent: List promotion codes
      effect: read
      questions:
      - Which customer-facing promo codes exist right now?
      - Can I list all the promotion codes I've issued?
      instructions:
      - text: List my promotion codes.
      - text: Show every promo code I've created.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/promotion-codes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a promotion code
      effect: write
      questions:
      - How do I give customers a code they can type in to get a coupon's discount?
      - Can I create a new promo code for an existing coupon?
      instructions:
      - text: Create a promotion code.
      - text: Issue a new promo code customers can redeem.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/promotion-codes/redeem'].post
  update:
    x-apievangelist-phrasing:
      intent: Redeem a promotion code against an amount
      effect: write
      questions:
      - How do I apply a promo code to a charge and get the discounted net amount?
      - What checks run when a customer redeems a promotion code?
      instructions:
      - text: Redeem a promotion code against this invoice amount.
      - text: Apply a promo code to a charge and return the discount.
      method: generated
      generated: '2026-09-26'