API Evangelist conversational phrasing for Svix 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 Event Type API
  version: 1.0.0
extends: openapi/svix-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: 10
- target: $.paths['/api/v1/event-type'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook event types
      effect: read
      questions:
      - What event types have I defined for my webhooks?
      - Can I include archived event types when listing them?
      instructions:
      - text: List my webhook event types.
      - text: List event types including archived ones, up to {limit}.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or unarchive an event type
      effect: write
      questions:
      - How do I register a new webhook event type like invoice.paid in Svix?
      - Can I bring back an archived event type so messages can use it again?
      - Can I attach a JSON schema when creating an event type?
      instructions:
      - text: Create event type {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Create event type {name} with description {description} in group {groupName}.
        slots:
          name: requestBody.name
          description: requestBody.description
          groupName: requestBody.groupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/import/openapi'].post
  update:
    x-apievangelist-phrasing:
      intent: Import event types from an OpenAPI spec
      effect: write
      questions:
      - How do I create event types from the webhooks section of my OpenAPI document?
      - Can I dry-run an OpenAPI import to see which event types would change?
      instructions:
      - text: Import event types from OpenAPI spec {spec}.
        slots:
          spec: requestBody.spec
      - text: 'Dry-run an event type import from this raw OpenAPI spec: {specRaw}.'
        slots:
          specRaw: requestBody.specRaw
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/{event_type_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event type
      effect: read
      questions:
      - What schema and description does a given event type have?
      - Is a specific event type archived or deprecated?
      instructions:
      - text: Get event type {event_type_name}.
        slots:
          event_type_name: path.event_type_name
      - text: Show the details and schemas of event type {event_type_name}.
        slots:
          event_type_name: path.event_type_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/{event_type_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an event type
      effect: write
      questions:
      - How do I upsert an event type by name, creating it if it's missing?
      - Can I replace an event type's description and schemas in one call?
      instructions:
      - text: Upsert event type {event_type_name} with description {description}.
        slots:
          event_type_name: path.event_type_name
          description: requestBody.description
      - text: Replace event type {event_type_name} with description {description} and schemas {schemas}.
        slots:
          event_type_name: path.event_type_name
          description: requestBody.description
          schemas: requestBody.schemas
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/{event_type_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive or expunge an event type
      effect: destructive
      questions:
      - How do I retire an event type so no new messages can be sent with it?
      - Can I permanently expunge an event type instead of just archiving it?
      instructions:
      - text: Archive event type {event_type_name}.
        slots:
          event_type_name: path.event_type_name
      - text: Permanently expunge event type {event_type_name}.
        slots:
          event_type_name: path.event_type_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/{event_type_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update an event type
      effect: write
      questions:
      - How do I mark an existing event type as deprecated?
      - Can I change only an event type's group name?
      instructions:
      - text: Mark event type {event_type_name} deprecated.
        slots:
          event_type_name: path.event_type_name
      - text: Patch event type {event_type_name} to move it into group {groupName}.
        slots:
          event_type_name: path.event_type_name
          groupName: requestBody.groupName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/{event_type_name}/retry-schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an event type's retry schedule
      effect: read
      questions:
      - How often are failed deliveries of a particular event type retried?
      - Does this event type have its own retry schedule?
      instructions:
      - text: Get the retry schedule for event type {event_type_name}.
        slots:
          event_type_name: path.event_type_name
      - text: Show how messages of {event_type_name} get retried.
        slots:
          event_type_name: path.event_type_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/{event_type_name}/retry-schedule'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an event type's retry schedule
      effect: write
      questions:
      - How do I give one event type a custom retry schedule?
      - Can I make failed messages of a specific event type retry faster?
      instructions:
      - text: Set the retry schedule for event type {event_type_name} to {retrySchedule}.
        slots:
          event_type_name: path.event_type_name
          retrySchedule: requestBody.retrySchedule
      - text: Retry {event_type_name} messages on the schedule {retrySchedule}.
        slots:
          event_type_name: path.event_type_name
          retrySchedule: requestBody.retrySchedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/event-type/export/openapi'].post
  update:
    x-apievangelist-phrasing:
      intent: Export event types as an OpenAPI document
      effect: read
      questions:
      - How do I export all my event type schemas as an OpenAPI file?
      - Can I generate an OpenAPI document from the event types I've defined?
      instructions:
      - text: Export my event types to OpenAPI.
      - text: Start a background task that builds an OpenAPI spec from my event type schemas.
      method: generated
      generated: '2026-09-26'