lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Steve Rowe (Confluence)" <conflue...@apache.org>
Subject [CONF] Apache Solr Reference Guide > **WIP** v2 API
Date Thu, 30 Mar 2017 02:48:13 GMT
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">

<base href="https://cwiki.apache.org/confluence"> 
<title>Message Title</title>  
<style type="text/css">@media only screen and (max-device-width: 480px) {.mobile-only
{
    width: auto !important;
    height: auto !important;
    overflow: visible !important;
    line-height: normal !important;
    font-size: inherit !important;
    mso-hide: all;
}

.desktop-only {
    display: none !important;
}

/* iPhone 3GS fix for unwanted 20px right margin */
body {
    min-width: 100% !important;
    padding: 0;
    margin: 0;
}

#center-content-table {
    max-width: none;
!important;
}

#header-pattern-container {
    padding: 10px 10px 10px 10px !important;
    line-height: 20px !important;
}

#header-avatar-image-container {
    padding-right: 8px !important;
}

#email-content-container {
    padding: 0 !important;
}

.mobile-expand {
    border-radius: 0 !important;
    border-left: 0 !important;
    border-right: 0 !important;
    padding-left: 26px !important;
}

.mobile-resize-text {
    font-size: 16px !important;
    line-height: 22px !important;
}

#page-title-pattern-header {
    font-size: 20px !important;
    line-height: 28px !important;
}

#page-title-pattern-icon-image-container-cell {
    padding-top: 7px !important;
}

#inline-user-pattern {
    display: block !important;
}

#inline-user-pattern-avatar {
    padding-top: 3px !important;
}

.contextual-area-pattern {
    border-bottom: 1px solid #ccc !important;
    padding: 15px 10px 0 10px !important;
}

.users-involved-pattern-column-table {
    width: 100% !important;
}

.users-involved-pattern-avatar-table-cell {
    padding: 3px 5px 5px 0 !important;
}

.users-involved-pattern-column-container {
    padding-right: 0 !important;
}

.contextual-excerpt-pattern, #users-involved-pattern {
    border: 0 !important;
}

/** Aui Typography upsized for mobile **/
#content-excerpt-pattern-container, #contextual-excerpt-pattern-text-container {
    font-size: 16px !important;
    line-height: 22px !important;
}

#content-excerpt-pattern-container h1, #contextual-excerpt-pattern-text-container h1 {
    font-size: 24px !important;
    line-height: 28px !important;
}

#content-excerpt-pattern-container h2, #contextual-excerpt-pattern-text-container h2 {
    font-size: 20px !important;
    line-height: 28px !important;
}

#content-excerpt-pattern-container h3, #contextual-excerpt-pattern-text-container h3 {
    font-size: 18px !important;
    line-height: 24px !important;
}

#content-excerpt-pattern-container h4, #contextual-excerpt-pattern-text-container h4 {
    font-size: 16px !important;
    line-height: 22px !important;
}

#content-excerpt-pattern-container h5, #contextual-excerpt-pattern-text-container h5 {
    font-size: 14px !important;
    line-height: 20px !important;
}

#content-excerpt-pattern-container h6, #contextual-excerpt-pattern-text-container h6 {
    font-size: 14px !important;
    line-height: 20px !important;
}

.user-mention {
    line-height: 18px !important;
}

/** Aui Typography end **/

/* Show appropriate footer logo on mobile, display links vertically */
#footer-pattern {
    padding: 15px 10px !important;
}

#footer-pattern-logo-desktop-container {
    padding: 0 !important;
}

#footer-pattern-logo-desktop {
    width: 0 !important;
    height: 0 !important;
}

#footer-pattern-logo-mobile {
    padding-top: 10px !important;
    width: 30px !important;
    height: 27px !important;
    display: inline !important;
}

#footer-pattern-text {
    display: block !important;
}

#footer-pattern-links-container {
    line-height: 0 !important;
}

.footer-pattern-links.mobile-resize-text,
.footer-pattern-links.mobile-resize-text,
#footer-pattern-text.mobile-resize-text,
#footer-pattern-links-container.no-footer-links {
    font-size: 14px !important;
    line-height: 20px !important;
}

.footer-link {
    display: block !important;
}

#footer-pattern-links-container table {
    display: inline-block !important;
    float: none !important;
}

