[SOLR-15781] Make v2 APIs more REST-ful and migrate to JAX-RS

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: v2 API
• Labels: V2
• Assignee: Unassigned
• Reporter: Jason Gerlowski
• Created: 09/Nov/21 15:07
• Updated: 30/Jan/24 21:00

Description

While the v2 API is in many ways an improvement over v1 in terms of readability and API best practices, it still has a lot of room for improvement.  The recent "experimental" designation for v2 opens the door to pursuing many of these improvements. 

This ticket is intended as an umbrella to track resolution of some of the known warts in the current v2 API and some of the improvements that can be made in terms of being more RESTful, etc.

While we're touching the API code for these endpoints, it makes sense to convert them to JAX-RS as well. This JAX-RS migration work was initially covered in a separate ticket (see SOLR-16370), but the changes required ended up overlapping with the "cosmetic-improvement" effort here so significantly that it made sense to track them together.

Issue Links

• is a child of: SOLR-15734 Prepare v2 API for v1 deprecation, eventual removal
• is a parent of: SOLR-15823 Split v2 /node/logging API into separate GET and PUT APIs
• is a parent of: SOLR-15312 v2 api: core creation, config vs configSet params
• is a parent of: SOLR-15542 Combine 'node', 'createNodeSet' parameters for ADDREPLICA API
• is a parent of: SOLR-15796 Add Better Enum support for @JsonProperty annotations
• is a parent of: SOLR-15619 add Long support for @JsonProperty annotations
• is duplicated by: SOLR-16370 Migrate v2 APIs to JAX-RS framework
• links to: GitHub Pull Request #2219

Sub-Tasks

• Cosmetic improvements and migration to JAX-RS (v2 cluster and clusterprop APIs): Open
• Cosmetic improvements and migration to JAX-RS (collection, collection prop, core CRUD APIs): Open
• Cosmetic improvements and migration to JAX-RS (shard, replica, and replicaprop CRUD APIs): Closed
• Cosmetic improvements and migration to JAX-RS (alias, alias-prop CRUD APIs): Closed
• Cosmetic improvements and migration to JAX-RS (snapshot, backup APIs): Closed
• Cosmetic improvements and migration to JAX-RS (schema APIs): Open
• Cosmetic improvements and migration to JAX-RS (config, configset APIs): Open
• Cosmetic improvements and migration to JAX-RS ("core" APIs): Open
• Cosmetic improvements and migration to JAX-RS (miscellaneous coll/core APIs): Open
• Cosmetic improvements and migration to JAX-RS ("node" APIs): Open
• Add v2 API support to AdminHandlersProxy: Open