General
co.brick observe follows the general rules of google's API design guide applicable to REST APIs.
Versioning and backward compatibility
All interfaces provide major version as the first part of the URI, e.g.:
/v1/topology/[...]
Non-breaking changes may be introduced within a major version. Breaking changes are introduced in a new major version.
Pagination and limits
All listable collections support pagination, even if the results are typically small. Default and hard limits are always defined and respective values are given in swagger.
Errors
Standard REST response codes are used. For more details see Hypertext Transfer Protocol -- HTTP/1.1 and Additional HTTP Status Codes.
Each erroneous response contains at a minimum:
- tenant,
- service name,
- error message,
- recommendation of an action (e.g.: try to re-issue the request).