[
https://issues.apache.org/jira/browse/SOLR-16458?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17623508#comment-17623508
]
Jason Gerlowski edited comment on SOLR-16458 at 3/17/23 12:39 PM:
------------------------------------------------------------------
To be a little more explicit about the APIs we want this ticket to cover, I
found 6 APIs that perform operations on individual nodes:
(*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|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617806&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617806]
and
[here|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617923&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617923]
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|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17565076&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17565076],
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 6 APIs that perform operations on individual nodes:
* List Log Levels
** Current Form: GET /api/node/logging
** Desired Form: GET /api/node/logging/levels
** Spreadsheet Ref: Tab 1, Line 73
* Update Log Levels
** Current Form: GET /api/node/logging?set=className:WARN
** Desired Form: PUT /api/node/logging/levels \{"className": "WARN"\}
** Spreadsheet Ref: Tab 1, Line 75
* Retrieve Log Messages
** Current Form: GET /api/node/logging?since=123456789
** Desired Form: GET /api/node/logging/messages?since=123456789
** Spreadsheet Ref: Tab 1, Line 76
* Add Role to Node
** Current Form: POST /api/cluster \{"add-role": \{...\}\}
** Desired Form: PUT /api/nodes/nodeName/roles/roleName
** Spreadsheet Ref: Tab 1, Line 79
* Remove Role from Node
** Current Form: POST /api/cluster \{"remove-role": \{...\}\}
** Desired Form: DELETE /api/nodes/nodeName/roles/roleName
** Spreadsheet Ref: Tab 1, Line 80
* List Threads on Node
** Current Form: GET /v2/node/threads
** Desired Form: GET /api/node/threads
** Spreadsheet Ref: Tab 7, Line 24
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|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617806&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617806]
and
[here|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617923&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617923]
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|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17565076&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17565076],
and an example PR can be found [here|https://github.com/apache/solr/pull/1061].
> Cosmetic improvements and migration to JAX-RS ("node" APIs)
> -----------------------------------------------------------
>
> Key: SOLR-16458
> URL: https://issues.apache.org/jira/browse/SOLR-16458
> Project: Solr
> Issue Type: Sub-task
> Components: v2 API
> Affects Versions: 9.1, main (10.0)
> Reporter: Jason Gerlowski
> Priority: Major
> Labels: newdev
> Time Spent: 20m
> Remaining Estimate: 0h
>
> 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 "node"
> APIs: those commands or actions that (primarily) affect the receiving node
> only such as log-level changes, setting and removing node roles, etc. These
> are described in detail in the spreadsheet linked above, but summarized in
> the table below for convenience and ease of tracking.
> *Cosmetic Changes and JAX-RS Conversion*
> ||API Name||Original Form||Desired Form||Status||Volunteer||
> |List Log Levels|GET /api/node/logging|GET /api/node/logging/levels|Open|N/A|
> |Update Log Level|GET /api/node/logging?set=className:WARN|PUT
> /api/node/logging/levels \{"className": "WARN"\}|Open|N/A|
> |Retrieve Log Messages|GET /api/node/logging?since=123456789|GET
> /api/node/logging/messages?since=123456789|Open|N/A|
> |Add Role to Node|POST /api/cluster \{"add-role": \{...\}\}|PUT
> /api/nodes/nodeName/roles/roleName|Open|N/A|
> |Remove Role from Node|POST /api/cluster \{"remove-role": \{...\}\}|DELETE
> /api/nodes/nodeName/roles/roleName|Open|N/A|
> *JAX-RS Conversion Only*
> ||API Name||Endpoint||Status||Volunteer||
> |List Threads on Node|GET /api/node/threads|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
