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/10 14:41:00 UTC

[jira] [Commented] (SOLR-16370) Migrate v2 APIs to JAX-RS framework

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

Jason Gerlowski commented on SOLR-16370:
----------------------------------------

While conceptually distinct, the migration of APIs to the JAX-RS framework covered by this ticket and the "cosmetic API improvements" detailed in SOLR-15781 and its children involve touching identical chunks of code.  In practice, it's proven convenient and easy to handle both tasks together within the same PRs.

To better reflect this reality I'm going to reword SOLR-15781 to include the JAX-RS conversion work, and close out this tree of tickets as duplicates of those.  Should simplify tracking the v2 work nicely and bring it in line with the reality "on the ground".

> Migrate v2 APIs to JAX-RS framework
> -----------------------------------
>
>                 Key: SOLR-16370
>                 URL: https://issues.apache.org/jira/browse/SOLR-16370
>             Project: Solr
>          Issue Type: Improvement
>          Components: v2 API
>    Affects Versions: main (10.0)
>            Reporter: Jason Gerlowski
>            Assignee: Jason Gerlowski
>            Priority: Major
>
> Now that a basic JAX-RS framework has been added (see SOLR-16347), we can start migrating our v2 API definitions in that direction. Of course, this will entail a lot of work, but it brings several distinct advantages:
>  * JAX-RS API definitions describe inputs and outputs more explicitly than our current framework, hopefully leading to more readable, maintainable code.
>  * Moving API logic from existing RequestHandlers to the v2 definition (which JAX-RS is a large part of) will ensure that our v2 definitions don't "fall behind" our v1 code. (i.e. JAX-RS mostly solves SOLR-15736)
>  * JAX-RS API definitions are compatible out-of-the-box with most OpenAPI tooling (see SOLR-16346). The more APIs we move to JAX-RS, the easier it'll be to start using OpenAPI to generate clients, etc. down the road.
> This ticket aims to serve as an umbrella, with a number of subtasks covering logical "chunks" of our v2 API surface.



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