[SOLR-11646] Ref Guide: Update API examples to include v2 style examples

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: documentation, v2 API
• Labels: V2
• Assignee: Cassandra Targett
• Reporter: Cassandra Targett
• Created: 15/Nov/17 21:10
• Updated: 1 week ago 11:57

Description

The Ref Guide currently only has a single page with what might be generously called an overview of the v2 API added in 6.5 (https://lucene.apache.org/solr/guide/v2-api.html) but most of the actual APIs that support the v2 approach do not show an example of using it with the v2 style. A few v2-style APIs are already used as examples, but there's nothing consistent.

With this issue I'll add API input/output examples throughout the Guide. Just in terms of process, my intention is to have a series of commits to the pages as I work through them so we make incremental progress. I'll start by adding a list of pages/APIs to this issue so the scope of the work is clear.

Once this is done we can figure out what to do with the V2 API page itself - perhaps it gets archived and replaced with another page that describes Solr's APIs overall; perhaps by then we figure out something else to do with it.

Issue Links

• depends upon: SOLR-15162 V2 Collections API should support same parameters as V1
• is a child of: SOLR-15734 Prepare v2 API for v1 deprecation, eventual removal
• is related to: SOLR-15174 v2 modify collection doesn't allow you to change the configset used.
• relates to: SOLR-15372 When you run techproducts example, you can't create more cores.
• links to: GitHub Pull Request #32
• links to: GitHub Pull Request #41
• links to: GitHub Pull Request #91
• links to: GitHub Pull Request #2401