#footer-pattern-links-container, #footer-pattern-text {
    text-align: center !important;
}

#footer-pattern-links {
    padding-bottom: 5px !important;
}

/** Team Calendar overrides, these should be removed when notifications are updated in Team
Calendars. For now CSS
    overrides are being used because the structure of the content can't change without rereleasing
the plugin */
.mail-calendar-container .day-header + table tr td:first-child {
    vertical-align: top !important;
    padding-top: 5px !important;
}}
@media (min-width: 900px) {#center-content-table { width: 900px; }}
@media all {#outlook a {
    padding: 0;
}

/* Force Outlook to provide a "view in browser" menu link. */
/* Prevent Webkit and Windows Mobile platforms from changing default font sizes.*/
body {
    -webkit-text-size-adjust: 100%;
    -ms-text-size-adjust: 100%;
}

.ExternalClass {
    width: 100%;
}

/* Force Hotmail to display emails at full width */
#background-table {
    margin: 0;
    padding: 0;
    width: 100% !important;
}

/* Needed to override highlighting on date and time links in iOS */
.grey a {
    color: #707070;
    text-decoration: none;
}/* These styles are appended to the head element of a notification in order to prevent Apple
Mail and similar
   clients from underlining the due dates with a blue hyperlink */
/* a lozenge outside an inline task should always be #333, lozenges inside an inline task
should be
   colored according to their upcoming due dates, a completed task date lozenge or deleted
task date
   lozenge should always be #707070 */
.date-time-lozenge a {color: #333333; text-decoration: none; }
.inline-task-text-container .date-time-lozenge.date-upcoming a {color: #DF6F00; text-decoration:
none; }
.inline-task-text-container .date-time-lozenge.date-past a {color: #D04437; text-decoration:
none; }
.inline-task-text-container.content-deleted-color .date-time-lozenge a,
.inline-task-text-container.checked .date-time-lozenge a {
    color: #707070; text-decoration: none;
}}
</style> 
</head>
<body>
<table id="background-table" cellpadding="0" cellspacing="0" width="100%" style="border-collapse:
collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; background-color: #f5f5f5">

<tbody> 
<tr> 
<td id="header-pattern-container" style="padding: 0px; border-collapse: collapse; padding:
10px 20px"> 
<table id="header-pattern" cellspacing="0" cellpadding="0" border="0" style="border-collapse:
collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333"> 
<tbody> 
<tr> 
<td id="header-avatar-image-container" valign="top" style="padding: 0px; border-collapse:
collapse; vertical-align: top; width: 32px; padding-right: 9px"><a href="https://cwiki.apache.org/confluence/display/~sarowe?src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c"
style="color: #3b73af; text-decoration: none"><img id="header-avatar-image" class="image_fix"
src="cid:avatar_7f55d582fe2b940d62c6ccf4870754ed" height="32" width="32" border="0" style="border-radius:
3px; vertical-align: top"></a></td>
<td id="header-text-container" valign="middle" style="padding: 0px; border-collapse: collapse;
vertical-align: middle; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px;
mso-line-height-rule: exactly; mso-text-raise: 1px">Steve Rowe <strong>created</strong>
a page</td> 
</tr> 
</tbody> 
</table> </td> 
</tr> 
<!-- End Header pattern --> 
<tr> 
<td id="email-content-container" style="padding: 0px; border-collapse: collapse; padding:
0 20px"> 
<table id="email-content-table" cellspacing="0" cellpadding="0" border="0" width="100%"
style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333;
border-spacing: 0; border-collapse: separate"> 
<tbody> 
<tr> 
<td class="email-content-rounded-top mobile-expand" style="padding: 0px; border-collapse:
collapse; color: #fff; padding: 0 15px 0 16px; height: 15px; background-color: #fff; border-left:
1px solid #ccc; border-top: 1px solid #ccc; border-right: 1px solid #ccc; border-bottom: 0;
border-top-right-radius: 5px; border-top-left-radius: 5px">&nbsp;</td> 
</tr> 
<tr> 
<td class="email-content-main mobile-expand" style="padding: 0px; border-collapse: collapse;
border-left: 1px solid #ccc; border-right: 1px solid #ccc; border-top: 0; border-bottom: 0;
padding: 0 15px 15px 16px; background-color: #fff"> 
<table id="page-title-pattern" cellspacing="0" cellpadding="0" border="0" width="100%"
style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">

