# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Integration API
  version: 1.0.0
extends: openapi/svix-integration-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/app/{app_id}/integration'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's integrations
      effect: read
      questions:
      - Which integrations are set up for one of my applications?
      - Can I page through an app's integrations with a limit?
      instructions:
      - text: List the integrations of application {app_id}.
        slots:
          app_id: path.app_id
      - text: Show {limit} integrations for app {app_id}.
        slots:
          limit: query.limit
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/integration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an integration for an application
      effect: write
      questions:
      - How do I add an integration to an application?
      - Can I enable feature flags on a new integration?
      instructions:
      - text: Create an integration named {name} on app {app_id}.
        slots:
          name: requestBody.name
          app_id: path.app_id
      - text: Add integration {name} to application {app_id} with feature flags {featureFlags}.
        slots:
          name: requestBody.name
          app_id: path.app_id
          featureFlags: requestBody.featureFlags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/integration/{integ_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration
      effect: read
      questions:
      - What name and feature flags does a given integration have?
      - Can I look up one integration on an application by its ID?
      instructions:
      - text: Show integration {integ_id} of app {app_id}.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      - text: Fetch the details of application {app_id}'s integration {integ_id}.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/integration/{integ_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an integration
      effect: write
      questions:
      - How do I rename an integration?
      - Can I change which feature flags an existing integration has?
      instructions:
      - text: Rename integration {integ_id} on app {app_id} to {name}.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
          name: requestBody.name
      - text: 'Update integration {integ_id} of app {app_id}: name {name}, feature flags {featureFlags}.'
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
          name: requestBody.name
          featureFlags: requestBody.featureFlags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/integration/{integ_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an integration
      effect: destructive
      questions:
      - How do I remove an integration from an application?
      - Can I permanently delete an integration and its key?
      instructions:
      - text: Delete integration {integ_id} from app {app_id}.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      - text: Remove application {app_id}'s integration {integ_id} for good.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/integration/{integ_id}/key/rotate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an integration's key
      effect: destructive
      questions:
      - How do I replace an integration key that may have leaked?
      - Does the old integration key stop working immediately after rotation?
      instructions:
      - text: Rotate the key of integration {integ_id} on app {app_id}.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      - text: Revoke and reissue the key for application {app_id}'s integration {integ_id}.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/app/{app_id}/integration/{integ_id}/key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an integration's key
      effect: read
      questions:
      - Where do I find the key for an integration?
      - Can I retrieve the current key of an existing integration?
      instructions:
      - text: Get the key for integration {integ_id} on app {app_id}.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      - text: Show application {app_id}'s integration {integ_id} key.
        slots:
          integ_id: path.integ_id
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'