DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Anomalies API

3 actions 3 updates phrasing extends openapi/doit-anomalies-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 3

$.info
$.paths['/anomalies/v1'].get
$.paths['/anomalies/v1/{id}'].get

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 Anomalies API
  version: 1.0.0
extends: openapi/doit-anomalies-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: 2
- target: $.paths['/anomalies/v1'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost anomalies
      effect: read
      questions:
      - Were there any cost anomalies detected recently?
      - Can I list anomalies within a date range?
      - Can I include notification details with each anomaly?
      instructions:
      - text: List cost anomalies created after {since}.
        slots:
          since: query.minCreationTime
      - text: Show detected anomalies with their notifications included.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/anomalies/v1/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a cost anomaly
      effect: read
      questions:
      - How do I see the full details of one spend anomaly?
      - What information is recorded for a specific anomaly?
      instructions:
      - text: Get anomaly {id}.
        slots:
          id: path.id
      - text: Show me the details of cost anomaly {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'