DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Alerts API

6 actions 6 updates phrasing extends openapi/doit-alerts-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 6

$.info
$.paths['/analytics/v1/alerts'].get
$.paths['/analytics/v1/alerts'].post
$.paths['/analytics/v1/alerts/{id}'].get
$.paths['/analytics/v1/alerts/{id}'].delete
$.paths['/analytics/v1/alerts/{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 DoiT Alerts API
  version: 1.0.0
extends: openapi/doit-alerts-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: 5
- target: $.paths['/analytics/v1/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost alerts
      effect: read
      questions:
      - Which cost alerts have been set up in our account?
      - Can I sort or filter the list of alerts?
      instructions:
      - text: List all my alerts.
      - text: List alerts sorted by {sortBy}.
        slots:
          sortBy: query.sortBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/alerts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cost alert
      effect: write
      questions:
      - How do I get notified when cloud spend crosses a threshold?
      - Can I choose who receives a new alert's notifications?
      instructions:
      - text: Create an alert named {name} with config {config}.
        slots:
          name: requestBody.name
          config: requestBody.config
      - text: Set up alert {name} using {config} and send it to {recipients}.
        slots:
          name: requestBody.name
          config: requestBody.config
          recipients: requestBody.recipients
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/alerts/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an alert
      effect: read
      questions:
      - How do I see the settings of one alert?
      - What condition and recipients does a given alert have?
      instructions:
      - text: Get alert {id}.
        slots:
          id: path.id
      - text: Show the configuration of alert {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/alerts/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an alert
      effect: destructive
      questions:
      - How do I remove an alert I no longer need?
      - Can I permanently delete a cost alert?
      instructions:
      - text: Delete alert {id}.
        slots:
          id: path.id
      - text: Remove the alert {id} from our account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/alerts/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing alert
      effect: write
      questions:
      - How do I change the threshold on an alert I already created?
      - Can I rename an alert or change who it notifies?
      instructions:
      - text: Update alert {id} with config {config}.
        slots:
          id: path.id
          config: requestBody.config
      - text: Change recipients of alert {id} to {recipients} keeping config {config}.
        slots:
          id: path.id
          recipients: requestBody.recipients
          config: requestBody.config
      method: generated
      generated: '2026-10-01'