You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Cassandra Targett (JIRA)" <ji...@apache.org> on 2017/11/15 21:48:00 UTC

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

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

Cassandra Targett commented on SOLR-11646:
------------------------------------------

Caveats:
* Not a perfect list - possibly/likely missing some
* Not de-duplicated (but sorted at least)

|| Page || Old API endpoint ||
|adding-custom-plugins-in-solrcloud-mode.adoc | /.system/blob |
|adding-custom-plugins-in-solrcloud-mode.adoc | /<collection>/config |
|basic-authentication-plugin.adoc | /admin/authentication |
|blob-store-api.adoc | /.system/blob |
|blob-store-api.adoc | /admin/collections |
|collections-api.adoc | /admin/collections |
|collections-core-admin.adoc | /admin/collections |
|config-api.adoc | /<collection>/config |
|config-sets.adoc | /admin/cores |
|configsets-api.adoc | /admin/configs |
|configuring-logging.adoc | /admin/info/* |
|configuring-solrconfig-xml.adoc | /admin/collections |
|content-streams.adoc | /<collection>/config |
|coreadmin-api.adoc | /admin/cores |
|enabling-ssl.adoc | /admin/collections |
|filter-descriptions.adoc | /<collection>/schema |
|getting-started-with-solrcloud.adoc | /<collection>/config |
|implicit-requesthandlers.adoc | /<collection>/config |
|learning-to-rank.adoc | /<collection>/schema |
|major-changes-in-solr-7.adoc | /<collection>/config |
|making-and-restoring-backups.adoc | /admin/cores |
|managed-resources.adoc | /<collection>/schema |
|other-parsers.adoc | /<collection>/update |
|realtime-get.adoc  | /<collection>/get or /<core>/get |
|request-parameters-api.adoc | /<collection>/config |
|requestdispatcher-in-solrconfig.adoc | /<collection>/config |
|rule-based-authorization-plugin.adoc | /admin/authorization |
|rule-based-authorization-plugin.adoc | /admin/collections |
|running-solr-on-hdfs.adoc | /admin/collections |
|schema-api.adoc | /<collection>/schema |
|schemaless-mode.adoc | /<collection>/config |
|schemaless-mode.adoc | /<collection>/schema |
|schemaless-mode.adoc | /<collection>/update |
|solr-tutorial.adoc | /<collection>/config |
|solr-tutorial.adoc | /<collection>/schema |
|solr-tutorial.adoc | /admin/collections |
|solrcloud-autoscaling-api.adoc | /autoscaling/* |
|solrcloud-autoscaling-auto-add-replicas.adoc | /admin/collections |
|solrcloud-autoscaling-fault-tolerance.adoc | /autoscaling/* |
|solrcloud-autoscaling-overview.adoc | /admin/collections |
|solrcloud-autoscaling-overview.adoc | /autoscaling/* |
|transforming-and-indexing-custom-json.adoc | /<collection>/config |
|updating-parts-of-documents.adoc | /<collection>/update |
|uploading-data-with-index-handlers.adoc | /<collection>/update |


> 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
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation, v2 API
>            Reporter: Cassandra Targett
>            Assignee: Cassandra Targett
>
> 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
(v6.4.14#64029)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org