[SOLR-16370] Migrate v2 APIs to JAX-RS framework

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Duplicate
• Affects Version/s: main (10.0)
• Component/s: v2 API
• Assignee: Jason Gerlowski
• Reporter: Jason Gerlowski
• Created: 02/Sep/22 09:25
• Updated: 10/Mar/23 15:24
• Resolved: 10/Mar/23 15:24

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.

Issue Links

• duplicates: SOLR-15781 Make v2 APIs more REST-ful and migrate to JAX-RS
• is a child of: SOLR-15734 Prepare v2 API for v1 deprecation, eventual removal

Sub-Tasks

• Convert v2 "Cluster", "ClusterProp", and "Node Role" APIs to JAX-RS: Resolved
• Convert v2 "Collection" and "CollectionProp" APIs to JAX-RS: Resolved
• Convert v2 "Shard", "Replica", and "ReplicaProp" APIs to JAX-RS: Resolved
• Convert v2 "Alias" and "AliasProp" APIs to JAX-RS: Resolved
• Convert v2 "snapshot", "backup", and "restore" APIs to JAX-RS: Resolved
• Convert v2 "Schema" APIs to JAX-RS: Resolved
• Convert v2 "Config" and "Configset" APIs to JAX-RS: Resolved
• Convert v2 per-core APIs to JAX-RS: Resolved
• Convert v2 Miscellaneous Coll/Core APIs to JAX-RS: Resolved