<tbody> 
<tr> 
<td id="page-title-pattern-icon-image-container" valign="top" style="padding: 0px; border-collapse:
collapse; width: 16px; vertical-align: top"> 
<table cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace:
0pt; mso-table-rspace: 0pt; color: #333"> 
<tbody> 
<tr> 
<td id="page-title-pattern-icon-image-container-cell" style="padding: 0px; border-collapse:
collapse; width: 16px; padding: 9px 8px 0px 0px; mso-text-raise: 5px; mso-line-height-rule:
exactly"><a href="https://cwiki.apache.org/confluence/display/solr/**WIP**+v2+API?src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=view"
title="page icon" style="vertical-align: top;; color: #3b73af; text-decoration: none"><img
style="vertical-align: top; display: block;" src="cid:page-icon" alt="page icon" title="page
icon" height="16" width="16" border="0"></a></td> 
</tr> 
</tbody> 
</table> </td>
<td style="vertical-align: top;; padding: 0px; border-collapse: collapse; padding-right:
5px; font-size: 20px; line-height: 30px; mso-line-height-rule: exactly" id="page-title-pattern-header-container"><span
id="page-title-pattern-header" style="font-family: Arial, sans-serif; padding: 0; font-size:
20px; line-height: 30px; mso-text-raise: 2px; mso-line-height-rule: exactly; vertical-align:
middle"><a href="https://cwiki.apache.org/confluence/display/solr/**WIP**+v2+API?src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=view"
title="**WIP** v2 API" style="color: #3b73af; text-decoration: none">**WIP** v2 API</a></span></td>

</tr> 
</tbody> 
</table> </td> 
</tr> 
<tr> 
<td class="email-content-main mobile-expand" style="padding: 0px; border-collapse: collapse;
border-left: 1px solid #ccc; border-right: 1px solid #ccc; border-top: 0; border-bottom: 0;
padding: 0 15px 15px 16px; background-color: #fff"> 
<table class="content-excerpt-pattern" cellspacing="0" cellpadding="0" border="0" width="100%"
style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333;
font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 1px"> 
<tbody> 
<tr> 
<td class="content-excerpt-pattern-container mobile-resize-text " style="padding: 0px;
border-collapse: collapse; padding: 0 0 0 24px"> <p style="margin: 10px 0 0 0; margin-top:
0">The v2 API is a modernized self-documenting API interface covering most current Solr
APIs. &nbsp;It is anticipated that once it reaches full coverage, and internal API usages
like SolrJ and the Admin UI have been converted from the old API to the v2 API, the old API
will eventually be retired. &nbsp;For now the two API styles will coexist, and a<span
style="font-size: 11.0pt;">ll the old APIs will continue to work without any change. You
can disable all v2 API endpoints by starting your servers with this system property:&nbsp;<code
style="font-family: monospace">-Ddisable.v2.api=true</code>.</span> </p>
<p style="margin: 10px 0 0 0">The old API and the v2 API differ in three principle ways:</p>

<ol style="margin: 10px 0 0 0"> 
<li>Command format: The old API commands and associated parameters are provided through
URL request parameters on HTTP GET requests, while in the v2 API most API commands are provided
via a JSON body POST'ed to v2 API endpoints. &nbsp;(The v2 API also supports HTTP methods
GET and DELETE where appropriate.)</li> 
<li>Endpoint structure: The v2 API endpoint structure has been rationalized and regularized.</li>

<li>Documentation: The v2 APIs are self-documenting: append <code style="font-family:
monospace">/_introspect</code> to any valid v2 API path and the API specification
will be returned in JSON format.</li> 
</ol> <h2 id="id-**WIP**v2API-v2APIpathprefixes" style="margin: 10px 0 0 0; font-size:
20px; font-weight: normal; line-height: 30px; margin: 40px 0 0 0">v2 API path prefixes</h2>

