# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Environment API
  version: 1.0.0
extends: openapi/svix-environment-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['/api/v1/management/environment'].get
  update:
    x-apievangelist-phrasing:
      intent: List environments
      effect: read
      questions:
      - Which environments exist in my Svix account?
      - Can I page through my environments with a limit?
      instructions:
      - text: List all my environments.
      - text: Show the first {limit} environments.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment
      effect: write
      questions:
      - How do I add a separate environment, such as a staging one?
      - What type do I have to choose when creating an environment?
      instructions:
      - text: Create an environment named {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Set up a new {type} environment called {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment/{env_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment
      effect: read
      questions:
      - What are the name and type of a given environment?
      - Can I look up one environment by its ID?
      instructions:
      - text: Show environment {env_id}.
        slots:
          env_id: path.env_id
      - text: Fetch the details of environment {env_id}.
        slots:
          env_id: path.env_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment/{env_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename an environment
      effect: write
      questions:
      - How do I rename an environment?
      - Can I change an environment's name after creating it?
      instructions:
      - text: Rename environment {env_id} to {name}.
        slots:
          env_id: path.env_id
          name: requestBody.name
      - text: Update environment {env_id} so its name is {name}.
        slots:
          env_id: path.env_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment/{env_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - How do I delete an environment I no longer use?
      - Can I permanently remove a test environment?
      instructions:
      - text: Delete environment {env_id}.
        slots:
          env_id: path.env_id
      - text: Remove environment {env_id} permanently.
        slots:
          env_id: path.env_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/environment/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export the environment's settings and event types
      effect: read
      questions:
      - How do I download all my org settings and event types as a JSON file?
      - Can I back up the current environment's configuration?
      instructions:
      - text: Export the current environment's configuration.
      - text: Download my org settings and event types as JSON.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/environment/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import settings and event types into an environment
      effect: write
      questions:
      - How do I copy event types and settings from one environment into another?
      - Does importing a configuration delete anything that isn't in the file?
      instructions:
      - text: Import event types {eventTypes} into the active environment.
        slots:
          eventTypes: requestBody.eventTypes
      - text: Import settings {settings} and connectors {connectors} into this organization.
        slots:
          settings: requestBody.settings
          connectors: requestBody.connectors
      method: generated
      generated: '2026-09-26'