[ https://issues.apache.org/jira/browse/SOLR-15781?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17812476#comment-17812476 ]
ASF subversion and git services commented on SOLR-15781: -------------------------------------------------------- Commit 0830423afd7d29ce2b8f18643b7fd660ce8dc08e in solr's branch refs/heads/jira/SOLR-16858 from Jason Gerlowski [ https://gitbox.apache.org/repos/asf?p=solr.git;h=0830423afd7 ] SOLR-15781: Document v2 API syntax conventions (#2219) Currently, decisions around what our v2 API should look like are scattered across a large number of JIRA tickets, PR reviews, and spreadsheets. There's no one place giving an overview of the desired syntax (beyond perhaps the general guidance in SIP-16 to move towards "REST" where possible). This commit attempts to address this by introducing docs describing some of the conventions used in our v2 API. Room for improvement remains: parameters conventions remain a big gap, as does sourcing to the original rationale behind many of these decisions. But this commit provides a place to build off of, at the least. > Make v2 APIs more REST-ful and migrate to JAX-RS > ------------------------------------------------ > > Key: SOLR-15781 > URL: https://issues.apache.org/jira/browse/SOLR-15781 > Project: Solr > Issue Type: Improvement > Components: v2 API > Reporter: Jason Gerlowski > Priority: Major > Labels: V2 > Time Spent: 1h > Remaining Estimate: 0h > > 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. -- This message was sent by Atlassian Jira (v8.20.10#820010) --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org