DoiT · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DoiT Templates API

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

$.paths['/cloudflow/v1/templates/{templateId}'].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 Templates API
  version: 1.0.0
extends: openapi/doit-templates-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['/cloudflow/v1/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse CloudFlow templates
      effect: read
      questions:
      - What CloudFlow blueprints are available to start from?
      - Can I page through the CloudFlow template catalogue?
      instructions:
      - text: List the available CloudFlow templates.
      - text: Show me the CloudFlow blueprint catalogue, {n} at a time.
        slots:
          n: query.maxResults
      method: generated
      generated: '2026-10-01'
- target: $.paths['/cloudflow/v1/templates/{templateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a CloudFlow template
      effect: read
      questions:
      - How do I see what a specific CloudFlow blueprint contains?
      - Can I fetch one template by its ID?
      instructions:
      - text: Get CloudFlow template {templateId}.
        slots:
          templateId: path.templateId
      - text: Show me the blueprint {templateId}.
        slots:
          templateId: path.templateId
      method: generated
      generated: '2026-10-01'