ControlUp · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DaaS IQ Onboarding API

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

$.paths['/onboarding/{flowKey}'].get

$.paths['/onboarding/{flowKey}'].patch

$.paths['/onboarding/{flowKey}/start'].post

$.paths['/onboarding/{flowKey}/steps/{stepKey}'].put

$.paths['/onboarding/{flowKey}/dismiss'].post

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 Onboarding API
  version: 1.0.0
extends: openapi/controlup-onboarding-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['/onboarding'].get
  update:
    x-apievangelist-phrasing:
      intent: List my onboarding flows
      effect: read
      questions:
      - Which onboarding flows do I have, and how far along am I?
      - Have I dismissed any onboarding flows?
      instructions:
      - text: List my onboarding flows.
      - text: Show progress across all my onboarding flows.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/{flowKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one onboarding flow
      effect: read
      questions:
      - What step am I on in a particular onboarding flow?
      - Can I see the per-step state of one onboarding flow?
      instructions:
      - text: Show onboarding flow {flowKey}.
        slots:
          flowKey: path.flowKey
      - text: Get the active step in onboarding flow {flowKey}.
        slots:
          flowKey: path.flowKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/{flowKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an onboarding flow's display or active step
      effect: write
      questions:
      - Can I minimize an onboarding flow or jump to another step?
      - Can I move the active step pointer in a flow without completing steps?
      instructions:
      - text: Set onboarding flow {flowKey} display state to {displayState}.
        slots:
          flowKey: path.flowKey
          displayState: requestBody.displayState
      - text: Move flow {flowKey} to active step {activeStep} with display state {displayState}.
        slots:
          flowKey: path.flowKey
          activeStep: requestBody.activeStep
          displayState: requestBody.displayState
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/{flowKey}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an onboarding flow
      effect: write
      questions:
      - Can I begin an onboarding flow and initialise its steps?
      - What marks an onboarding flow as started for me?
      instructions:
      - text: Start onboarding flow {flowKey}.
        slots:
          flowKey: path.flowKey
      - text: Begin the {flowKey} onboarding for me.
        slots:
          flowKey: path.flowKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/{flowKey}/steps/{stepKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Mark an onboarding step done or not
      effect: write
      questions:
      - Can I mark a single onboarding step as complete?
      - Which call records completion of one step in a flow?
      instructions:
      - text: Set step {stepKey} in flow {flowKey} to {state}.
        slots:
          stepKey: path.stepKey
          flowKey: path.flowKey
          state: requestBody.state
      - text: Mark onboarding step {stepKey} of {flowKey} as completed.
        slots:
          stepKey: path.stepKey
          flowKey: path.flowKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/onboarding/{flowKey}/dismiss'].post
  update:
    x-apievangelist-phrasing:
      intent: Dismiss an onboarding flow
      effect: write
      questions:
      - Can I skip and hide an onboarding flow I don't want?
      - Does dismissing a flow erase my step progress?
      instructions:
      - text: Dismiss onboarding flow {flowKey}.
        slots:
          flowKey: path.flowKey
      - text: Hide the {flowKey} onboarding flow for me.
        slots:
          flowKey: path.flowKey
      method: generated
      generated: '2026-09-26'