hatchet/api-contracts/openapi/paths/event/event.yaml

withTenant:
  get:
    x-resources: ["tenant"]
    description: Lists all events for a tenant.
    operationId: event:list
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
      - description: The number to skip
        in: query
        name: offset
        required: false
        schema:
          type: integer
          format: int64
      - description: The number to limit by
        in: query
        name: limit
        required: false
        schema:
          type: integer
          format: int64
      - description: A list of keys to filter by
        in: query
        name: keys
        required: false
        schema:
          type: array
          items:
            $ref: "../../components/schemas/_index.yaml#/EventKey"
      - description: What to order by
        in: query
        name: orderByField
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/EventOrderByField"
      - description: The order direction
        in: query
        name: orderByDirection
        required: false
        schema:
          $ref: "../../components/schemas/_index.yaml#/EventOrderByDirection"
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/EventList"
        description: Successfully listed the events
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: List events
    tags:
      - Event

eventData:
  get:
    x-resources: ["tenant", "event"]
    description: Get the data for an event.
    operationId: event-data:get
    parameters:
      - description: The event id
        in: path
        name: event
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/EventData"
        description: Successfully retrieved the event data
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Get event data
    tags:
      - Event

keys:
  get:
    x-resources: ["tenant"]
    description: Lists all event keys for a tenant.
    operationId: event-key:list
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/EventKeyList"
        description: Successfully listed the event keys
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: List event keys
    tags:
      - Event

replayEvents:
  post:
    x-resources: ["tenant"]
    description: Replays a list of events.
    operationId: event:update:replay
    parameters:
      - description: The tenant id
        in: path
        name: tenant
        required: true
        schema:
          type: string
          format: uuid
          minLength: 36
          maxLength: 36
    requestBody:
      content:
        application/json:
          schema:
            $ref: "../../components/schemas/_index.yaml#/ReplayEventRequest"
      description: The event ids to replay
      required: true
    responses:
      "200":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/EventList"
        description: Successfully replayed the events
      "400":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: A malformed or bad request
      "403":
        content:
          application/json:
            schema:
              $ref: "../../components/schemas/_index.yaml#/APIErrors"
        description: Forbidden
    summary: Replay events
    tags:
      - Event