[SOLR-16394] Cosmetic improvements and migration to JAX-RS (snapshot, backup APIs)

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: main (10.0)
• Fix Version/s: main (10.0), 9.3
• Component/s: v2 API
• Labels: newdev
• Assignee: Jason Gerlowski
• Reporter: Jason Gerlowski
• Created: 02/Sep/22 10:58
• Updated: 21/Jul/23 20:40
• Resolved: 25/May/23 11:55

Description

As mentioned on SOLR-15781, the v2 API currently has an experimental designation, and the community has expressed an interest in using this period to update our v2 endpoints to be more REST-ful and consistent.  The current plan is to follow the specific changes laid out in this spreadsheet, though of course nothing there is set in stone and there are still warts to be worked out.

While we're touching the code for these endpoints, we should also convert them to JAX-RS framework definitions. (This was initially tracked as a separate effort - see SOLR-16370 - but the edit that were required ended up overlapping so significantly with the "cosmetic" improvements here that in practice it almost always makes sense to do the two together.)

This ticket plans to tackle making the changes required for Solr's snapshot and backup APIs, as described in the spreadsheet linked above. For convenience and ease of tracking, these APIs are summarized in the table below:

API Name	Original Form	Desired Form	Status	Volunteer
List Backups	POST /api/collections/backups {list-backups: {...}}	GET /api/backups/backupName/versions?location=asdf	Finished	Jason
Create Backup	POST /api/collections {backup-collection: {...}}	POST /api/collections/collectionName/backups/backupName/versions {...}	Finished	Jason
Delete Backup (by ID)	POST /api/collections/backups {delete-backups: {...}}	DELETE /api/backups/backupName/versions/123?location=asdf	Finished	Jason
Delete All Backups (Except Most Recent 'N')	POST /api/collections/backups {delete-backups: {...}}	DELETE /api/backups/backupName/versions?maxUnused=7&...	Finished	Jason
Garbage Collect Unused Backup Files	POST /api/collections/backups {delete-backups: {...}}	DELETE /api/backups/backupName/versions?purgeUnused=true&...	Finished	Jason
Restore Collection Backup	POST /api/collections {restore-collection: {...}}	POST /api/backups/backupName/restore {...}	Finished	Jason

Issue Links

• is duplicated by: SOLR-16375 Convert v2 "snapshot", "backup", and "restore" APIs to JAX-RS
• links to: GitHub Pull Request #1541
• links to: GitHub Pull Request #1592
• links to: GitHub Pull Request #1639