ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Health API

4 actions 4 updates phrasing extends openapi/controlup-health-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ControlUp's API. It is a proposal applied on top of the contract, not a document ControlUp publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/health'].get
$.paths['/health/live'].get
$.paths['/health/info'].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 DaaS IQ Health API
  version: 1.0.0
extends: openapi/controlup-health-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: 3
- target: $.paths['/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check API and dependency health
      effect: read
      questions:
      - Is the ControlUp API healthy, including its dependencies?
      - Are any backend dependencies of the API reporting problems?
      instructions:
      - text: Check the health of the API and its dependencies.
      - text: Run a full health check including downstream dependencies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/health/live'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that the API process is alive
      effect: read
      questions:
      - Is there a lightweight liveness probe that skips dependency checks?
      - Can I ping the API process to see if it is up?
      instructions:
      - text: Run the liveness probe without checking dependencies.
      - text: Ping the API process to confirm it's alive.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/health/info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the deployed build version
      effect: read
      questions:
      - Which build version of the API is currently deployed?
      - Can I verify a deployment by reading the build metadata?
      instructions:
      - text: Show the deployed build info and version.
      - text: Get build metadata to verify the current deployment.
      method: generated
      generated: '2026-10-01'