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>)

StatusDescriptionBody
200application/json EventCatalogueResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/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>)

StatusDescriptionBody
200application/json EventCatalogueAsyncApiResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/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>)

ParameterInTypeRequiredDescription
majorpathstringyesThe schema major, a non-negative integer.
typepathstringyesThe exact event type.
StatusDescriptionBody
200application/json EventSchemaResponseDtoDataEnvelope
400application/problem+json ProblemDetailsDto
401application/problem+json ProblemDetailsDto
403application/problem+json ProblemDetailsDto
404application/problem+json ProblemDetailsDto
409application/problem+json ProblemDetailsDto
422application/problem+json ProblemDetailsDto
500application/problem+json ProblemDetailsDto