DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Budget Suggestions API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/analytics/v1/budget-suggestions'].get
$.paths['/analytics/v1/budget-suggestions/{id}/actions/accept'].post
$.paths['/analytics/v1/budget-suggestions/{id}/actions/dismiss'].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 DoiT Budget Suggestions API
  version: 1.0.0
extends: openapi/doit-budget-suggestions-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: 3
- target: $.paths['/analytics/v1/budget-suggestions'].get
  update:
    x-apievangelist-phrasing:
      intent: List AI budget suggestions
      effect: read
      questions:
      - Has DoiT suggested any budgets for us?
      - Which AI-generated budget suggestions are still pending?
      instructions:
      - text: List pending budget suggestions.
      - text: Show me the AI-suggested budgets awaiting review.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/budget-suggestions/{id}/actions/accept'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a budget suggestion
      effect: write
      questions:
      - How do I accept a suggested budget once I've created it?
      - Can I record that I edited a suggestion before accepting it?
      instructions:
      - text: Accept suggestion {id} and link it to budget {budgetId}.
        slots:
          id: path.id
          budgetId: requestBody.budgetId
      - text: Mark budget suggestion {id} accepted as budget {budgetId}.
        slots:
          id: path.id
          budgetId: requestBody.budgetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/budget-suggestions/{id}/actions/dismiss'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss a budget suggestion
      effect: write
      questions:
      - How do I hide a budget suggestion I don't want?
      - Can I give a reason when dismissing a suggestion?
      instructions:
      - text: Dismiss budget suggestion {id}.
        slots:
          id: path.id
      - text: Dismiss suggestion {id} because {reason}.
        slots:
          id: path.id
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'