SOLR-12224: Add APIs to read collection properties #4071
Merged
+227
−16
Conversation
This file contains hidden or 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
API is available at: `GET /api/collections/collName/properties`
API available at: `GET /api/collections/collName/properties/propName`
github-actions
bot
added
documentation
gerlowskija
changed the title
epugh
approved these changes
Jan 22, 2026
Contributor
epugh
left a comment
epugh
left a comment
There was a problem hiding this comment.
I did a quick skim and it looks good. Also just a nice PR to read, and maybe model other adding of APIs on!
HoustonPutman
approved these changes
Jan 22, 2026
Contributor
HoustonPutman
left a comment
HoustonPutman
left a comment
There was a problem hiding this comment.
Perfect PR. No notes
Contributor
|
Might be good to have an API to update more than one value at once, but it doesn't have to be done here. |
Contributor
Author
|
Thanks all for the review! |
gerlowskija
added a commit
that referenced
this pull request
Jan 26, 2026
Prior to this PR Solr allowed users to write collection properties but never read them. This commit adds two new APIs to serve this need: the first for listing all properties (`GET /api/collections/someCollName/properties`) and the second for fetching a single property by name (`GET /api/collections/someCollName/properties/somePropName`). Corresponding SolrJ "SolrRequest" and "SolrResponse" classes are also generated based on the OAS definition for these new APIs.
gerlowskija
added a commit
that referenced
this pull request
Jan 26, 2026
Prior to this PR Solr allowed users to write collection properties but never read them. This commit adds two new APIs to serve this need: the first for listing all properties (`GET /api/collections/someCollName/properties`) and the second for fetching a single property by name (`GET /api/collections/someCollName/properties/somePropName`). Corresponding SolrJ "SolrRequest" and "SolrResponse" classes are also generated based on the OAS definition for these new APIs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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-12224
Description
Solr allows users to create collectionproperties with its
/admin/collections?action=COLLECTIONPROPAPI, but doesn't offer any API-based way to read these properties. Users are forced to use SolrJ's ZkStateReader to lookup the collection-properties, or connect to Zookeeper in some other way to read them.Solution
This PR introduces two new v2 endpoints that give users an API-centric way of reading these properties:
GET /api/collections/someCollName/propertiesto list all properties of a collection, andGET /api/collections/someCollName/properties/somePropNameto fetch specific properties by name.These new v2 APIs are implemented via JAX-RS, and appear in Solr's OpenAPI, meaning that they're now included in our SolrJ generation. SolrJ users can call these APIs with the SolrRequest classes
CollectionPropertiesApi.ListCollectionPropertiesandCollectionPropertiesApi.GetCollectionProperty.Tests
Added coverage for new "read" APIs in CollectionsAPISolrJTest, using the generated SolrRequest classes.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.