SOLR-16825: Migrate v2 API definitions to 'api' module, pt 8 #2833
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-16825 added a new gradle module, 'api', which holds v2 API definitions as interfaces. This allwos us to generate an OAS (and other artifacts) as a part of the solrj build. But these artifacts only cover the v2 APIs present in the 'api' module. This commit moves v2 API defining annotations to new interfaces in the 'api' module for several "schema" fetching and listing APIs.
gerlowskija
added a commit
that referenced
this pull request
Nov 12, 2024
SOLR-16825 added a new gradle module, 'api', which holds v2 API definitions as interfaces. This allows us to generate an OAS (and other artifacts) as a part of the solrj build. But these artifacts only cover the v2 APIs present in the 'api' module. This commit moves v2 API defining annotations to new interfaces in the 'api' module for several "schema", "replication", and "logging" APIs as well as 'create-alias'. This APIs are all now reflected in our OAS and generated artifacts.
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-16825
Description
SOLR-16825 added a new gradle module, 'api', which holds v2 API definitions as interfaces. This allows us to generate an OAS (and SolrRequest implementations from that) as a part of the solrj build.
But these artifacts (the OAS and generated Java code), only cover the v2 APIs that have interfaces in the 'api' module. We need to extract interfaces to live in 'api' for each v2 API in 'core' that doesn't already have one.
Solution
This PR creates 'api' interfaces for a number of v2 APIs, allowing them to be included in Solr's generated clients. The following APIs are covered in this PR:
Tests
PR is a refactor, so doesn't add any additional tests. But manual testing has been done to make sure the affected v2 APIs continue to work, and existing tests continue to pass.
Checklist
Please review the following and check all that apply:
mainbranch../gradlew check.