DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Allocations API

6 actions 6 updates phrasing extends openapi/doit-allocations-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/allocations'].get
$.paths['/analytics/v1/allocations'].post
$.paths['/analytics/v1/allocations/{id}'].get
$.paths['/analytics/v1/allocations/{id}'].delete
$.paths['/analytics/v1/allocations/{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 Allocations API
  version: 1.0.0
extends: openapi/doit-allocations-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/allocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List cost allocations
      effect: read
      questions:
      - What allocations are defined for splitting our cloud costs?
      - Can I filter allocations or change their sort order?
      instructions:
      - text: List all allocations.
      - text: List allocations matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/allocations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a cost allocation
      effect: write
      questions:
      - How do I group cloud costs by team or project with an allocation?
      - Can I turn on anomaly detection for a new allocation?
      instructions:
      - text: Create allocation {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Create allocation {name} ({description}) with rules {rules} in folder {folderId}.
        slots:
          name: requestBody.name
          description: requestBody.description
          rules: requestBody.rules
          folderId: requestBody.folderId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/allocations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an allocation
      effect: read
      questions:
      - How do I see the rules behind one allocation?
      - What does a specific allocation include?
      instructions:
      - text: Get allocation {id}.
        slots:
          id: path.id
      - text: Show me the rules of allocation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/allocations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an allocation
      effect: destructive
      questions:
      - How do I get rid of an allocation we stopped using?
      - Can I delete an allocation permanently?
      instructions:
      - text: Delete allocation {id}.
        slots:
          id: path.id
      - text: Remove allocation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/allocations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an existing allocation
      effect: write
      questions:
      - How do I change the rules of an allocation I already have?
      - Can I move an existing allocation into a different folder?
      instructions:
      - text: Update allocation {id} with rules {rules}.
        slots:
          id: path.id
          rules: requestBody.rules
      - text: Move allocation {id} to folder {folderId}.
        slots:
          id: path.id
          folderId: requestBody.folderId
      method: generated
      generated: '2026-10-01'