API Evangelist conversational phrasing for Convoy API Reference Event Types API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Convoy API Reference Event Types API
  version: 1.0.0
extends: openapi/convoy-event-types-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/projects/{projectID}/event-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's event types
      effect: read
      questions:
      - Which event types are defined in my Convoy project?
      - Can I see the catalog of event types my subscribers can choose from?
      instructions:
      - text: List the event types in project {projectID}.
        slots:
          projectID: path.projectID
      - text: Show me every event type I've defined, including deprecated ones, for project {projectID}.
        slots:
          projectID: path.projectID
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v1/projects/{projectID}/event-types'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an event type
      effect: write
      questions:
      - How do I register a new event type like invoice.created?
      - Can I attach a JSON schema and category when defining an event type?
      instructions:
      - text: Create event type {name} in project {projectID}.
        slots:
          name: requestBody.name
          projectID: path.projectID
      - text: Add event type {name} in category {category} described as {description}.
        slots:
          name: requestBody.name
          category: requestBody.category
          description: requestBody.description
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v1/projects/{projectID}/event-types/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import event types from an OpenAPI spec
      effect: write
      questions:
      - Can I load all my event types from an OpenAPI document instead of creating them one by one?
      - Is there a bulk import of event types from a spec file?
      instructions:
      - text: Import event types from this OpenAPI spec {spec} into project {projectID}.
        slots:
          spec: requestBody.spec
          projectID: path.projectID
      - text: Create event types for project {projectID} from the webhooks in my OpenAPI file.
        slots:
          projectID: path.projectID
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v1/projects/{projectID}/event-types/{eventTypeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing event type
      effect: write
      questions:
      - How do I change the JSON schema of an event type that already exists?
      - Can I edit the description or category of an existing event type?
      instructions:
      - text: Update the existing event type's description to {description} in project {projectID}.
        slots:
          description: requestBody.description
          projectID: path.projectID
      - text: Replace the JSON schema of event type {eventTypeId} with {json_schema}.
        slots:
          eventTypeId: path.eventTypeId
          json_schema: requestBody.json_schema
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v1/projects/{projectID}/event-types/{eventTypeId}/deprecate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deprecate an event type
      effect: destructive
      questions:
      - How do I mark an event type as deprecated so new subscribers stop using it?
      - Can I retire an old event type without deleting it?
      instructions:
      - text: Deprecate event type {eventTypeId} in project {projectID}.
        slots:
          eventTypeId: path.eventTypeId
          projectID: path.projectID
      - text: Mark event type {eventTypeId} as deprecated.
        slots:
          eventTypeId: path.eventTypeId
      method: generated
      generated: '2026-10-02'