Skip to content
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

refactor(30463): Fix bugs in the OpenAPI specs of the data combining feature #822

Merged

Conversation

vanch3d
Copy link
Contributor

@vanch3d vanch3d commented Feb 24, 2025

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

Implementing the frontend part of the data combining has highlighted a few mis-specifications of the API that need correction. Most are cosmetic changes (reorganised the structure of schemas to facilitate the visualisation of the editor), but a few are breaking changes:

  • a schema property is added to the destination of DataCombining
  • a DataIdentifier schema is being created to provide a "namespaced" reference to both tags and `topic filters
  • two new API endpoints are added
    • GET /api/v1/management/topic-filters/{filter}
    • GET /api/v1/management/topic-filters/{filter}/schema

Out-of-scope

  • Other issues might be worth fixing at some point but are not required (e.f. the use of items: {} in schemas). They will be dealt with in another ticket

@vanch3d vanch3d requested a review from sfrehse February 24, 2025 16:03
@vanch3d vanch3d self-assigned this Feb 24, 2025
@cla-bot cla-bot bot added the cla-signed label Feb 24, 2025
@vanch3d vanch3d changed the base branch from master to epic/29097-data-combining February 24, 2025 16:08
Copy link
Contributor

@codepitbull codepitbull left a comment

Choose a reason for hiding this comment

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

Just one wording change for id vs name.

@vanch3d vanch3d marked this pull request as ready for review February 25, 2025 09:33
@vanch3d
Copy link
Contributor Author

vanch3d commented Feb 25, 2025

Incorrect specifications of the routes; need fix

@vanch3d vanch3d force-pushed the refactor/30463/openapi-bug-fixes branch from d2213aa to 59fffb6 Compare February 25, 2025 14:15
Copy link
Contributor

@DC2-DanielKrueger DC2-DanielKrueger left a comment

Choose a reason for hiding this comment

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

We have two open api specs, this one and the 2025.4-SNAPSHOT one, we must decide on which one to use

@DC2-DanielKrueger DC2-DanielKrueger force-pushed the refactor/30463/openapi-bug-fixes branch from 8ae06ca to a224a48 Compare February 26, 2025 12:45
Copy link
Contributor

@codepitbull codepitbull left a comment

Choose a reason for hiding this comment

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

One comment about XML naming conventions.

@DC2-DanielKrueger DC2-DanielKrueger merged commit 660d476 into epic/29097-data-combining Feb 26, 2025
3 checks passed
@DC2-DanielKrueger DC2-DanielKrueger deleted the refactor/30463/openapi-bug-fixes branch February 26, 2025 14:42
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.

3 participants