SOLR-18212: Migrate PackageAPI endpoints from @EndPoint/@Command to JAX-RS by epugh · Pull Request #4178 · apache/solr

epugh · 2026-03-02T19:31:31Z

Migrates org.apache.solr.pkg.PackageAPI from Solr's homegrown @EndPoint/@Command dispatch to standard JAX-RS annotations, consistent with other V2 APIs (ClusterFileStore, ZookeeperRead, ClusterProperty).

This has a pretty hefty update to the patterns, but I thought it was better to do it now while v2 api's are "experimental".

New REST endpoints

The command-based POST pattern is replaced with RESTful routes:

Old	New
`POST /cluster/package {"add": {"package":"p","version":"v","files":[...]}}`	`POST /cluster/package/{name}/versions`
`POST /cluster/package {"delete": {"pkg":"p","version":"v"}}`	`DELETE /cluster/package/{name}/versions/{version}`
`POST /cluster/package {"refresh": "name"}`	`POST /cluster/package/{name}/refresh`
`GET /cluster/package`	unchanged
`GET /cluster/package/{name}`	unchanged

Key structural changes

PackageAPI — new JAX-RS implementation (extends JerseyResource implements PackageApis); replaces the old Edit/Read inner classes (~220 lines removed)
PackageStore — renamed from the old PackageAPI; now clearly a ZK data/state holder (Packages, PkgVersion, ZK watcher), not an endpoint class. THIS WAS A BIG REFACTORING
solr/api module — new PackageApis.java (JAX-RS interface), PackagesResponse.java, AddPackageVersionRequestBody.java; OAS generation produces PackageApi SolrJ request classes automatically
PackageAPITest — integration test using SolrCloudTestCase (ZK required) with generated PackageApi SolrJ request classes
TestPackages — updated to use new endpoints; error path changed from /details[0]/errorMessages[0] to /msg
package-manager-internals.adoc — updated endpoint reference and curl examples

- Replace PackagePayload.AddVersion with AddPackageVersionRequestBody - Move package name from body to URL: POST /cluster/package/{name}/versions - Replace delete command pattern with DELETE /cluster/package/{name}/versions/{version} - Replace refresh command with POST /cluster/package/{name}/refresh - Update errPath in testAPI from /details[0]/errorMessages[0] to /msg - Remove all add.pkg assignments (pkg now lives in URL path) - Replace add.pkg references in verifyComponent() with literal package name strings - Update import: remove PackagePayload, add AddPackageVersionRequestBody (sorted) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: epugh <22395+epugh@users.noreply.github.com>

…sponse.error field Co-authored-by: epugh <22395+epugh@users.noreply.github.com>

Co-authored-by: epugh <22395+epugh@users.noreply.github.com>

… style

gerlowskija · 2026-04-03T19:45:12Z

Is there a JIRA ticket associated with this change @epugh?

epugh · 2026-04-03T20:33:51Z

Is there a JIRA ticket associated with this change @epugh?

No, because I viewed it as "just a refactoring and no one will notice....", and that I was hoping there were no debates that would require a JIRA to hash out!

gerlowskija · 2026-04-03T20:00:38Z

+authors:
+  - name: Eric Pugh
+links:
+- name: PR#4178


[0] Probably worth having a JIRA reference for this guy, even if it's just a tie-back to one of the v2 umbrella tickets? It's changing APIs and stuff, so worth tracking in more than just the PR description I'd imagine.

gerlowskija · 2026-04-06T14:35:54Z

-    public int hashCode() {
-      return Objects.hash(version);
-    }
+    final var request =


[Q] Is there a reason you're not using the auto-generated SolrJ type here? We should have one now that the API is JAX-RS!

If this was an intentional decision made to prevent scope-creep, I'm fine with that. Just making sure it's not oversight.

so many places to update... I suspect in the future we need to do a "Check each GSR for fitness" check ;-)

Like I said, I think not doing these bits in the same PR is a totally valid choice. I don't want to add extra steps that'd apply to all these PRs. But since the lines were changed in this PR already I wanted to check that it was an intentional choice is all 🤷

…kageapi-to-jax-rs

Rename PackageAPI to ClusterPackage to follow naming pattern of other V2 apis.

Add test, revamp description.

epugh · 2026-04-25T16:47:57Z

@gerlowskija I think I am ready for another review. I renamed PackageAPI to ClusterPackage to not conflict with PackageApis, but not married to that name! I am updating the spreadsheet.

github-actions · 2026-06-25T00:38:38Z

This PR has had no activity for 60 days and is now labeled as stale. Any new activity will remove the stale label. To attract more reviewers, please tag people who might be familiar with the code area and/or notify the dev@solr.apache.org mailing list. To exempt this PR from being marked as stale, make it a draft PR or add the label "exempt-stale". If left unattended, this PR will be closed after another 60 days of inactivity. Thank you for your contribution!

github-actions · 2026-08-25T00:08:45Z

This PR is now closed due to 60 days of inactivity after being marked as stale. Re-opening this PR is still possible, in which case it will be marked as active again.

gerlowskija

LGTM

epugh · 2026-08-28T13:37:32Z

@gerlowskija I reopened this, and will try and give it some love today.. Thanks for the LGTM....

