ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Dex License Usage API

2 actions 2 updates phrasing extends openapi/controlup-license-usage-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['/organizations/{orgId}/license/usage'].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 Dex License Usage API
  version: 1.0.0
extends: openapi/controlup-license-usage-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['/organizations/{orgId}/license/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get license usage over a time range
      effect: read
      questions:
      - How many ControlUp licenses did my organization use last month?
      - As an MSP, can I see license usage broken out for specific child organizations?
      instructions:
      - text: Get license usage for organization {orgId} from {timeFrom} to {timeTo}.
        slots:
          orgId: path.orgId
          timeFrom: query.timeFrom
          timeTo: query.timeTo
      - text: Show license usage for child organizations {childOrgsIds} of {orgId} between {timeFrom} and {timeTo}.
        slots:
          childOrgsIds: query.childOrgsIds
          orgId: path.orgId
          timeFrom: query.timeFrom
          timeTo: query.timeTo
      method: generated
      generated: '2026-09-26'