DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Commitment Manager API

3 actions 3 updates phrasing extends openapi/doit-commitment-manager-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['/analytics/v1/commitment-manager'].get

$.paths['/analytics/v1/commitment-manager/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DoiT Commitment Manager API
  version: 1.0.0
extends: openapi/doit-commitment-manager-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['/analytics/v1/commitment-manager'].get
  update:
    x-apievangelist-phrasing:
      intent: List cloud commitments
      effect: read
      questions:
      - What cloud commitments do we have tracked in DoiT?
      - Can I sort or filter the commitments list?
      instructions:
      - text: List all our commitments.
      - text: List commitments matching filter {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/commitment-manager/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a commitment
      effect: read
      questions:
      - How do I see the details of a single commitment?
      - Can I look up one commitment's terms by its ID?
      instructions:
      - text: Get commitment {id}.
        slots:
          id: path.id
      - text: Show me the details of commitment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'