…kageapi-to-jax-rs

…i/cluster/packages and errors.

epugh · 2026-08-28T18:55:32Z

@gerlowskija this is ready for review!!!!

epugh · 2026-08-28T19:38:10Z

Tests, both unit and itest (bats) pass...

jaykay12 · 2026-10-16T23:33:40Z

@epugh I am planning to review this PR, can you make this one ready for review by rebasing with latest main?

epugh · 2026-10-17T16:11:05Z

@jaykay12 I added you as a collaborate to my epugh/solr... which I think lets you push to this repo? I hope this makes it easier as I have a couple of in progress ones you may wan tot pick up!

Copilot AI and others added 8 commits March 1, 2026 13:42

Initial plan

a86cf71

Migrate PackageAPI from @EndPoint/@command to JAX-RS annotations

744e8ff

Co-authored-by: epugh <22395+epugh@users.noreply.github.com>

Fix PackageAPIJaxRsTest to use generated request classes and check re…

cc26412

…sponse.error field Co-authored-by: epugh <22395+epugh@users.noreply.github.com>

Extract magic numbers as named constants in PackageAPIJaxRs

5040f5b

Co-authored-by: epugh <22395+epugh@users.noreply.github.com>

Rename PackageAPIJaxRs to PackageAPI and old PackageAPI to PackageStore

83c2f5c

Co-authored-by: epugh <22395+epugh@users.noreply.github.com>

Additional migrations from the old "command" style to the new RESTful…

d71f199

… style

fix test

8994e03

github-actions Bot added documentation Improvements or additions to documentation tests cat:search cat:api cat:packagemanager labels Mar 2, 2026

epugh marked this pull request as ready for review March 2, 2026 19:36

doc change

199b0f3

gerlowskija reviewed Apr 6, 2026

View reviewed changes

epugh added 8 commits April 25, 2026 07:12

Merge remote-tracking branch 'upstream/main' into copilot/migrate-pac…

463f590

…kageapi-to-jax-rs

Updates from merging in latest code from main.

ae94dd3

PackageAPI and PackageApis super confusing.

62212c3

Rename PackageAPI to ClusterPackage to follow naming pattern of other V2 apis.

Fix up expectedVersion property that was missing.

30ab7cc

Add test, revamp description.

Use our generated solrj code instead of hand crafting.

99d90e7

tidy

7967574

Small cleanups.

7491730

Now have a JIRA issue

deb2142

epugh changed the title ~~Migrate PackageAPI endpoints from @EndPoint/@Command to JAX-RS~~ SOLR-18212: Migrate PackageAPI endpoints from @EndPoint/@Command to JAX-RS Apr 25, 2026

epugh added 2 commits April 25, 2026 14:18

shockingly, we had these unused objects

2578d26

Don't need fancy instantiate method!

bf46dc7

epugh added 3 commits April 25, 2026 14:30

Use SolrJ methods where possible.

a0bef90

More conversion to SolrJ methods

ba61c1b

Rework the tests. I am a bit on the fence about detailed docs.

670562d

github-actions Bot added the stale PR not updated in 60 days label Jun 25, 2026

github-actions Bot added the closed-stale Closed after being stale for 60 days label Aug 25, 2026

github-actions Bot closed this Aug 25, 2026

gerlowskija reviewed Aug 28, 2026

View reviewed changes

epugh reopened this Aug 28, 2026

epugh removed stale PR not updated in 60 days closed-stale Closed after being stale for 60 days labels Aug 28, 2026

epugh added 3 commits August 28, 2026 14:18

Merge remote-tracking branch 'upstream/main' into copilot/migrate-pac…

702b181

…kageapi-to-jax-rs

Bring this API up to date, following our conventions. Better path /ap…

1cfc294

…i/cluster/packages and errors.

add jira

b51a155

epugh requested a review from gerlowskija August 28, 2026 18:55

tidy

742b0ba

jaykay12 added 2 commits October 20, 2026 02:51

Merge branch 'main' into copilot/migrate-packageapi-to-jax-rs

59c1c26

precommit works now

47fd06e

github-actions Bot added the cat:cli label Oct 19, 2026

Conversation

epugh commented Mar 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New REST endpoints

Key structural changes

Uh oh!

gerlowskija commented Apr 3, 2026

Uh oh!

epugh commented Apr 3, 2026

Uh oh!

Uh oh!

gerlowskija Apr 3, 2026

Choose a reason for hiding this comment

Uh oh!

epugh Apr 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gerlowskija Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

epugh Apr 25, 2026

Choose a reason for hiding this comment

Uh oh!

gerlowskija Aug 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

epugh commented Apr 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 25, 2026

Uh oh!

github-actions Bot commented Aug 25, 2026

Uh oh!

gerlowskija left a comment

Choose a reason for hiding this comment

Uh oh!

epugh commented Aug 28, 2026

Uh oh!

epugh commented Aug 28, 2026

Uh oh!

epugh commented Aug 28, 2026

Uh oh!

jaykay12 commented Oct 16, 2026

Uh oh!

epugh commented Oct 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

epugh commented Mar 2, 2026 •

edited

Loading

epugh commented Apr 25, 2026 •

edited

Loading