[
https://issues.apache.org/jira/browse/SOLR-17302?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jason Gerlowski resolved SOLR-17302.
------------------------------------
Fix Version/s: 9.7
Assignee: Jason Gerlowski
Resolution: Fixed
I've spun out a separate ticket, SOLR-17351, to cover cosmetic changes to these
APIs, since they're arguably more subject to backcompat than our standard v2
API. (See SOLR-17351 for discussion).
With that work covered by another ticket, this one is ready to close out.
Thanks all for the review!
> 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
> Assignee: Jason Gerlowski
> Priority: Major
> Labels: newdev
> Fix For: 9.7
>
> Time Spent: 3h 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
> "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...)
> *JAX-RS Conversion*
> ||API Name||Form||Status||Volunteer||
> |-Upload File-|-PUT /api/cluster/files/foo.txt-|-Done-|-Jason-|
> |-Delete File-|-DELETE /api/cluster/files/foo.txt-|-Done-|-Jason-|
> |-Delete File (Local)-|-DELETE
> /api/cluster/files/foo.txt?localDelete=true-|-Done-|-Jason-|
> |-Fetch File-|-GET /api/note/files/foo.txt-|-Done-|-Jason-|
> |-Fetch File Metadata-|-GET /api/note/files/foo.txt?meta=true-|-Done-|-Jason-|
> 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
