✨ [REST-API] Add support to query operations by status in GET /{scopeId}/devices/{deviceId}/operations
#4121
+77
−10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…opeId}/devices/{deviceId}/operations`
- Implemented the ability to query operations based on their status via the `GET /{scopeId}/devices/{deviceId}/operations` endpoint.
- Modified `DeviceManagementOperations` query method to support the new functionality:
- Deprecated the existing `query` method that required `@PathParam("deviceId") EntityId deviceId` parameter.
- Introduced a new `query1` method to replace the old one, omitting the `deviceId` parameter for consistency across other query methods.
- Updated documentation accordingly.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #4121 +/- ##
=============================================
- Coverage 16.81% 16.80% -0.01%
Complexity 22 22
=============================================
Files 2019 2019
Lines 52437 52443 +6
Branches 4423 4425 +2
=============================================
Hits 8815 8815
- Misses 43224 43230 +6
Partials 398 398
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR implements the capability to search operations by their status using the
GET /{scopeId}/devices/{deviceId}/operationsendpoint.Changes Made
DeviceManagementOperationsquery method:querymethod has been deprecated. It previously required the@PathParam("deviceId") EntityId deviceIdparameter.query1method that conforms to the parameters accepted and usage patterns of other query methods. ThedeviceIdparameter was removed, improving consistency across endpoints._query(deprecated) endpoint will be removed in a future release._query1endpoint will eventually be deprecated in favor of a new_queryendpoint with the same behavior but a "correct" name._query1will be deleted in a subsequent release, following a smooth deprecation process.Impact
These changes are backward-compatible but introduce a new method for querying operations. Users relying on the existing
querymethod should migrate to the newquery1method or prepare for the upcoming changes.Notes
query1is provisional and can be adjusted based on feedback. It was chosen to maintain backward compatibility while moving towards a cleaner design.