ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DaaS Realtime Metrics API

4 actions 4 updates phrasing extends openapi/controlup-metrics-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['/v1/metrics/query'].post
$.paths['/v1/metrics/schema/tables'].get
$.paths['/v1/metrics/schema/tables/{tableName}'].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 VDI & DaaS Realtime Metrics API
  version: 1.0.0
extends: openapi/controlup-metrics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/metrics/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query realtime metrics
      effect: read
      questions:
      - Can I query realtime metrics from a table with filters and sorting?
      - Which sessions or machines are using the most CPU right now?
      instructions:
      - text: Query realtime metrics from table {table}.
        slots:
          table: requestBody.table
      - text: Query table {table} returning fields {fields} where {where}, sorted by {sort}.
        slots:
          table: requestBody.table
          fields: requestBody.fields
          where: requestBody.where
          sort: requestBody.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/metrics/schema/tables'].get
  update:
    x-apievangelist-phrasing:
      intent: List metric tables
      effect: read
      questions:
      - What realtime metric tables are available to query?
      - Which tables can I use in a metrics query?
      instructions:
      - text: List the available metric tables.
      - text: Show every table in the realtime metrics schema.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/metrics/schema/tables/{tableName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields of a metric table
      effect: read
      questions:
      - What fields does a given metric table have?
      - Which columns can I select from a specific metrics table?
      instructions:
      - text: List the fields of metric table {tableName}.
        slots:
          tableName: path.tableName
      - text: Show the schema of metrics table {tableName}.
        slots:
          tableName: path.tableName
      method: generated
      generated: '2026-09-26'