[jira] [Commented] (SOLR-11646) Ref Guide: Update API examples to include v2 style examples

["ASF subversion and git services (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SOLR-11646?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17304853#comment-17304853 ] 

ASF subversion and git services commented on SOLR-11646:
--------------------------------------------------------

Commit 7e827a88dd832e3370678e6eff14f54a5ebe4cd6 in solr's branch refs/heads/main from Eric Pugh
[ https://gitbox.apache.org/repos/asf?p=solr.git;h=7e827a8 ]

SOLR-11646: Add v2 examples for collections API (#32)

* V2 API examples added to CREATE, RELOAD, and MODIFYCOLLECTION, LIST, RENAME, DELETE, and COLLECTIONPROP, REINDEXCOLLECTION, COLSTATUS, REBALANCE, CLUSTERSTATUS, CLUSTERPROP, BALANCEUNIQUESHARD, SETOBJPROPERTY, DELETENODE, ADDROLE, REMOVEROLE, OVERSEERSTATUS

* Use consistent style for formatting curl command, though slightly different than other parts of ref guide.

* Use same "example" for both v1 and v2, and try and be consistent throughout.

> Ref Guide: Update API examples to include v2 style examples
> -----------------------------------------------------------
>
>                 Key: SOLR-11646
>                 URL: https://issues.apache.org/jira/browse/SOLR-11646
>             Project: Solr
>          Issue Type: Improvement
>          Components: documentation, v2 API
>            Reporter: Cassandra Targett
>            Assignee: Cassandra Targett
>            Priority: Major
>          Time Spent: 3.5h
>  Remaining Estimate: 0h
>
> 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.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)