ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Cloud providers API

4 actions 4 updates phrasing extends openapi/controlup-cloud-providers-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['/cloud/providers'].get

$.paths['/cloud/providers/auth-types'].get

$.paths['/cloud/providers/{provider}/auth-types'].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 DaaS IQ Cloud providers API
  version: 1.0.0
extends: openapi/controlup-cloud-providers-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['/cloud/providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported cloud providers
      effect: read
      questions:
      - Which cloud providers can ControlUp integrate with?
      - What display names are used for the supported clouds?
      instructions:
      - text: List the supported cloud providers.
      - text: Show which clouds the platform can connect to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/providers/auth-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication types across all providers
      effect: read
      questions:
      - What authentication types are supported across every cloud provider?
      - Which credential types exist in the full catalog, regardless of provider?
      instructions:
      - text: List every supported authentication type across all providers.
      - text: Show the full catalog of cloud credential types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/cloud/providers/{provider}/auth-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication types for one provider
      effect: read
      questions:
      - Which authentication types can I use for a particular cloud provider?
      - What credential type should a tenant use once I've picked Azure?
      instructions:
      - text: List the authentication types valid for provider {provider}.
        slots:
          provider: path.provider
      - text: Show which credential types provider {provider} accepts.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-09-26'