[
https://issues.apache.org/jira/browse/SOLR-11646?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16446261#comment-16446261
]
Cassandra Targett commented on SOLR-11646:
------------------------------------------
I've done another round of adding v2 examples:
|| Page || Old API endpoint ||
|blob-store-api.adoc | /.system/blob
|config-api.adoc | /<collection>/config |
|configuring-solrconfig-xml.adoc | /admin/collections |
|configsets-api.adoc | /admin/configs |
|implicit-requesthandlers.adoc | /<collection>/config |
Along the way, I made some extensive changes to a few of these pages as I
noticed problems with them that needed to be fixed. The pages for configsets
got updated with a bit more information about what configsets are; the
config-api.adoc got better descriptions for the commands & better examples in a
couple of cases; the list of implicit handlers got re-organized and pulled out
of the table that looked really bad in the PDF.
Remaining pages to be done:
|| Page || Old API endpoint ||
|collections-api.adoc | /admin/collections |
|coreadmin-api.adoc | /admin/cores |
|enabling-ssl.adoc | /admin/collections |
|making-and-restoring-backups.adoc | /admin/cores |
|other-parsers.adoc | /<collection>/update |
|request-parameters-api.adoc | /<collection>/config |
|rule-based-authorization-plugin.adoc | /admin/authorization |
|rule-based-authorization-plugin.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/* |
|updating-parts-of-documents.adoc | /<collection>/update |
|uploading-data-with-index-handlers.adoc | /<collection>/update |
I kept the order as "v1" then "v2" for now, only to be consistent about it
while I continue to consider either putting v2 first or making the 2nd tab the
default (which would require some more extensive changes to the code that's
converting the asciidoc to html) is a better option.
> 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
> Priority: Major
>
> 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
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
