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

Prepare v2 API for v1 deprecation, eventual removal

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • v2 API

    Description

      Solr's v2 API has seen noticable progress in the past 6 months both in the code and docs. With 9.0 looming there's been some interest in getting the v2 API in good enough shape to finally deprecate Solr's v1 API.

      Before this can happen though, there's still a good chunk of work needed to bring the v2 APIs up to parity with v1: both in terms of coverage and stability/reliability. This ticket aims to map out those remaining pieces to better track our progress and eventually make v1 deprecation and removal possible. (A request for this sortof a roadmap came up in the recent "Solr 9.0 release blockers" dev@ thread.)

      There's likely to be some debate on what's really needed to get the v2 APIs ready for prime time, and that's totally fine. As a seed for this discussion I'm populating this epic with the sub-tasks that seem required to me. For the most part these fall into a few high-level categories:

      • server-side parity: the v2 API should expose the same set of functionality as v1, both in terms of endpoints and individual parameters
      • client (SolrJ) parity: SolrJ request objects should be able to send V2 requests across the board (and perhaps do so by default). Various routing and other optimizations built into SolrClient implementations should apply equally to V1 and V2 requests.
      • docs/ref-guide parity: Solr documentation should be updated to use the v2 API where-ever possible.
      • stability, trust, and dogfooding: It's difficult to recommend v2 to users when we aren't using it ourselves: Solr's tests should randomize between v1 and v2 API calls, v2 should be used by Solr-owned clients (e.g. Admin UI, bin/solr)

      Attachments

        Issue Links

          fixes

          Bug - A problem which impairs or prevents the functions of the product. SOLR-12224 there is no API to read collection properties

          • Major - Major loss of function.
          • Open
          is a parent of

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-11646 Ref Guide: Update API examples to include v2 style examples

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-15735 SolrJ should fully support Solr's v2 API

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-15737 Ensure all (desired) v1 APIs have v2 equivalent

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-15752 Switch Admin UI to use v2 API

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-15781 Make v2 APIs more REST-ful and migrate to JAX-RS

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-16380 Add OpenAPI decoration to v2 APIs

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-15736 Enforce ongoing v1<->v2 API consistency

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-16370 Migrate v2 APIs to JAX-RS framework

          • Major - Major loss of function.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-15182 Rewrite V2 APIs using annotation framework

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-15753 v2 calls should log params similar to current HttpSolrCall

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-16840 Fix overly verbose v2 API console logging

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SOLR-16847 Give v2 APIs access to solrconfig.xml config

          • Major - Major loss of function.
          • Closed

          Task - A task that needs to be done. SOLR-15780 Document v2 API as experimental

          • Major - Major loss of function.
          • Resolved
          links to

          Web Link GitHub Pull Request #1876

          Activity

            People

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

              Dates

                Created:
                Updated:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 40m
                  40m