core-common 0.0.0-beta.1

Defines common structures used throughout the chamber.io infrastructure.

  • Contact: N/A
  • License: N/A

Resources

No resources

Headers

No headers

Imports

No imports

Enums

No enums

Interfaces

No interfaces

Models

generic_error

Example Json: Minimal | Full

Interfaces: None

A generic error providing a message and some basic meta data.

Field Type Required? Default Description
id uuid Yes -

A guid for identifying the error e.g. in log files.

timestamp date-time-iso8601 Yes -

Timestamp of the when the error occurred.

source string No -

An optional source on which the error occurred.

type string No -

An optional type for categorizing e.g. validation or invalid_state.

message string Yes -

The actual message of the error.

healthcheck

Example Json: Minimal | Full

Interfaces: None

Response model indicating the health of a service.

Field Type Required? Default Description
health string Yes -

The current health of the service. Normally this is healthy, otherwise an simple error message can be shown.

Unions

No unions

Annotations

No annotations