# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Novu Environments API
  version: 1.0.0
extends: openapi/novu-environments-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: 7
- target: $.paths['/v1/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments
      effect: read
      questions:
      - What environments does my Novu organization have?
      - Where can I find the API keys for each of my environments?
      instructions:
      - text: List all environments in my organization.
      - text: Show my environments with their configuration and API keys.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment
      effect: write
      questions:
      - How do I add a staging environment with its own API keys?
      - Can a new environment inherit from a parent environment?
      instructions:
      - text: Create an environment named {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      - text: Create environment {name} in color {color} under parent {parentId}.
        slots:
          name: requestBody.name
          color: requestBody.color
          parentId: requestBody.parentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/{environmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an environment
      effect: write
      questions:
      - How do I rename an environment or change its color?
      - Can I update the bridge or DNS settings of an existing environment?
      instructions:
      - text: Rename environment {environmentId} to {name}.
        slots:
          environmentId: path.environmentId
          name: requestBody.name
      - text: Set the bridge configuration on environment {environmentId} to {bridge}.
        slots:
          environmentId: path.environmentId
          bridge: requestBody.bridge
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environments/{environmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - What gets removed when I delete an environment?
      - Can a deleted environment be recovered?
      instructions:
      - text: Delete environment {environmentId} and all its data.
        slots:
          environmentId: path.environmentId
      - text: Permanently remove the environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/environments/{environmentId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List workflow tags in an environment
      effect: read
      questions:
      - Which tags are used across the workflows in an environment?
      - How can I get the tag list I'd use to filter workflows in one environment?
      instructions:
      - text: List the workflow tags used in environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Show all unique tags in environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/environments/{targetEnvironmentId}/publish'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish resources to another environment
      effect: write
      questions:
      - How do I promote my development workflows to production?
      - Can I publish only selected resources instead of everything?
      - Is there a dry-run mode to see what a publish would change?
      instructions:
      - text: Publish everything from {sourceEnvironmentId} to environment {targetEnvironmentId}.
        slots:
          sourceEnvironmentId: requestBody.sourceEnvironmentId
          targetEnvironmentId: path.targetEnvironmentId
      - text: Publish only {resources} to environment {targetEnvironmentId}.
        slots:
          resources: requestBody.resources
          targetEnvironmentId: path.targetEnvironmentId
      - text: Do a publish to {targetEnvironmentId} with dryRun {dryRun} so I can preview it.
        slots:
          targetEnvironmentId: path.targetEnvironmentId
          dryRun: requestBody.dryRun
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/environments/{targetEnvironmentId}/diff'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare two environments
      effect: read
      questions:
      - What's different between my development and production workflows?
      - Can I see which resources were added, modified or deleted between environments?
      instructions:
      - text: Diff environment {sourceEnvironmentId} against {targetEnvironmentId}.
        slots:
          sourceEnvironmentId: requestBody.sourceEnvironmentId
          targetEnvironmentId: path.targetEnvironmentId
      - text: Show what differs in target environment {targetEnvironmentId}.
        slots:
          targetEnvironmentId: path.targetEnvironmentId
      method: generated
      generated: '2026-09-26'