[
https://issues.apache.org/jira/browse/SOLR-16394?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jason Gerlowski updated SOLR-16394:
-----------------------------------
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|https://docs.google.com/spreadsheets/d/1HAoBBFPpSiT8mJmgNZKkZAPwfCfPvlc08m5jz3fQBpA/edit?usp=sharing],
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/collections/backups/backupName/versions?location=asdf|Open|N/A|
|Create Backup|POST /api/collections \{backup-collection: \{...\}\}|POST
/api/collections/backups/backupName/versions \{...\}|Open|N/A|
|Delete Backup (by ID)|POST /api/collections/backups \{delete-backups:
\{...\}\}|DELETE
/api/collections/backups/backupName/versions123?location=asdf|Open|N/A|
|Delete All Backups (Except Most Recent 'N')|POST /api/collections/backups
\{delete-backups: \{...\}\}|DELETE
/api/collections/backups/backupName/versions?maxUnused=7&...|Open|N/A|
|Garbage Collect Unused Backup Files|POST /api/collections/backups
\{delete-backups: \{...\}\}|DELETE
/api/collections/backups/backupName/versions?purgeUnused=true&...|Open|N/A|
|Restore Collection Backup|POST /api/collections \{restore-collection:
\{...\}\}|POST /api/collections/backups/backupName/restore|Open|N/A|
was:
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|https://docs.google.com/spreadsheets/d/1HAoBBFPpSiT8mJmgNZKkZAPwfCfPvlc08m5jz3fQBpA/edit?usp=sharing],
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.
> Cosmetic improvements and migration to JAX-RS (snapshot, backup APIs)
> ---------------------------------------------------------------------
>
> Key: SOLR-16394
> URL: https://issues.apache.org/jira/browse/SOLR-16394
> Project: Solr
> Issue Type: Sub-task
> Components: v2 API
> Affects Versions: main (10.0)
> Reporter: Jason Gerlowski
> Priority: Major
> Labels: newdev
>
> 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|https://docs.google.com/spreadsheets/d/1HAoBBFPpSiT8mJmgNZKkZAPwfCfPvlc08m5jz3fQBpA/edit?usp=sharing],
> 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/collections/backups/backupName/versions?location=asdf|Open|N/A|
> |Create Backup|POST /api/collections \{backup-collection: \{...\}\}|POST
> /api/collections/backups/backupName/versions \{...\}|Open|N/A|
> |Delete Backup (by ID)|POST /api/collections/backups \{delete-backups:
> \{...\}\}|DELETE
> /api/collections/backups/backupName/versions123?location=asdf|Open|N/A|
> |Delete All Backups (Except Most Recent 'N')|POST /api/collections/backups
> \{delete-backups: \{...\}\}|DELETE
> /api/collections/backups/backupName/versions?maxUnused=7&...|Open|N/A|
> |Garbage Collect Unused Backup Files|POST /api/collections/backups
> \{delete-backups: \{...\}\}|DELETE
> /api/collections/backups/backupName/versions?purgeUnused=true&...|Open|N/A|
> |Restore Collection Backup|POST /api/collections \{restore-collection:
> \{...\}\}|POST /api/collections/backups/backupName/restore|Open|N/A|
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
