-
Task
-
Resolution: Done
-
Major
-
None
-
None
-
None
WHAT
Implement the Non-breaking changes for admin server
WHY
Increase consistency between the Kafka instance admin API and other public APIs
Copied from MGDSTRM-4891.
Non-breaking
- Add new fields to `Error` [1], provide endpoints to fetch errors, full list and individually
- Add `ObjectReference` type [2], all singular API types should extend (`id` will not be required/available for some types)
- Add `List` type [3], all collection API types should extend
Breaking (wait for major version change)
- Change to snake case property names
- Snake case for URL/path segments
- Change of `code` field from integer to string in `Error` Object
[1] https://github.com/redhat-developer/app-services-api-guidelines/tree/main/spectral#rhoas-error-schema
[2] https://github.com/redhat-developer/app-services-api-guidelines/tree/main/spectral#rhoas-object-schema
[3] https://github.com/redhat-developer/app-services-api-guidelines/tree/main/spectral#rhoas-list-schema
- mentioned on
(3 mentioned on)