Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-16370

Migrate v2 APIs to JAX-RS framework

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • main (10.0)
    • None
    • v2 API
    • None

    Description

      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.

      Attachments

        Issue Links

          Activity

            People

              gerlowskija Jason Gerlowski
              gerlowskija Jason Gerlowski
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: