# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Harness Onboarding API version: 1.0.0 extends: openapi/harness-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: 16 - target: $.paths['/ng/api/onboarding/execute'].post update: x-apievangelist-phrasing: intent: Provision a Kubernetes service setup in one call effect: write questions: - Can I create the secrets, connectors and Kubernetes service for onboarding in one request? - Does one declarative onboarding call set up a service with a Git manifest and Docker image? instructions: - text: 'Run declarative onboarding in project {project} with this context: {input}.' slots: project: query.projectIdentifier input: requestBody.input - text: Provision secrets, connectors and a Kubernetes service for account {account} from {input}. slots: account: query.accountIdentifier input: requestBody.input method: generated generated: '2026-09-26' - target: $.paths['/ng/api/onboarding/kubeconfig/upload'].post update: x-apievangelist-phrasing: intent: Upload a kubeconfig for onboarding effect: write questions: - Can I onboard my cluster by uploading a kubeconfig file? - What happens to a kubeconfig I upload during onboarding? instructions: - text: Upload kubeconfig file {file} for onboarding in account {account}. slots: file: requestBody.file account: query.accountIdentifier - text: Process kubeconfig {file} for project {project}. slots: file: requestBody.file project: query.projectIdentifier method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/pipeline-onboarding'].get update: x-apievangelist-phrasing: intent: List pipelines onboarded to chaos effect: read questions: - Which of my pipelines have been onboarded to chaos engineering? - Where can I see all pipeline chaos onboarding entries in a project? instructions: - text: List pipeline chaos onboarding entries in project {project}. slots: project: query.projectIdentifier - text: Show every pipeline onboarded to chaos for account {account}. slots: account: query.accountIdentifier method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/pipeline-onboarding'].post update: x-apievangelist-phrasing: intent: Onboard a pipeline to chaos engineering effect: write questions: - Can I add chaos experiments to an existing pipeline? - Is AI-assisted setup available when onboarding a pipeline to chaos? instructions: - text: Onboard pipeline {pipeline} to chaos in project {project}. slots: pipeline: requestBody.pipelineIdentity project: query.projectIdentifier - text: Onboard pipeline {pipeline} to chaos with AI enabled set to {ai}. slots: pipeline: requestBody.pipelineIdentity ai: requestBody.isAIEnabled method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}'].delete update: x-apievangelist-phrasing: intent: Delete a pipeline chaos onboarding entry effect: destructive questions: - Can I remove a pipeline's chaos onboarding record? - What is needed to undo onboarding a pipeline to chaos? instructions: - text: Delete the chaos onboarding entry {identity}. slots: identity: path.identity - text: Remove pipeline onboarding {identity} from project {project}. slots: identity: path.identity project: query.projectIdentifier method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/can-onboard-chaos'].get update: x-apievangelist-phrasing: intent: Check whether a pipeline can be onboarded effect: read questions: - Is my pipeline eligible to be onboarded to chaos? - Can this pipeline take chaos experiments before I try onboarding it? instructions: - text: Check if pipeline {identity} can be onboarded to chaos. slots: identity: path.identity - text: Verify chaos onboarding eligibility for pipeline {identity} in project {project}. slots: identity: path.identity project: query.projectIdentifier method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/status'].get update: x-apievangelist-phrasing: intent: Get a pipeline's chaos onboarding status effect: read questions: - Has my pipeline finished onboarding to chaos? - What stage is a pipeline's chaos onboarding in right now? instructions: - text: Get chaos onboarding status for pipeline {identity}. slots: identity: path.identity - text: Show how far pipeline {identity} is through chaos onboarding. slots: identity: path.identity method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding'].get update: x-apievangelist-phrasing: intent: List chaos onboarding runs effect: read questions: - Which chaos onboarding runs exist in my project? - Can I search v2 chaos onboardings by name? instructions: - text: List chaos onboardings in project {project} matching {search}, page {page} of size {limit}. slots: project: query.projectIdentifier search: query.search page: query.page limit: query.limit - text: Search v2 onboardings for {search}. slots: search: query.search method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding'].post update: x-apievangelist-phrasing: intent: Start a chaos onboarding for an environment effect: write questions: - Can I start chaos onboarding against a specific environment and infrastructure? - Does chaos onboarding support an automatic mode and a manual mode? instructions: - text: Start chaos onboarding in {mode} mode for environment {env} on infrastructure {infra}. slots: mode: requestBody.mode env: requestBody.environmentRef infra: requestBody.infrastructureRef - text: Create a v2 onboarding using service account {sa} on infrastructure {infra}. slots: sa: requestBody.serviceAccount infra: requestBody.infrastructureRef method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding-confirm-discovery/{onboardingid}'].post update: x-apievangelist-phrasing: intent: Confirm the discovery step of manual onboarding effect: write questions: - How do I approve the service discovery step in a manual chaos onboarding? - Can I move a manual onboarding past discovery once I've checked it? instructions: - text: Confirm discovery for onboarding {onboarding}. slots: onboarding: path.onboardingid - text: Approve the discovered services in manual onboarding {onboarding}. slots: onboarding: path.onboardingid method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-creation/{onboardingid}'].post update: x-apievangelist-phrasing: intent: Confirm experiment creation in manual onboarding effect: write questions: - Can I approve which chaos experiments get created during manual onboarding? - What confirms the experiment-creation step of a manual onboarding? instructions: - text: Confirm experiment creation for onboarding {onboarding}. slots: onboarding: path.onboardingid - text: Approve creating experiments in onboarding {onboarding} using mode {mode}. slots: onboarding: path.onboardingid mode: requestBody.mode method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-run/{onboardingid}'].post update: x-apievangelist-phrasing: intent: Confirm the experiment run in manual onboarding effect: write questions: - When onboarding manually, how do I give the go-ahead to run the experiments? - Can I trigger the experiment-run step of a manual onboarding? instructions: - text: Confirm the experiment run for onboarding {onboarding}. slots: onboarding: path.onboardingid - text: Let onboarding {onboarding} run its chaos experiments. slots: onboarding: path.onboardingid method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding-confirm-networkmap/{onboardingid}'].post update: x-apievangelist-phrasing: intent: Confirm network map creation in onboarding effect: write questions: - Can I confirm the network map a manual chaos onboarding built? - What step accepts the network map during manual onboarding? instructions: - text: Confirm the network map for onboarding {onboarding}. slots: onboarding: path.onboardingid - text: Accept network map creation in onboarding {onboarding} with mode {mode}. slots: onboarding: path.onboardingid mode: requestBody.mode method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}'].get update: x-apievangelist-phrasing: intent: Get a chaos onboarding effect: read questions: - What is the current state of one chaos onboarding run? - Can I look up a single v2 onboarding by its ID? instructions: - text: Get chaos onboarding {onboarding}. slots: onboarding: path.onboardingid - text: Show details of v2 onboarding {onboarding} in project {project}. slots: onboarding: path.onboardingid project: query.projectIdentifier method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/experiments'].get update: x-apievangelist-phrasing: intent: List experiments created by an onboarding effect: read questions: - Which chaos experiments did an onboarding create? - Can I page through the experiments tied to one onboarding? instructions: - text: List experiments for onboarding {onboarding}, page {page} with {limit} per page. slots: onboarding: path.onboardingid page: query.page limit: query.limit - text: Show the chaos experiments generated by onboarding {onboarding}. slots: onboarding: path.onboardingid method: generated generated: '2026-09-26' - target: $.paths['/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/stop'].post update: x-apievangelist-phrasing: intent: Stop experiments started by an onboarding effect: destructive questions: - Can I halt the chaos experiments an onboarding kicked off? - What stops all running experiments from one onboarding? instructions: - text: Stop the experiments of onboarding {onboarding}. slots: onboarding: path.onboardingid - text: Halt every chaos experiment running under onboarding {onboarding}. slots: onboarding: path.onboardingid method: generated generated: '2026-09-26'