API Evangelist conversational phrasing for Svix Stream Event Type API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Svix Stream Event Type API
  version: 1.0.0
extends: openapi/svix-stream-event-type-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['/api/v1/stream/event-type'].get
  update:
    x-apievangelist-phrasing:
      intent: List stream event types
      effect: read
      questions:
      - What event types are defined for my streams?
      - Can I include archived stream event types in the list?
      instructions:
      - text: List my stream event types.
      - text: List up to {limit} stream event types, including archived.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/event-type'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stream event type
      effect: write
      questions:
      - How do I define a new event type for Svix Stream?
      - Can I add a description when creating a stream event type?
      instructions:
      - text: Create stream event type {name}.
        slots:
          name: requestBody.name
      - text: Create stream event type {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/event-type/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stream event type
      effect: read
      questions:
      - What does a particular stream event type look like?
      - Is a given stream event type deprecated?
      instructions:
      - text: Get stream event type {name}.
        slots:
          name: path.name
      - text: Show the details of the {name} stream event type.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/event-type/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a stream event type
      effect: write
      questions:
      - How do I upsert a stream event type by name?
      - Can I replace a stream event type's whole definition at once?
      instructions:
      - text: Upsert stream event type {name} with description {description}.
        slots:
          name: path.name
          description: requestBody.description
      - text: Replace the {name} stream event type definition, setting archived to {archived}.
        slots:
          name: path.name
          archived: requestBody.archived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/event-type/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stream event type
      effect: destructive
      questions:
      - How do I delete a stream event type?
      - Can I fully expunge a stream event type rather than just remove it?
      instructions:
      - text: Delete stream event type {name}.
        slots:
          name: path.name
      - text: Delete and expunge the {name} stream event type.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/stream/event-type/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a stream event type
      effect: write
      questions:
      - How do I deprecate a stream event type without redefining it?
      - Can I change only the description of a stream event type?
      instructions:
      - text: Mark stream event type {name} as deprecated.
        slots:
          name: path.name
      - text: Patch the description of stream event type {name} to {description}.
        slots:
          name: path.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'