Harness · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Harness Backstage Env Variable API
12 actions
12 updates
phrasing
extends
openapi/harness-backstageenvvariable-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
What the actions change
x-apievangelist-phrasing
Targets 12
$.info
$.paths['/v1/backstage-env-variables'].get
$.paths['/v1/backstage-env-variables'].post
$.paths['/v1/backstage-env-variables/sync'].put
$.paths['/v1/backstage-env-variables/{backstage-env-variable}'].get
$.paths['/v1/backstage-env-variables/{backstage-env-variable}'].put
$.paths['/v1/backstage-env-variables/{backstage-env-variable}'].delete
$.paths['/v1/backstage-env-variables/batch'].put
$.paths['/v1/backstage-env-variables/batch'].post
$.paths['/v1/backstage-env-variables/batch'].delete
$.paths['/v1/backstage-env-variables/resolve'].get
$.paths['/v1/backstage-env-variables/reload/{namespace}'].put
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 Harness Backstage Env Variable API
version: 1.0.0
extends: openapi/harness-backstageenvvariable-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: 11
- target: $.paths['/v1/backstage-env-variables'].get
update:
x-apievangelist-phrasing:
intent: List Backstage environment variables
effect: read
questions:
- Which environment variables are mapped into my Harness IDP Backstage instance?
- Can I page through the Backstage env variable mappings for my account?
instructions:
- text: List all Backstage environment variables in my account.
- text: Show the first {limit} Backstage env variable mappings sorted by {sort}.
slots:
limit: query.limit
sort: query.sort
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables'].post
update:
x-apievangelist-phrasing:
intent: Create a Backstage environment variable
effect: write
questions:
- How do I add a new environment variable for Backstage to use, like a secret-backed token?
- Can I map a single Harness secret into Backstage as an env variable?
instructions:
- text: Create a Backstage environment variable {env_variable}.
slots:
env_variable: requestBody.env_variable
- text: Add one new env variable to Backstage from definition {env_variable}.
slots:
env_variable: requestBody.env_variable
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/sync'].put
update:
x-apievangelist-phrasing:
intent: Sync all Backstage environment variables
effect: write
questions:
- My Backstage env variable mappings look out of date; can I resynchronize them all?
- Is there a way to push every Backstage environment variable mapping again for my account?
instructions:
- text: Synchronize all Backstage environment variable mappings for my account.
- text: Run a full sync of Backstage env variables.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/{backstage-env-variable}'].get
update:
x-apievangelist-phrasing:
intent: Get one Backstage environment variable
effect: read
questions:
- What is a particular Backstage env variable mapped to?
- Can I look up the mapping for one named Backstage environment variable?
instructions:
- text: Show the mapping for Backstage env variable {backstage_env_variable}.
slots:
backstage_env_variable: path.backstage-env-variable
- text: Fetch Backstage environment variable {backstage_env_variable}.
slots:
backstage_env_variable: path.backstage-env-variable
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/{backstage-env-variable}'].put
update:
x-apievangelist-phrasing:
intent: Update a Backstage environment variable
effect: write
questions:
- Can I point an existing Backstage env variable at a different secret?
- How do I change the value of one Backstage environment variable?
instructions:
- text: Update Backstage env variable {backstage_env_variable} to {env_variable}.
slots:
backstage_env_variable: path.backstage-env-variable
env_variable: requestBody.env_variable
- text: Change the mapping of Backstage environment variable {backstage_env_variable}.
slots:
backstage_env_variable: path.backstage-env-variable
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/{backstage-env-variable}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Backstage environment variable
effect: destructive
questions:
- Can I remove one environment variable Backstage no longer needs?
- What happens to Backstage plugins when I delete the env variable they read?
instructions:
- text: Delete Backstage env variable {backstage_env_variable}.
slots:
backstage_env_variable: path.backstage-env-variable
- text: Remove the single Backstage environment variable {backstage_env_variable}.
slots:
backstage_env_variable: path.backstage-env-variable
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/batch'].put
update:
x-apievangelist-phrasing:
intent: Update several Backstage env variables at once
effect: write
questions:
- Can I update many Backstage environment variables in one request?
- Is there a bulk edit for Backstage env variable mappings?
instructions:
- text: 'Bulk update these Backstage env variables: {env_variables}.'
slots:
env_variables: requestBody.env_variables
- text: Apply the batch of Backstage environment variable changes {env_variables}.
slots:
env_variables: requestBody.env_variables
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/batch'].post
update:
x-apievangelist-phrasing:
intent: Create several Backstage env variables at once
effect: write
questions:
- How do I add a whole set of environment variables to Backstage in one call?
- Can I bulk-create Backstage env variables when onboarding plugins?
instructions:
- text: 'Bulk create these new Backstage env variables: {env_variables}.'
slots:
env_variables: requestBody.env_variables
- text: Add the batch of new Backstage environment variables {env_variables}.
slots:
env_variables: requestBody.env_variables
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/batch'].delete
update:
x-apievangelist-phrasing:
intent: Delete several Backstage env variables at once
effect: destructive
questions:
- Can I remove multiple Backstage environment variables in a single request?
- Is there a bulk delete for Backstage env variable mappings?
instructions:
- text: Bulk delete the Backstage env variables {backstage_env_variable}.
slots:
backstage_env_variable: query.backstage-env-variable
- text: 'Remove this batch of Backstage environment variables: {backstage_env_variable}.'
slots:
backstage_env_variable: query.backstage-env-variable
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/resolve'].get
update:
x-apievangelist-phrasing:
intent: Resolve Backstage env variables to their decrypted values
effect: read
questions:
- What are the actual decrypted values behind my Backstage environment variables?
- Can I resolve Backstage env variables for one namespace only?
instructions:
- text: Resolve the Backstage env variables in namespace {namespace} to their decrypted values.
slots:
namespace: query.namespace
- text: Return the decrypted values of all Backstage environment variables in my account.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/backstage-env-variables/reload/{namespace}'].put
update:
x-apievangelist-phrasing:
intent: Reload Backstage env variables in a namespace
effect: write
questions:
- After changing a secret, how do I get Backstage to reload its env variables?
- Can I reload the environment variables for one Backstage namespace?
instructions:
- text: Reload the Backstage env variables in namespace {namespace}.
slots:
namespace: path.namespace
- text: Trigger a reload of Backstage environment variables for namespace {namespace}.
slots:
namespace: path.namespace
method: generated
generated: '2026-09-26'