SOLR-15744: Convert task-mgmt v2 APIs to annotations #863
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
Solr's been in the slow process of moving its v2 APIs away from the existing apispec/mapping framework towards one that relies on more explicit annotations to specify API properties. This commit converts the APIs from the core.tasks.cancel.json and core.tasks.list.json apispec files to the "new" framework.
epugh
reviewed
May 16, 2022
| /** | ||
| * V2 API for cancelling a currently running "task". | ||
| * | ||
| * <p>This API (GET /v2/collections/collectionName/tasks/cancel) is analogous to the v1 |
There was a problem hiding this comment.
tiny nit pick.. in the docs we use both collName and collectionName, but here we use collectionName.. ;-(. I think I'm saying I like you spelled it out!
There was a problem hiding this comment.
(I updated the docs PR to use the full "collectionName" based on your comment here 👍 )
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
Solr is slowly moving over to standardize on the "annotation-based" framework for implementing APIs, but many APIs remain using the old apispec framework.
Solution
This commit switches over the two apispec files holding our "task management" APIs to the new annotation framework.
Tests
Since there is no difference between the v2 and v1 task management APIs (other than path prefix), this commit isn't adding any new functionality to test. It's just refactoring existing functionality and relying on existing tests. I have tested it manually though.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.