# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Novu Environment Variables API
  version: 1.0.0
extends: openapi/novu-environment-variables-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['/v1/environment-variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List environment variables
      effect: read
      questions:
      - What environment variables are defined for my Novu organization?
      - Can I search my variables by key?
      - Are secret variable values shown when I list them?
      instructions:
      - text: List all environment variables.
      - text: Search environment variables for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environment-variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment variable
      effect: write
      questions:
      - How do I add a new variable like BASE_URL for my workflows to use?
      - What format does a variable key have to follow?
      - Can I store a variable as a secret so it's encrypted and masked?
      instructions:
      - text: Create environment variable {key}.
        slots:
          key: requestBody.key
      - text: Create secret variable {key} with isSecret set to {isSecret} and values {values}.
        slots:
          key: requestBody.key
          isSecret: requestBody.isSecret
          values: requestBody.values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environment-variables/{variableKey}/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: See which workflows use a variable
      effect: read
      questions:
      - Which workflows reference a given environment variable in their steps?
      - Is it safe to remove a variable, or do workflows still use it?
      instructions:
      - text: Show the workflows that use variable {variableKey}.
        slots:
          variableKey: path.variableKey
      - text: Find every workflow step referencing env.{variableKey}.
        slots:
          variableKey: path.variableKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environment-variables/{variableKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment variable
      effect: read
      questions:
      - How do I look up a single environment variable by its key?
      - What type and per-environment values does a specific variable have?
      instructions:
      - text: Show me environment variable {variableKey}.
        slots:
          variableKey: path.variableKey
      - text: Fetch the settings of variable {variableKey}.
        slots:
          variableKey: path.variableKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environment-variables/{variableKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment variable
      effect: destructive
      questions:
      - How do I remove an environment variable I no longer need?
      - Can I delete a variable by its key?
      instructions:
      - text: Delete environment variable {variableKey}.
        slots:
          variableKey: path.variableKey
      - text: Remove the {variableKey} variable permanently.
        slots:
          variableKey: path.variableKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environment-variables/{variableKey}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an environment variable
      effect: write
      questions:
      - How do I change a variable's value for just one environment?
      - Do environments I leave out keep their stored value when I update a variable?
      - Can I turn an existing variable into a secret?
      instructions:
      - text: Update variable {variableKey} with per-environment values {values}.
        slots:
          variableKey: path.variableKey
          values: requestBody.values
      - text: 'Mark existing variable {variableKey} as secret: {isSecret}.'
        slots:
          variableKey: path.variableKey
          isSecret: requestBody.isSecret
      - text: Rename variable {variableKey} to {key}.
        slots:
          variableKey: path.variableKey
          key: requestBody.key
      method: generated
      generated: '2026-09-26'