SOLR-16398: Tweak v2 B-S-U API to be more REST-ful #1689
Merged
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
Still needs a 'gradle check'
epugh
reviewed
Jun 4, 2023
| BalanceShardUniqueAPI.createRemoteMessage("someCollName", requestBody).getProperties(); | ||
|
|
||
| assertEquals(6, remoteMessage.size()); | ||
| assertEquals("balanceshardunique", remoteMessage.get(QUEUE_OPERATION)); |
There was a problem hiding this comment.
nitpick, but should this be balanceShardUnique?
There was a problem hiding this comment.
I don't think so actually. In v1 code this property gets passed to the overseer through CollectionAction.toString().toLower(Locale.ROOT) calls. So I've kept it lowercase in the v2 code to maintain parity with that.
Ideally the overseer would just be smart enough to ignore case when handling this property. (It's possible it does that already 🤷, though idk for sure.) But in any case I figured it was safest to use all lowercase as the v1 code has historically done.
epugh
approved these changes
Jun 4, 2023
gerlowskija
added a commit
that referenced
this pull request
Jun 17, 2023
This commit changes the v2 "balance-shard-unique" replica to be more
in line with the REST-ful design we're targeting for Solr's v2 APIs.
Following these changes, the v2 API now appears as:
`POST /api/collections/cName/balance-shard-unique {...}`
Although not shown above, the 'balance-shard-unique' command
specifier has also been removed from the request body.
This commit also converts the API to the new JAX-RS framework.
epugh
pushed a commit
that referenced
this pull request
Jun 21, 2023
This commit changes the v2 "balance-shard-unique" replica to be more
in line with the REST-ful design we're targeting for Solr's v2 APIs.
Following these changes, the v2 API now appears as:
`POST /api/collections/cName/balance-shard-unique {...}`
Although not shown above, the 'balance-shard-unique' command
specifier has also been removed from the request body.
This commit also converts the API to the new JAX-RS framework.
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.
https://issues.apache.org/jira/browse/SOLR-16398
Description
Solr has slowly been modifying its v2 APIs to align around a more REST-ful model. Many APIs have already been through this re-alignment but many more remain, including Solr's "balance-shard-unique" functionality.
Solution
This PR modifies the v2 "balance-shard-unique" API to be more REST-ful: changing the path, and removing the "command-specifier" from the request body. With these changes the functionality can now be invoked as:
To facilitate this change, this PR also migrates the v2 API definition to the JAX-RS framework.
Tests
New unit tests in BalanceShardUniqueAPITest. Existing tests continue to pass.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.