DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Cloud Incidents API

3 actions 3 updates phrasing extends openapi/doit-cloud-incidents-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['/core/v1/cloudincidents'].get
$.paths['/core/v1/cloudincidents/{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 Cloud Incidents API
  version: 1.0.0
extends: openapi/doit-cloud-incidents-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['/core/v1/cloudincidents'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud incidents
      effect: read
      questions:
      - Are there any active Google Cloud or Amazon Web Services incidents right now?
      - Can I see historical cloud incidents within a time window?
      instructions:
      - text: List cloud incidents created since {since}.
        slots:
          since: query.minCreationTime
      - text: Show all current and past cloud incidents.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/core/v1/cloudincidents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a cloud incident
      effect: read
      questions:
      - How do I get the details of a specific cloud incident?
      - What does one incident record include?
      instructions:
      - text: Get cloud incident {id}.
        slots:
          id: path.id
      - text: Show me the details of incident {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'