ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for VDI & DAAS Net Scaler API

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

$.info
$.paths['/v2/netscaler/usage/system'].get
$.paths['/v2/netscaler/usage/loadbalancer'].get
$.paths['/v2/netscaler/usage/gateway'].get
$.paths['/v1/netscaler/usage/system'].get
$.paths['/v1/netscaler/usage/loadbalancer'].get
$.paths['/v1/netscaler/usage/gateway'].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 Net Scaler API
  version: 1.0.0
extends: openapi/controlup-netscaler-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: 6
- target: $.paths['/v2/netscaler/usage/system'].get
  update:
    x-apievangelist-phrasing:
      intent: Get NetScaler appliance metrics as a time series (v2)
      effect: read
      questions:
      - How did my NetScaler appliances perform over time, point by point, in the v2 report?
      - Can I chart CPU and throughput per NetScaler appliance across a date range?
      instructions:
      - text: Get v2 time-series metrics for every NetScaler appliance from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Chart appliance {name} over time between {_timeFrom} and {_timeTo} using the time-series endpoint.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/netscaler/usage/loadbalancer'].get
  update:
    x-apievangelist-phrasing:
      intent: Get load balancer metrics as a time series (v2)
      effect: read
      questions:
      - How did each NetScaler load balancer's traffic trend over the period, as a time series?
      - Can I get v2 load balancer metrics over time for just one appliance?
      instructions:
      - text: Get v2 time-series load balancer metrics from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Chart load balancer {name} on appliance {netscalerName} over time from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          name: query.name
          netscalerName: query.netscalerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/netscaler/usage/gateway'].get
  update:
    x-apievangelist-phrasing:
      intent: Get NetScaler Gateway metrics as a time series (v2)
      effect: read
      questions:
      - How did NetScaler Gateway usage trend over time during the period?
      - Can I get time-series gateway metrics filtered to one appliance?
      instructions:
      - text: Get v2 time-series gateway metrics from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Chart gateway {name} on appliance {netscalerName} over time from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          name: query.name
          netscalerName: query.netscalerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/netscaler/usage/system'].get
  update:
    x-apievangelist-phrasing:
      intent: Get NetScaler appliance metrics (v1 summary)
      effect: read
      questions:
      - What were the summary performance metrics for each NetScaler appliance in a period, without a time series?
      - Can I get the older v1 appliance report for one NetScaler by name?
      instructions:
      - text: Get v1 summary metrics for each NetScaler appliance from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Summarize appliance {name} for {_timeFrom} to {_timeTo} with the v1 report.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/netscaler/usage/loadbalancer'].get
  update:
    x-apievangelist-phrasing:
      intent: Get load balancer metrics (v1 summary)
      effect: read
      questions:
      - What were the v1 summary metrics for each NetScaler load balancer in a period?
      - Can I get a load balancer summary without time-series points?
      instructions:
      - text: Get v1 summary load balancer metrics from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Summarize load balancer {name} on {netscalerName} for {_timeFrom} to {_timeTo} with the v1 report.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          name: query.name
          netscalerName: query.netscalerName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/netscaler/usage/gateway'].get
  update:
    x-apievangelist-phrasing:
      intent: Get NetScaler Gateway metrics (v1 summary)
      effect: read
      questions:
      - What were the v1 summary metrics for each NetScaler Gateway in a period?
      - Can I get a single gateway's summary without time-series points?
      instructions:
      - text: Get v1 summary gateway metrics from {_timeFrom} to {_timeTo}.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
      - text: Summarize gateway {name} for {_timeFrom} to {_timeTo} with the v1 report.
        slots:
          _timeFrom: query._timeFrom
          _timeTo: query._timeTo
          name: query.name
      method: generated
      generated: '2026-09-26'