# 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 Settings API
  version: 1.0.0
extends: openapi/svix-environment-settings-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/environment/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the environment's settings
      effect: read
      questions:
      - What settings are applied to the environment my API key belongs to?
      - Can I read environment settings with a regular API token?
      instructions:
      - text: Get the settings for my current environment.
      - text: Show the environment settings visible to this API key.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get dashboard environment settings
      effect: read
      questions:
      - How do I see the full dashboard settings for my environment, like branding and retry policy?
      - Which management settings are enabled on my environment, such as channels or transformations?
      instructions:
      - text: Get the dashboard-level environment settings.
      - text: Show my environment's management settings including branding and feature toggles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the environment's settings
      effect: write
      questions:
      - How do I update all of my environment's settings in one full replace?
      - Can I enforce HTTPS for every endpoint in the environment?
      instructions:
      - text: Update environment settings with retry policy {retryPolicy} and enforce HTTPS set to {enforceHttps}.
        slots:
          retryPolicy: requestBody.retryPolicy
          enforceHttps: requestBody.enforceHttps
      - text: Replace the environment settings, setting display name {displayName} and color {customColor}.
        slots:
          displayName: requestBody.displayName
          customColor: requestBody.customColor
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment-settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change individual environment settings
      effect: write
      questions:
      - How do I turn on just one feature, like transformations, without resending every setting?
      - Can I change only the portal logo for my environment?
      instructions:
      - text: Patch environment settings to set enable transformations to {enableTransformations}.
        slots:
          enableTransformations: requestBody.enableTransformations
      - text: Change only the portal logo URL to {customLogoUrl}.
        slots:
          customLogoUrl: requestBody.customLogoUrl
      - text: Set disable endpoint on failure to {disableEndpointOnFailure} and leave other settings alone.
        slots:
          disableEndpointOnFailure: requestBody.disableEndpointOnFailure
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment-settings/customer-otel'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the OpenTelemetry export config
      effect: read
      questions:
      - Where is my environment sending OpenTelemetry data?
      - Do I have a customer OTel collector configured?
      instructions:
      - text: Get my customer OTel configuration.
      - text: Show the OpenTelemetry collector URL and headers set for the environment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment-settings/customer-otel'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the OpenTelemetry export config
      effect: write
      questions:
      - How do I send Svix telemetry to my own OpenTelemetry collector?
      - Can I add auth headers to the OTel export?
      instructions:
      - text: Send OpenTelemetry data to collector {url}.
        slots:
          url: requestBody.url
      - text: Set the OTel config to {url} with headers {additionalHeaders}.
        slots:
          url: requestBody.url
          additionalHeaders: requestBody.additionalHeaders
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/management/environment-settings/customer-otel'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the OpenTelemetry export config
      effect: destructive
      questions:
      - How do I stop exporting telemetry to my OpenTelemetry collector?
      - Can I delete the customer OTel config entirely?
      instructions:
      - text: Delete my customer OTel configuration.
      - text: Turn off OpenTelemetry export for the environment.
      method: generated
      generated: '2026-09-26'