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/06/26 16:46:00 UTC

[jira] [Updated] (SOLR-16397) Cosmetic improvements and migration to JAX-RS ("core" APIs)

     [ https://issues.apache.org/jira/browse/SOLR-16397?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jason Gerlowski updated SOLR-16397:
-----------------------------------
    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 "core" APIs, as described in the spreadsheet above.  ("Core" is a pretty bad descriptor but I'm not sure what name to attach to this group.  I have in my head all of the Solr core/collection APIs that involve adding or operating on documents, e.g. {{/select}}, {{/update}}, {{/tag}}, etc.)

Some helpful links related to these changes these changes. Should help get any interested newcomers started! 

* For detailed information on Solr's current and desired v2 APIs see the spreadsheet [here|https://docs.google.com/spreadsheets/d/1HAoBBFPpSiT8mJmgNZKkZAPwfCfPvlc08m5jz3fQBpA/edit?usp=sharing]
* [Discussion of how APIs work in Solr (video)|https://www.youtube.com/watch?v=iIpvfXBjDog]
* [Step-by-step guide to creating APIs|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617923&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617923] using the JAX-RS v2 API framework
* [Example PR for a similar change|https://github.com/apache/solr/pull/1679]

  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 "core" APIs, as described in the spreadsheet above.  ("Core" is a pretty bad descriptor but I'm not sure what name to attach to this group.  I have in my head all of the Solr core/collection APIs that involve adding or operating on documents, e.g. {{/select}}, {{/update}}, {{/tag}}, etc.)


> Cosmetic improvements and migration to JAX-RS ("core" APIs)
> -----------------------------------------------------------
>
>                 Key: SOLR-16397
>                 URL: https://issues.apache.org/jira/browse/SOLR-16397
>             Project: Solr
>          Issue Type: Sub-task
>          Components: v2 API
>    Affects Versions: main (10.0)
>            Reporter: Jason Gerlowski
>            Priority: Major
>          Time Spent: 40m
>  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 "core" APIs, as described in the spreadsheet above.  ("Core" is a pretty bad descriptor but I'm not sure what name to attach to this group.  I have in my head all of the Solr core/collection APIs that involve adding or operating on documents, e.g. {{/select}}, {{/update}}, {{/tag}}, etc.)
> Some helpful links related to these changes these changes. Should help get any interested newcomers started! 
> * For detailed information on Solr's current and desired v2 APIs see the spreadsheet [here|https://docs.google.com/spreadsheets/d/1HAoBBFPpSiT8mJmgNZKkZAPwfCfPvlc08m5jz3fQBpA/edit?usp=sharing]
> * [Discussion of how APIs work in Solr (video)|https://www.youtube.com/watch?v=iIpvfXBjDog]
> * [Step-by-step guide to creating APIs|https://issues.apache.org/jira/browse/SOLR-15737?focusedCommentId=17617923&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-17617923] using the JAX-RS v2 API framework
> * [Example PR for a similar change|https://github.com/apache/solr/pull/1679]



--
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