events
Operations of the Biome Host API. Paths are relative to your deployment's API host.
GET /api/biome-host-api/events/catalogue
The event catalogue the caller's organization sees: every registered (type, major) of the platform and of this organization, its state, schema versions, producers, consumers, and the consumers still on an older major.
Authentication: bearer token (Authorization: Bearer <token>)
| Status | Description | Body |
|---|---|---|
| 200 | application/json EventCatalogueResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/biome-host-api/events/catalogue/asyncapi
The same event catalogue as an AsyncAPI 3.0 document: one channel per type, one message per major.
Authentication: bearer token (Authorization: Bearer <token>)
| Status | Description | Body |
|---|---|---|
| 200 | application/json EventCatalogueAsyncApiResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |
GET /api/biome-host-api/events/schemas/{type}/{major}
The payload schema of one (type, major) and its version history: the path of the CloudEvents dataschema (https://schemas.xema.dev/events/<type>/<major>). Retired majors stay served. A type the caller's organization does not see is 404.
Authentication: bearer token (Authorization: Bearer <token>)
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
major | path | string | yes | The schema major, a non-negative integer. |
type | path | string | yes | The exact event type. |
| Status | Description | Body |
|---|---|---|
| 200 | application/json EventSchemaResponseDtoDataEnvelope | |
| 400 | application/problem+json ProblemDetailsDto | |
| 401 | application/problem+json ProblemDetailsDto | |
| 403 | application/problem+json ProblemDetailsDto | |
| 404 | application/problem+json ProblemDetailsDto | |
| 409 | application/problem+json ProblemDetailsDto | |
| 422 | application/problem+json ProblemDetailsDto | |
| 500 | application/problem+json ProblemDetailsDto |