<div class="table-wrap" style="margin: 10px 0 0 0; overflow-x: auto"> 
<table class="confluenceTable" style="border-collapse: collapse; border: 1px solid #ddd;;
border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; border-collapse:
collapse; margin: 10px 0 0 0; overflow-x: auto; margin-top: 0"> 
<tbody> 
<tr> 
<th class="confluenceTh" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;background-color: #F0F0F0; font-weight: bold;; border:
1px solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left; background-color:
#f0f0f0; font-weight: bold">Path prefix</th> 
<th class="confluenceTh" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;background-color: #F0F0F0; font-weight: bold;; border:
1px solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left; background-color:
#f0f0f0; font-weight: bold">Some Supported Commands</th> 
</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"> <p style="margin:
10px 0 0 0; margin-top: 0"> <code style="font-family: monospace"><span>/v2/collections<br>
</span></code><span style="font-size: 11.0pt;">or equivalently:&nbsp;</span><code
style="font-size: 11.0pt;; font-family: monospace">/v2/c</code> </p> </td>

<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Create, alias, backup,
and restore a collection.</td> 
</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/c/<em>collection-name</em>/shards</code></td> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Split a shard, create
a shard, add a replica.&nbsp;</td> 
</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/c/<em>collection-name</em>/shards/<em><em>shard-name</em></em></code></td>

<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Delete a shard, force
leader election</td> 
</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/c/<em>collection-name</em>/shards/<em><em>shard-name</em></em>/<em><em>replica-name</em></em></code></td>

<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Delete a replica.</td>

</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/cores</code></td> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Create a core.</td>

