Drippay · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drip Drift API

8 actions 8 updates phrasing extends openapi/drippay-drift-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/drift/stripe'].get
$.paths['/v1/drift/customer'].get
$.paths['/v1/drift/config'].get
$.paths['/v1/drift/summary'].get
$.paths['/v1/drift/findings/{id}'].get
$.paths['/v1/drift/findings/{id}'].patch
$.paths['/v1/drift/{kind}/run'].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 Drift API
  version: 1.0.0
extends: openapi/drippay-drift-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/drift/stripe'].get
  update:
    x-apievangelist-phrasing:
      intent: List Stripe drift findings
      effect: read
      questions:
      - Where has my billing data drifted out of sync with Stripe?
      - What Stripe mismatches has drift detection found?
      instructions:
      - text: List my Stripe drift findings.
      - text: Show where Stripe and my billing records disagree.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/drift/customer'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer churn-risk findings
      effect: read
      questions:
      - Which customers are showing signs of churn risk?
      - Can I see the customer drift findings flagged for churn?
      instructions:
      - text: List customer churn-risk findings.
      - text: Show customers flagged as likely to churn.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/drift/config'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration drift findings
      effect: read
      questions:
      - Has my billing configuration drifted from what it should be?
      - What config drift findings are currently open?
      instructions:
      - text: List config drift findings.
      - text: Show configuration drift detected in my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/drift/summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize drift findings by kind
      effect: read
      questions:
      - How many drift findings do I have of each kind?
      - Is there an overview of drift across Stripe, customer and config checks?
      instructions:
      - text: Give me the per-kind drift summary.
      - text: Summarize drift counts across all detectors.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/drift/findings/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single drift finding
      effect: read
      questions:
      - What are the details of one particular drift finding?
      - Can I open a drift finding directly by its ID?
      instructions:
      - text: Get drift finding {id}.
        slots:
          id: path.id
      - text: Show me the details of finding {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/drift/findings/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Acknowledge, resolve or suppress a finding
      effect: write
      questions:
      - How do I mark a drift finding as resolved?
      - Can I suppress a drift finding I don't care about?
      instructions:
      - text: Acknowledge drift finding {id}.
        slots:
          id: path.id
      - text: Resolve finding {id}.
        slots:
          id: path.id
      - text: Suppress drift finding {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/drift/{kind}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a drift detector on demand
      effect: write
      questions:
      - Can I trigger a drift check right now instead of waiting for the schedule?
      - Which kind of drift detector can I enqueue on demand?
      instructions:
      - text: Run the {kind} drift detector now.
        slots:
          kind: path.kind
      - text: Enqueue an on-demand {kind} drift check.
        slots:
          kind: path.kind
      method: generated
      generated: '2026-09-26'