You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@solr.apache.org by "Jason Gerlowski (Jira)" <ji...@apache.org> on 2023/03/17 12:53:00 UTC
[jira] [Comment Edited] (SOLR-16390) Cosmetic improvements and migration to JAX-RS (v2 cluster and clusterprop APIs)
[ https://issues.apache.org/jira/browse/SOLR-16390?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17623166#comment-17623166 ]
Jason Gerlowski edited comment on SOLR-16390 at 3/17/23 12:52 PM:
------------------------------------------------------------------
To be a little more explicit about the APIs we want this ticket to cover, I found 8 APIs that are cluster/cluster-prop related:
(*EDIT*: List moved to table in issue description)
Obviously this is a big list. IMO it makes sense to split these up across different PRs, doing some small number (i.e. 1 or 2) of APIs per-PR. If anyone wants to help chip away at this, just call out which APIs from this list you intend to work on and we can parallelize them.
In terms of the steps required, the JIRA comments here and here give some good background and step-by-step instructions for switching APIs over to the new JAX-RS framework, which is usually helpful or even required as the traditional v2 framework doesn't lend itself very readily to RESTful APIs. (Those comments describe creating a new API "from scratch", but the steps are still applicable to modifying an existing API.) The PR [here|https://github.com/apache/solr/pull/1053] also serves as a helpful example to work from.
Not all API modifications require the new JAX-RS framework, though it is preferred going forward. Instructions for updating APIs using the older, traditional v2 framework can be found here, and an example PR can be found [here|https://github.com/apache/solr/pull/1061].
was (Author: gerlowskija):
To be a little more explicit about the APIs we want this ticket to cover, I found 8 APIs that are cluster/cluster-prop related:
* Create Cluster Prop
** Current Form: POST /api/cluster (w/ command "set-property")
** Desired Form: PUT /api/cluster/properties/propName \{"value": "propVal"\}
** Spreadsheet Ref: Tab 1, Line 13
* Update Single (Unnested) Cluster Prop
** Current Form: POST /api/cluster (w/ command "set-property")
** Desired Form: PUT /api/cluster/properties/propName \{"value": "propVal"\}
** Spreadsheet Ref: Tab 1, Line 15
* Update (Potentially Nested) Cluster Props (Bulk)
** Current Form: POST /api/cluster (w/ command "set-obj-property")
** Desired Form: PUT /api/cluster/properties \{...\}
** Spreadsheet Ref: Tab 1, Line 16
* Delete Cluster Prop
** Current Form: POST /api/cluster (w/ command "set-property" and a property value of empty-string)
** Desired Form: DELETE /api/cluster/properties/propName
** Spreadsheet Ref: Tab 1, Line 17
* Delete Single Async Status
** Current Form: DELETE /api/cluster/command-status/123
** Desired Form: DELETE /api/cluster/commands/123
** Spreadsheet Ref: Tab 7, Line 10
* Delete All Async Statuses
** Current Form: DELETE /api/cluster/command-status
** Desired Form: DELETE /api/cluster/commands
** Spreadsheet Ref: Tab 7, Line 11
* Get Async Command Status
** Current Form: GET /api/cluster/command-status/123
** Desired Form: GET /api/cluster/commands/123
** Spreadsheet Ref: Tab 7, Line 12
* Create rate-limiter
** Current Form: POST /api/cluster (w/ command "set-ratelimiter")
** Desired Form: POST /api/cluster/ratelimiter \{...\}
** Spreadsheet Ref: Tab 7, Line 35
Obviously this is a big list. IMO it makes sense to split these up across different PRs, doing some small number (i.e. 1 or 2) of APIs per-PR. If anyone wants to help chip away at this, just call out which APIs from this list you intend to work on and we can parallelize them.
In terms of the steps required, the JIRA comments here and here give some good background and step-by-step instructions for switching APIs over to the new JAX-RS framework, which is usually helpful or even required as the traditional v2 framework doesn't lend itself very readily to RESTful APIs. (Those comments describe creating a new API "from scratch", but the steps are still applicable to modifying an existing API.) The PR [here|https://github.com/apache/solr/pull/1053] also serves as a helpful example to work from.
Not all API modifications require the new JAX-RS framework, though it is preferred going forward. Instructions for updating APIs using the older, traditional v2 framework can be found here, and an example PR can be found [here|https://github.com/apache/solr/pull/1061].
> Cosmetic improvements and migration to JAX-RS (v2 cluster and clusterprop APIs)
> -------------------------------------------------------------------------------
>
> Key: SOLR-16390
> URL: https://issues.apache.org/jira/browse/SOLR-16390
> Project: Solr
> Issue Type: Sub-task
> Components: documentation, v2 API
> Affects Versions: main (10.0)
> Reporter: Jason Gerlowski
> Priority: Major
>
> 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.
> 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|
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org