Skip to content

feat(33306): Refactor the OpenAPI specs into a Redocly project #994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

vanch3d
Copy link
Contributor

@vanch3d vanch3d commented May 26, 2025

See https://hivemq.kanbanize.com/ctrl_board/57/cards/33306/details/

The PR refactors the OpenAPI specs of the Edge project in two ways

  • relocate the source in its own root directory, ./hivemq-edge-openapi, which will allow its design and modification free of implementation
  • bundle the sources into a Redocly project, which provides a set of tools to help you work with OpenAPI definitions

Out-of-scope

  • The Redocly tool introduces linting for the OpenAPI specs. There are currently 80+ errors to be fixed. The linting rules of the project (in redocly.yaml) have been changed to reflect the priorities
    rules:
      no-unused-components: error
      ### Custom rules - error must be fixed
      security-defined: off
      no-server-example.com: error
    The errors will be fixed in a subsequent ticket
  • The hivemq-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.
  • The deprecated file system (in .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.

@vanch3d vanch3d self-assigned this May 26, 2025
@cla-bot cla-bot bot added the cla-signed label May 26, 2025
Copy link
Member

@caoccao caoccao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -0,0 +1,21 @@
The MIT License (MIT)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why MIT? Did we agree on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants