Details
-
Sub-task
-
Status: Open
-
Major
-
Resolution: Unresolved
-
main (10.0)
-
None
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.
This ticket plans to tackle making the changes required for Solr's "Cluster" and "cluster-prop" APIs. These APIs are described in detail in the spreadsheet linked above, but are summarized in the table below for convenience and easier tracking.
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.)
Cosmetic Changes and JAX-RS Conversion
| API Name | Original Form | Desired Form | Status | Volunteer |
|---|---|---|---|---|
| Upsert ClusterProp | POST /api/cluster {"set-property": {...}} | PUT /api/cluster/properties/propName {"value": "propVal"} | Open | N/A |
| Upsert ClusterProp (Potentially Nested) | POST /api/cluster {"set-obj-property": {...}} | PUT /api/cluster/properties {...} | Open | N/A |
| Delete ClusterProp | POST /api/cluster {"set-property": {"name": "foo", "value": ""}} | DELETE /api/cluster/properties/propName | Open | N/A |
| Delete Single Async Status | DELETE /api/cluster/command-status/123 | DELETE /api/cluster/commands/123 | Open | N/A |
| Delete All Async Status | DELETE /api/cluster/command-status | DELETE /api/cluster/commands | Open | N/A |
| Get Single Async Status | GET /api/cluster/command-status/123 | GET /api/cluster/commands/123 | Open | N/A |
| Create rate-limiter | POST /api/cluster/ {"set-ratelimiter": {...}} | POST /api/cluster/ratelimiter {...} | Open | N/A |
Attachments
Issue Links
- is duplicated by
-
-
- Resolved
-
- links to
