gerlowskija opened a new pull request, #2219:
URL: https://github.com/apache/solr/pull/2219

   https://issues.apache.org/jira/browse/SOLR-XXXXX
   
   # Description
   
   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).
   
   # Solution
   
   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 PR provides a place to build off of moving forward.
   
   # Tests
   
   N/A - doc change only.
   
   # Checklist
   
   Please review the following and check all that apply:
   
   - [x] I have reviewed the guidelines for [How to 
Contribute](https://github.com/apache/solr/blob/main/CONTRIBUTING.md) and my 
code conforms to the standards described there to the best of my ability.
   - [x] I have created a Jira issue and added the issue ID to my pull request 
title.
   - [x] I have given Solr maintainers 
[access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
 to contribute to my PR branch. (optional but recommended)
   - [x] I have developed this patch against the `main` branch.
   - [ ] I have run `./gradlew check`.
   - [x] I have added documentation to the dev-docs.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org

Reply via email to