feat(33306): Refactor the OpenAPI specs into a Redocly project #994
+8,934
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See https://hivemq.kanbanize.com/ctrl_board/57/cards/33306/details/
The PR refactors the OpenAPI specs of the Edge project in two ways
./hivemq-edge-openapi
, which will allow its design and modification free of implementationRedocly
project, which provides a set of tools to help you work with OpenAPI definitionsOut-of-scope
Redocly
tool introduces linting for the OpenAPI specs. There are currently 80+ errors to be fixed. The linting rules of the project (inredocly.yaml
) have been changed to reflect the prioritieshivemq-edge-openapi
is not covered by the recently revamped CI pipeline. A dedicated pipeline, with at least the linting check (see https://github.com/marketplace/actions/redocly-cli-github-action), will be implemented in a subsequent ticket..ext/
) has not been removed yet, in order to support a couple of ongoing API changes. The migration will be completed in a subsequent ticket.