ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DAAS Dynamic Query API

3 actions 3 updates phrasing extends openapi/controlup-dynamic-query-api-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 3

$.info
$.paths['/v1/dynamic-query/execute'].post
$.paths['/v1/dynamic-query/schema'].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 Dynamic Query API
  version: 1.0.0
extends: openapi/controlup-dynamic-query-api-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: 2
- target: $.paths['/v1/dynamic-query/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a SQL query over ControlUp data
      effect: read
      questions:
      - Can I run my own SQL query against historical ControlUp data?
      - Will my SQL be validated and transformed before it runs?
      instructions:
      - text: Run SQL query {query}.
        slots:
          query: requestBody.query
      - text: Execute {query} for the period {from} to {to}, {pageSize} rows per page.
        slots:
          query: requestBody.query
          from: requestBody.from
          to: requestBody.to
          pageSize: requestBody.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/dynamic-query/schema'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the query database schema as CSV
      effect: read
      questions:
      - What tables and columns can I use in a dynamic SQL query?
      - Can I download the database schema for one table as CSV?
      instructions:
      - text: Download the dynamic query database schema.
      - text: Get the schema CSV for table {tableName}.
        slots:
          tableName: query.tableName
      method: generated
      generated: '2026-09-26'