Drippay · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drip Workflows API

5 actions 5 updates phrasing extends openapi/drippay-workflows-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 5

$.info
$.paths['/v1/workflows'].get
$.paths['/v1/workflows'].post
$.paths['/v1/workflows/{id}'].get
$.paths['/v1/workflows/{id}'].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 Drip Workflows API
  version: 1.0.0
extends: openapi/drippay-workflows-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['/v1/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflows for the business
      effect: read
      questions:
      - Which workflows have I defined for tracking agent runs?
      - Can I list only active workflows for a given product surface?
      instructions:
      - text: List all my workflows.
      - text: Show workflows on the {productSurface} product surface where active is {isActive}.
        slots:
          productSurface: query.productSurface
          isActive: query.isActive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workflow definition
      effect: write
      questions:
      - How do I define a new workflow so I can track agent runs against it?
      - What format does a workflow slug have to follow?
      instructions:
      - text: Create a workflow named {name} with slug {slug}.
        slots:
          name: requestBody.name
          slug: requestBody.slug
      - text: Create workflow {name} ({slug}) on the {productSurface} surface.
        slots:
          name: requestBody.name
          slug: requestBody.slug
          productSurface: requestBody.productSurface
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/workflows/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workflow with usage statistics
      effect: read
      questions:
      - What are the usage statistics for one of my workflows?
      - Can I fetch a single workflow's definition by ID?
      instructions:
      - text: Get workflow {id} and its usage stats.
        slots:
          id: path.id
      - text: Show me the details of workflow {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/workflows/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a workflow
      effect: write
      questions:
      - Can I change the name or description of an existing workflow?
      - How do I deactivate a workflow I no longer use?
      instructions:
      - text: Update workflow {id} with a new description.
        slots:
          id: path.id
      - text: Mark workflow {id} as inactive.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'