</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/cores/<em>core-name</em></code></td> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Reload, rename, delete,
and unload a core.</td> 
</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/node</code></td> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Perform overseer
operation, rejoin leader election.</td> 
</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/cluster</code></td> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Add role, remove
role, set cluster property.</td> 
</tr> 
<tr> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left"><code style="font-family:
monospace">/v2/blob</code></td> 
<td class="confluenceTd" style="border: 1px solid #DDD; padding: 5px 7px; min-width: 0.6em;
text-align: left; vertical-align: top;; padding: 0px; border-collapse: collapse; border: 1px
solid #ddd; padding: 7px 10px; vertical-align: top; text-align: left">Upload and download
blobs and metadata.</td> 
</tr> 
</tbody> 
</table> 
</div> <p style="margin: 10px 0 0 0"> <span style="font-family: &quot;Trebuchet
MS&quot; , Tahoma , Arial , sans-serif;font-size: 22.1px;"> <br> </span>
</p> <p style="margin: 10px 0 0 0"> <span style="font-family: &quot;Trebuchet
MS&quot; , Tahoma , Arial , sans-serif;font-size: 22.1px;">Introspect</span>
</p> <p style="margin: 10px 0 0 0"> <span style="font-size: 11.0pt;">Append&nbsp;<code
style="font-family: monospace">/_introspect</code>&nbsp;to any valid v2 API path
and the API specification will be returned in JSON format.</span> </p> <p style="margin:
10px 0 0 0"> <span style="font-size: 11.0pt;">Example: <code style="font-family:
monospace"><a href="http://localhost:8983/v2/c/_introspect" class="external-link" rel="nofollow"
style="color: #3b73af; text-decoration: none">http://localhost:8983/v2/c/_introspect</a></code></span>
</p> <p style="margin: 10px 0 0 0">To limit the introspect output to include just
one particular HTTP method, add request param <code style="font-family: monospace">method</code>&nbsp;with
value <code style="font-family: monospace">GET</code>, <code style="font-family:
monospace">POST</code>, or <code style="font-family: monospace">DELETE</code>.</p>
<p style="margin: 10px 0 0 0">Example: <code style="font-family: monospace"><a
href="http://localhost:8983/solr/v2/cores/_introspect?method=POST" class="external-link" rel="nofollow"
style="color: #3b73af; text-decoration: none"></a><a href="http://localhost:8983/solr/v2/cores/_introspect?method=POST"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none">http://localhost:8983/v2/c/_introspect?method=POST</a></code>
</p> <p style="margin: 10px 0 0 0">Most endpoints support commands provided via
a body sent via POST. To limit the introspect output to only one command, add request param
<code style="font-family: monospace">command=<em>command-name</em></code><span
style="font-size: 11.0pt;">.</span> </p> <p style="margin: 10px 0 0 0">
<span style="font-size: 11.0pt;"> Example: </span><code style="font-family:
monospace"><span style="font-size: 11.0pt;">&nbsp;</span><span style="font-size:
11.0pt;"><span class="nolink"><a href="http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&amp;command=modify"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none">http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&amp;command=modify</a></span></span><a
href="http://localhost:8983/solr/v2/collections/_introspect?method=POST&amp;command=modify"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none"></a><a
href="http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&amp;command=modify"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none"></a><a
href="http://localhost:8983/v2/c/gettingstarted/_introspect?method=POST&amp;command=modify"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none"><span
style="font-size: 11.0pt;">&nbsp;</span></a><span style="font-size:
11.0pt;">&nbsp;</span><span style="font-size: 11.0pt;">&nbsp;</span></code>
</p> <h3 id="id-**WIP**v2API-Interpretingtheintrospectoutput" style="margin: 10px
0 0 0; font-size: 16px; line-height: 25px; margin: 30px 0 0 0">Interpreting the introspect
output</h3> <p style="margin: 10px 0 0 0">Example : <code style="font-family:
monospace"><span class="nolink"><a href="http://localhost:8983/v2/c/gettingstarted/get/_introspect"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none">http://localhost:8983/v2/c/gettingstarted/get/_introspect</a></span></code>
</p> <pre style="margin: 10px 0 0 0">{
  "spec":[{
      "documentation":"https://cwiki.apache.org/confluence/display/solr/RealTime+Get",
      "description":"RealTime Get allows retrieving documents by ID before the documents have
been committed to the index. It is useful when you need access to documents as soon as they
are indexed but your commit times are high for other reasons.",
      "methods":["GET"],
      "url":{
        "paths":["/c/gettingstarted/get"],
        "params":{
          "id":{
            "type":"string",
            "description":"A single document ID to retrieve."},
          "ids":{
            "type":"string",
            "description":"One or more document IDs to retrieve. Separate by commas if more
than one ID is specified."},
          "fq":{
            "type":"string",
            "description":"An optional filter query to add to the query. One use case for
this is security filtering, in case users or groups should not be able to retrieve the document
ID requested."}}}}],
  "WARNING":"This response format is experimental.  It is likely to change in the future.",
  "availableSubPaths":{}}</pre> <p style="margin: 10px 0 0 0">&nbsp;</p>
<p style="margin: 10px 0 0 0"> <strong>documentation</strong>: This is the
url to the reference guide section for this API<br> <strong>description</strong>:
A text description of the feature/variable/command etc <br>methods: The http methods
supported by this API<br>url/paths : This gives the list of paths supported by this
API. The path may have placeholders such as /cores/{core}/get . The placeholder here is {core}
. It is possible to have multiple placeholders in a url<br>url/params : List of params
, their types and description<br>availableSubPaths : The list of valid subpaths and
the http method at which it is available</p> <p style="margin: 10px 0 0 0"> <br>Interpreting
a POST command API<br>Example : <a href="http://localhost:7574/solr/v2/c/gettingstarted/_introspect?method=POST&amp;command=modify"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none">http://localhost:7574/solr/v2/c/gettingstarted/_introspect?method=POST&amp;command=modify</a>
</p> <p style="margin: 10px 0 0 0">{<br> "documentation": "<a href="https://cwiki.apache.org"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none">https://cwiki.apache.org</a>",<br>
"methods": ["POST"],<br> "url": {<br> "paths": [<br> "/collections/{collection}",<br>
"/c/{collection}"]<br> },<br> "commands": {<br> "modify": {<br> "documentation":
"<a href="https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-modifycoll"
rel="nofollow" style="color: #3b73af; text-decoration: none">https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-modifycoll</a>",<br>
"description": "",<br> "type": "object",<br> "properties": {<br> "rule":
{<br> "type": "array",<br> "items": {<br> "type": "string"<br> },<br>
"description": "Replica placement rules"<br> },<br> "snitch": {<br> "type":
"array",<br> "items": {<br> "type": "string"<br> },<br> "description":
"Details of the snitch provider"<br> },<br> "autoAddReplicas": {<br> "type":
"boolean",<br> "description": "When set to true, enables auto addition of replicas on
shared file systems. See the section autoAddReplicas Settings for more details on settings
and overrides."<br> },<br> "replicationFactor": {<br> "type": "string",<br>
"description": "The number of replicas to be created for each shard"<br> }}}}}</p>
<p style="margin: 10px 0 0 0">This is very similar to the GET style API but for the
‘commands’ section. This section has one entry for each command supported at this endpoint.
The above example just describes the ‘modify’ command . The key is the command name and
the value is a json which describes the command structure using JSON schema. Please see <a
href="http://json-schema.org/" class="external-link" rel="nofollow" style="color: #3b73af;
text-decoration: none">http://json-schema.org/</a> to see how to interpret the json
schema <br>Example command based on the above schema : <br>curl <a href="http://localhost:8983/solr/v2/collections/gettingstarted"
class="external-link" rel="nofollow" style="color: #3b73af; text-decoration: none">http://localhost:8983/solr/v2/collections/gettingstarted</a>
-H 'Content-type:application/json' -d '{<br> modify : {replicationFactor : 3,<br>
autoAddReplicas : false<br> }<br>}</p> </td> 
</tr> 
</tbody> 
</table> </td> 
</tr> 
<tr> 
<td class="email-content-main mobile-expand action-padding last-row-padding" style="padding:
0px; border-collapse: collapse; border-left: 1px solid #ccc; border-right: 1px solid #ccc;
border-top: 0; border-bottom: 0; padding: 0 15px 15px 16px; background-color: #fff; padding-bottom:
10px; padding-bottom: 10px"> 
<table id="actions-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse:
collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; font-family: Arial, sans-serif;
font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px">

<tbody> 
<tr> 
<td id="actions-pattern-container" valign="middle" style="padding: 0px; border-collapse:
collapse; padding: 15px 0 0 24px; vertical-align: middle"> 
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace:
0pt; color: #333"> 
<tbody> 
<tr> 
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse:
collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 0px; vertical-align: middle"><a href="https://cwiki.apache.org/confluence/display/solr/**WIP**+v2+API?src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=view"
title="View page Icon" style="color: #3b73af; text-decoration: none"><img class="actions-pattern-action-icon-image"
height="16" width="16" border="0" title="View page Icon" src="cid:com.atlassian.confluence.plugins.confluence-email-resources%3Aview-page-email-adg-footer-item%3Aicon"
alt="View page Icon" style="vertical-align: middle"></a></td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse:
collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 4px; padding-left: 5px; white-space: nowrap"><a href="https://cwiki.apache.org/confluence/display/solr/**WIP**+v2+API?src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=view"
title="View page" style="color: #3b73af; text-decoration: none">View page</a></td>
<td class="actions-pattern-action-bull" style="padding: 0px; border-collapse: collapse;
font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 4px; color: #999; padding: 0 5px">•</td> 
</tr> 
</tbody> 
</table> 
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace:
0pt; color: #333"> 
<tbody> 
<tr> 
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse:
collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 0px; vertical-align: middle"><a href="https://cwiki.apache.org/confluence/display/solr/**WIP**+v2+API?showComments=true&amp;showCommentArea=true&amp;src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=comment#addcomment"
title="Add comment Icon" style="color: #3b73af; text-decoration: none"><img class="actions-pattern-action-icon-image"
height="16" width="16" border="0" title="Add comment Icon" src="cid:com.atlassian.confluence.plugins.confluence-email-resources%3Aadd-comment-to-content-email-adg-footer-item%3Aicon"
alt="Add comment Icon" style="vertical-align: middle"></a></td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse:
collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 4px; padding-left: 5px; white-space: nowrap"><a href="https://cwiki.apache.org/confluence/display/solr/**WIP**+v2+API?showComments=true&amp;showCommentArea=true&amp;src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=comment#addcomment"
title="Add comment" style="color: #3b73af; text-decoration: none">Add comment</a></td>
<td class="actions-pattern-action-bull" style="padding: 0px; border-collapse: collapse;
font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 4px; color: #999; padding: 0 5px">•</td> 
</tr> 
</tbody> 
</table> 
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt;
color: #333"> 
<tbody> 
<tr> 
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse:
collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 0px; vertical-align: middle"><a href="https://cwiki.apache.org/confluence/plugins/likes/like.action?contentId=68721195&amp;src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=like"
title="Like Icon" style="color: #3b73af; text-decoration: none"><img class="actions-pattern-action-icon-image"
height="16" width="16" border="0" title="Like Icon" src="cid:com.atlassian.confluence.plugins.confluence-like%3Aview-email-adg-content-item%3Aicon"
alt="Like Icon" style="vertical-align: middle"></a></td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse:
collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule:
exactly; mso-text-raise: 4px; padding-left: 5px; white-space: nowrap"><a href="https://cwiki.apache.org/confluence/plugins/likes/like.action?contentId=68721195&amp;src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=like"
title="Like" style="color: #3b73af; text-decoration: none">Like</a></td> 
</tr> 
</tbody> 
</table> </td> 
</tr> 
</tbody> 
</table> </td> 
</tr> 
<tr> 
<td class="email-content-rounded-bottom mobile-expand" style="padding: 0px; border-collapse:
collapse; color: #fff; height: 5px; line-height: 5px; padding: 0 15px 0 16px; background-color:
#fff; border-bottom-right-radius: 5px; border-bottom-left-radius: 5px; border-top: 0; border-left:
1px solid #ccc; border-bottom: 1px solid #ccc; border-right: 1px solid #ccc; mso-line-height-rule:
exactly">&nbsp;</td> 
</tr> 
</tbody> 
</table> </td> 
</tr> 
<tr> 
<td id="footer-pattern" style="padding: 0px; border-collapse: collapse; padding: 12px 20px">

<table id="footer-pattern-container" cellspacing="0" cellpadding="0" border="0" width="100%"
style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333">

<tbody> 
<tr> 
<td id="footer-pattern-links-container" width="100%" style="padding: 0px; border-collapse:
collapse; color: #999; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif;
mso-line-height-rule: exactly; mso-text-raise: 2px"> 
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace:
0pt; color: #333; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule:
exactly; mso-text-raise: 2px"> 
<tbody> 
<tr> 
<td class="footer-pattern-links mobile-resize-text" style="padding: 0px; border-collapse:
collapse"><a href="https://cwiki.apache.org/confluence/users/removespacenotification.action?spaceKey=solr&amp;src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=stop-watching"
title="" style="color: #3b73af; text-decoration: none">Stop watching space</a></td>
<td class="footer-pattern-links-bull" style="padding: 0px; border-collapse: collapse; padding:
0 5px; color: #999">•</td> 
</tr> 
</tbody> 
</table> 
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt;
color: #333; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule:
exactly; mso-text-raise: 2px"> 
<tbody> 
<tr> 
<td class="footer-pattern-links mobile-resize-text" style="padding: 0px; border-collapse:
collapse"><a href="https://cwiki.apache.org/confluence/users/editmyemailsettings.action?src=mail&amp;src.mail.timestamp=1490842093447&amp;src.mail.notification=com.atlassian.confluence.plugins.confluence-content-notifications-plugin%3Apage-created-notification&amp;src.mail.recipient=8aa980874e36a1eb014e36a2992a202c&amp;src.mail.action=manage"
title="" style="color: #3b73af; text-decoration: none">Manage notifications</a></td>

</tr> 
</tbody> 
</table> </td>
<td id="footer-pattern-logo-desktop-container" rowspan="2" valign="top" style="padding:
0px; border-collapse: collapse; padding-left: 20px; vertical-align: top"> 
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt;
color: #333"> 
<tbody> 
<tr> 
<td id="footer-pattern-logo-desktop-padding" style="padding: 0px; border-collapse: collapse;
padding-top: 3px"><img id="footer-pattern-logo-desktop" src="cid:footer-desktop-logo"
alt="Confluence logo big" title="Confluence logo big" width="132" height="20" class="image_fix"></td>

</tr> 
</tbody> 
</table> </td> 
</tr> 
<tr> 
<td id="footer-pattern-text" class="mobile-resize-text" width="100%" style="padding: 0px;
border-collapse: collapse; color: #999; font-size: 12px; line-height: 18px; font-family: Arial,
sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px; display: none">This message
was sent by Atlassian Confluence 5.8.4<br> <img id="footer-pattern-logo-mobile" src="cid:footer-mobile-logo"
alt="" title="" width="0" height="0" style="display: none; mso-hide: all"></td> 
</tr> 
</tbody> 
</table> </td> 
</tr> 
</tbody> 
</table> 
<table id="sealed-section" border="0" cellpadding="0" cellspacing="0" width="0" style="border-collapse:
collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #333; display: none"> 
<tbody> 
<tr> 
<td style="padding: 0px; border-collapse: collapse; border: 0; font-size: 0px; line-height:
0; mso-line-height-rule: exactly"></td> 
</tr> 
</tbody> 
</table>
</body>
</html>
Mime
View raw message