[ 
https://issues.apache.org/jira/browse/SOLR-17302?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17850128#comment-17850128
 ] 

ASF subversion and git services commented on SOLR-17302:
--------------------------------------------------------

Commit 8c5ae1bb745869ebd6fab5911b3dd0fd75ed9106 in solr's branch 
refs/heads/main from Jason Gerlowski
[ https://gitbox.apache.org/repos/asf?p=solr.git;h=8c5ae1bb745 ]

SOLR-17302: Convert /cluster filestore APIs to JAX-RS (#2470)

This commit moves some of Solr's "filestore" APIs (those located under
the `/api/cluster/files` path) to JAX-RS.

> Migrate filestore APIs to JAX-RS
> --------------------------------
>
>                 Key: SOLR-17302
>                 URL: https://issues.apache.org/jira/browse/SOLR-17302
>             Project: Solr
>          Issue Type: Sub-task
>          Components: v2 API
>            Reporter: Jason Gerlowski
>            Priority: Major
>              Labels: newdev
>          Time Spent: 3h
>  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 
> "filestore" APIs.  Most of these APIs are fine cosmetically as-is, though 
> this might be a good opportunity to iron out a few warts (particularly in how 
> the "/api/node" and "/api/cluster" paths are used inconsistently, unless 
> there's a rationale there that I'm missing...)
> *Cosmetic Changes and JAX-RS Conversion*
> ||API Name||Original Form||Desired Form||Status||Volunteer||
> |Upload File|PUT /api/cluster/files/foo.txt|PUT 
> /api/cluster/files/foo.txt|Open|N/A|
> |Delete File|DELETE /api/cluster/files/foo.txt|DELETE 
> /api/cluster/files/foo.txt|Open|N/A|
> |Delete File (Local)|DELETE /api/note/files/foo.txt|???|Open|N/A|
> |Fetch File|GET /api/note/files/foo.txt|GET /api/node/files/foo.txt|Open|N/A|
> |Fetch File Metadata|GET /api/note/files/foo.txt?meta=true|GET 
> /api/node/files/foo.txt?meta=true|Open|N/A|
> 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]
> * [Step by Step guide to creating 
> APIs|https://github.com/apache/solr/blob/main/dev-docs/apis.adoc#v2-apis]
> * [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-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org

Reply via email to