ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ControlUp for Desktops Dal API

2 actions 2 updates phrasing extends openapi/controlup-dal-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 2

$.info
$.paths['/dal/{index}'].post

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 ControlUp for Desktops Dal API
  version: 1.0.0
extends: openapi/controlup-dal-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: 1
- target: $.paths['/dal/{index}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query a data index scoped to selected devices
      effect: read
      questions:
      - Can I read a data index but only for devices matching a device query?
      - How do I combine a device filter with a query on another data index?
      instructions:
      - text: Return data index {index} limited to devices matching {device_query}.
        slots:
          device_query: requestBody.device_query
          index: path.index
      - text: Query index {index} with {data_query} for devices in scope {device_query}.
        slots:
          data_query: requestBody.data_query
          device_query: requestBody.device_query
          index: path.index
      method: generated
      generated: '2026-09-26'