Added:
dev/solr/solr-9.8.0-RC1-rev-8bf0100e502ade4b8161e4b90f762b117a6ef442/solr/9.8.0/openApi/solr-openapi-9.8.0.json
==============================================================================
---
dev/solr/solr-9.8.0-RC1-rev-8bf0100e502ade4b8161e4b90f762b117a6ef442/solr/9.8.0/openApi/solr-openapi-9.8.0.json
(added)
+++
dev/solr/solr-9.8.0-RC1-rev-8bf0100e502ade4b8161e4b90f762b117a6ef442/solr/9.8.0/openApi/solr-openapi-9.8.0.json
Tue Jan 14 19:49:23 2025
@@ -0,0 +1,5501 @@
+{
+ "openapi" : "3.0.1",
+ "info" : {
+ "title" : "v2 API",
+ "description" : "OpenAPI spec for Solr's v2 API endpoints",
+ "license" : {
+ "name" : "ASL 2.0"
+ },
+ "version" : "9.8.0"
+ },
+ "paths" : {
+
"/collections/{collName}/shards/{shardName}/replicas/{replicaName}/properties/{propName}"
: {
+ "put" : {
+ "tags" : [ "replica-properties" ],
+ "summary" : "Adds a property to the specified replica",
+ "operationId" : "addReplicaProperty",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "description" : "The name of the collection the replica belongs to.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "description" : "The name of the shard the replica belongs to.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "replicaName",
+ "in" : "path",
+ "description" : "The replica, e.g., `core_node1`.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "propName",
+ "in" : "path",
+ "description" : "The name of the property to add.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "The value of the replica property to create or
update",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/AddReplicaPropertyRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "replica-properties" ],
+ "summary" : "Delete an existing replica property",
+ "operationId" : "deleteReplicaProperty",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "description" : "The name of the collection the replica belongs to.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "description" : "The name of the shard the replica belongs to.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "replicaName",
+ "in" : "path",
+ "description" : "The replica, e.g., `core_node1`.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "propName",
+ "in" : "path",
+ "description" : "The name of the property to delete.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/aliases/{aliasName}/properties/{propName}" : {
+ "get" : {
+ "tags" : [ "alias-properties" ],
+ "summary" : "Get a specific property for a collection alias.",
+ "operationId" : "getAliasProperty",
+ "parameters" : [ {
+ "name" : "aliasName",
+ "in" : "path",
+ "description" : "Alias Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "propName",
+ "in" : "path",
+ "description" : "Property Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GetAliasPropertyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "alias-properties" ],
+ "summary" : "Update a specific property for a collection alias.",
+ "operationId" : "createOrUpdateAliasProperty",
+ "parameters" : [ {
+ "name" : "aliasName",
+ "in" : "path",
+ "description" : "Alias Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "propName",
+ "in" : "path",
+ "description" : "Property Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Property value that needs to be updated",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UpdateAliasPropertyRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "alias-properties" ],
+ "summary" : "Delete a specific property for a collection alias.",
+ "operationId" : "deleteAliasProperty",
+ "parameters" : [ {
+ "name" : "aliasName",
+ "in" : "path",
+ "description" : "Alias Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "propName",
+ "in" : "path",
+ "description" : "Property Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/aliases/{aliasName}/properties" : {
+ "get" : {
+ "tags" : [ "alias-properties" ],
+ "summary" : "Get properties for a collection alias.",
+ "operationId" : "getAllAliasProperties",
+ "parameters" : [ {
+ "name" : "aliasName",
+ "in" : "path",
+ "description" : "Alias Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GetAllAliasPropertiesResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "alias-properties" ],
+ "summary" : "Update properties for a collection alias.",
+ "operationId" : "updateAliasProperties",
+ "parameters" : [ {
+ "name" : "aliasName",
+ "in" : "path",
+ "description" : "Alias Name",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Properties that need to be updated",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/UpdateAliasPropertiesRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/replicas/balance" : {
+ "post" : {
+ "tags" : [ "cluster" ],
+ "summary" : "Balance Replicas across the given set of Nodes.",
+ "operationId" : "balanceReplicas",
+ "requestBody" : {
+ "description" : "Contains user provided parameters",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/BalanceReplicasRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/balance-shard-unique" : {
+ "post" : {
+ "tags" : [ "collections" ],
+ "summary" : "Ensure a specified per-shard property is distributed
evenly amongst physical nodes comprising a collection",
+ "operationId" : "balanceShardUnique",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/BalanceShardUniqueRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/files{path}" : {
+ "delete" : {
+ "tags" : [ "file-store" ],
+ "summary" : "Delete a file or directory from the filestore.",
+ "operationId" : "deleteFile",
+ "parameters" : [ {
+ "name" : "path",
+ "in" : "path",
+ "description" : "Path to a file or directory within the filestore",
+ "required" : true,
+ "schema" : {
+ "pattern" : ".+",
+ "type" : "string"
+ }
+ }, {
+ "name" : "localDelete",
+ "in" : "query",
+ "description" : "Indicates whether the deletion should only be done
on the receiving node. For internal use only",
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/files{filePath}" : {
+ "put" : {
+ "tags" : [ "file-store" ],
+ "summary" : "Upload a file to the filestore.",
+ "operationId" : "uploadFile",
+ "parameters" : [ {
+ "name" : "filePath",
+ "in" : "path",
+ "description" : "File store path",
+ "required" : true,
+ "schema" : {
+ "pattern" : ".+",
+ "type" : "string"
+ }
+ }, {
+ "name" : "sig",
+ "in" : "query",
+ "description" : "Signature(s) for the file being uploaded",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ },
+ "required" : true,
+ "x-genericEntity" : "true"
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UploadToFileStoreResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/properties/{propertyName}" : {
+ "get" : {
+ "tags" : [ "cluster-properties" ],
+ "summary" : "Get a cluster property in this Solr cluster.",
+ "operationId" : "getClusterProperty",
+ "parameters" : [ {
+ "name" : "propertyName",
+ "in" : "path",
+ "description" : "The name of the property being retrieved.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "cluster-properties" ],
+ "summary" : "Set a single new or existing cluster property in this
Solr cluster.",
+ "operationId" : "createOrUpdateClusterProperty",
+ "parameters" : [ {
+ "name" : "propertyName",
+ "in" : "path",
+ "description" : "The name of the property being set.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Value to set for the property",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SetClusterPropertyRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "cluster-properties" ],
+ "summary" : "Delete a cluster property in this Solr cluster.",
+ "operationId" : "deleteClusterProperty",
+ "parameters" : [ {
+ "name" : "propertyName",
+ "in" : "path",
+ "description" : "The name of the property being deleted.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/properties" : {
+ "get" : {
+ "tags" : [ "cluster-properties" ],
+ "summary" : "List all cluster properties in this Solr cluster.",
+ "operationId" : "listClusterProperties",
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListClusterPropertiesResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "cluster-properties" ],
+ "summary" : "Set nested cluster properties in this Solr cluster.",
+ "operationId" : "createOrUpdateNestedClusterProperty",
+ "requestBody" : {
+ "description" : "Property/ies to be set",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/backups/{backupName}/versions" : {
+ "post" : {
+ "tags" : [ "collection-backups" ],
+ "summary" : "Creates a new backup point for a collection",
+ "operationId" : "createCollectionBackup",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "backupName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/CreateCollectionBackupRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/backups/{backupName}/restore" : {
+ "post" : {
+ "tags" : [ "collection-backups" ],
+ "summary" : "Restores an existing backup point to a (potentially new)
collection.",
+ "operationId" : "restoreCollection",
+ "parameters" : [ {
+ "name" : "backupName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestoreCollectionRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collName}/properties/{propName}" : {
+ "put" : {
+ "tags" : [ "collection-properties" ],
+ "summary" : "Create or update a collection property",
+ "operationId" : "createOrUpdateCollectionProperty",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "propName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/UpdateCollectionPropertyRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "collection-properties" ],
+ "summary" : "Delete the specified collection property from the
collection",
+ "operationId" : "deleteCollectionProperty",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "propName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collName}/snapshots/{snapshotName}" : {
+ "post" : {
+ "tags" : [ "collection-snapshots" ],
+ "summary" : "Creates a new snapshot of the specified collection.",
+ "operationId" : "createCollectionSnapshot",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "description" : "The name of the collection.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "snapshotName",
+ "in" : "path",
+ "description" : "The name of the snapshot to be created.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Contains user provided parameters",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/CreateCollectionSnapshotRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/CreateCollectionSnapshotResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "collection-snapshots" ],
+ "summary" : "Delete an existing collection-snapshot by name.",
+ "operationId" : "deleteCollectionSnapshot",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "description" : "The name of the collection.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "snapshotName",
+ "in" : "path",
+ "description" : "The name of the snapshot to be deleted.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "followAliases",
+ "in" : "query",
+ "description" : "A flag that treats the collName parameter as a
collection alias.",
+ "schema" : {
+ "type" : "boolean",
+ "default" : false
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/DeleteCollectionSnapshotResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collName}/snapshots" : {
+ "get" : {
+ "tags" : [ "collection-snapshots" ],
+ "summary" : "List the snapshots available for a specified collection.",
+ "operationId" : "listSnapshots",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "description" : "The name of the collection.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/ListCollectionSnapshotsResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/snapshots/{snapshotName}" : {
+ "post" : {
+ "tags" : [ "core-snapshots" ],
+ "summary" : "Create a new snapshot of the specified core.",
+ "operationId" : "createSnapshot",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "description" : "The name of the core to snapshot.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "snapshotName",
+ "in" : "path",
+ "description" : "The name to associate with the core snapshot.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "description" : "The id to associate with the async task.",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCoreSnapshotResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "core-snapshots" ],
+ "summary" : "Delete a single snapshot from the specified core.",
+ "operationId" : "deleteSnapshot",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "description" : "The name of the core for which to delete a
snapshot.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "snapshotName",
+ "in" : "path",
+ "description" : "The name of the core snapshot to delete.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "description" : "The id to associate with the async task.",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/DeleteSnapshotResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/snapshots" : {
+ "get" : {
+ "tags" : [ "core-snapshots" ],
+ "summary" : "List existing snapshots for the specified core.",
+ "operationId" : "listSnapshots_1",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "description" : "The name of the core for which to retrieve
snapshots.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCoreSnapshotsResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/aliases" : {
+ "get" : {
+ "tags" : [ "aliases" ],
+ "summary" : "List the existing collection aliases.",
+ "operationId" : "getAliases",
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListAliasesResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "aliases" ],
+ "summary" : "Create a traditional or 'routed' alias",
+ "operationId" : "createAlias",
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateAliasRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections" : {
+ "get" : {
+ "tags" : [ "collections" ],
+ "summary" : "List all collections in this Solr cluster",
+ "operationId" : "listCollections",
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCollectionsResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "collections" ],
+ "summary" : "Creates a new SolrCloud collection.",
+ "operationId" : "createCollection",
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCollectionRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/backups" : {
+ "post" : {
+ "tags" : [ "core-backups" ],
+ "summary" : "Creates a core-level backup",
+ "operationId" : "createBackup",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "description" : "The name of the core.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateCoreBackupRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/shards/{shardName}/replicas" : {
+ "post" : {
+ "tags" : [ "replicas" ],
+ "summary" : "Creates a new replica of an existing shard.",
+ "operationId" : "createReplica",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateReplicaRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "replicas" ],
+ "summary" : "Delete one or more replicas from the specified collection
and shard",
+ "operationId" : "deleteReplicasByCount",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "count",
+ "in" : "query",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }, {
+ "name" : "followAliases",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteInstanceDir",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteDataDir",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteIndex",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "onlyIfDown",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/shards" : {
+ "post" : {
+ "tags" : [ "shards" ],
+ "summary" : "Create a new shard in an existing collection",
+ "operationId" : "createShard",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/CreateShardRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/aliases/{aliasName}" : {
+ "get" : {
+ "tags" : [ "aliases" ],
+ "summary" : "Get details for a specific collection alias.",
+ "operationId" : "getAliasByName",
+ "parameters" : [ {
+ "name" : "aliasName",
+ "in" : "path",
+ "description" : "Alias name.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GetAliasByNameResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "aliases" ],
+ "summary" : "Deletes an alias by its name",
+ "operationId" : "deleteAlias",
+ "parameters" : [ {
+ "name" : "aliasName",
+ "in" : "path",
+ "description" : "The name of the alias to delete",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}" : {
+ "delete" : {
+ "tags" : [ "collections" ],
+ "summary" : "Deletes a collection from SolrCloud",
+ "operationId" : "deleteCollection",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "description" : "The name of the collection to be deleted.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "followAliases",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "description" : "An ID to track the request asynchronously",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/backups/{backupName}/versions" : {
+ "get" : {
+ "tags" : [ "collection-backups" ],
+ "summary" : "List existing incremental backups at the specified
location.",
+ "operationId" : "listBackupsAtLocation",
+ "parameters" : [ {
+ "name" : "backupName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "location",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "repository",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListCollectionBackupsResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete" : {
+ "tags" : [ "collection-backups" ],
+ "summary" : "Delete all incremental backup points older than the most
recent N",
+ "operationId" : "deleteMultipleBackupsByRecency",
+ "parameters" : [ {
+ "name" : "backupName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "retainLatest",
+ "in" : "query",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }, {
+ "name" : "location",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "repository",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/BackupDeletionResponseBody"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/backups/{backupName}/versions/{backupId}" : {
+ "delete" : {
+ "tags" : [ "collection-backups" ],
+ "summary" : "Delete incremental backup point by ID",
+ "operationId" : "deleteSingleBackupById",
+ "parameters" : [ {
+ "name" : "backupName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "backupId",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "location",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "repository",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/BackupDeletionResponseBody"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/backups/{backupName}/purgeUnused" : {
+ "put" : {
+ "tags" : [ "collection-backups" ],
+ "summary" : "Garbage collect orphaned incremental backup files",
+ "operationId" : "garbageCollectUnusedBackupFiles",
+ "parameters" : [ {
+ "name" : "backupName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Request body parameters for the orphaned file
cleanup",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PurgeUnusedFilesRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PurgeUnusedResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/nodes/{nodeName}/clear" : {
+ "post" : {
+ "tags" : [ "node" ],
+ "summary" : "Delete all replicas off of the specified SolrCloud node",
+ "operationId" : "deleteNode",
+ "parameters" : [ {
+ "name" : "nodeName",
+ "in" : "path",
+ "description" : "The name of the node to be cleared. Usually of the
form 'host:1234_solr'.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Contains user provided parameters",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/DeleteNodeRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/shards/{shardName}/replicas/{replicaName}"
: {
+ "delete" : {
+ "tags" : [ "replicas" ],
+ "summary" : "Delete an single replica by name",
+ "operationId" : "deleteReplicaByName",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "replicaName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "followAliases",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteInstanceDir",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteDataDir",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteIndex",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "onlyIfDown",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/scale" : {
+ "put" : {
+ "tags" : [ "replicas" ],
+ "summary" : "Scale the replica count for all shards in the specified
collection",
+ "operationId" : "deleteReplicasByCountAllShards",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ScaleCollectionRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/shards/{shardName}" : {
+ "delete" : {
+ "tags" : [ "shards" ],
+ "summary" : "Delete an existing shard",
+ "operationId" : "deleteShard",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "deleteInstanceDir",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteDataDir",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "deleteIndex",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "followAliases",
+ "in" : "query",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "async",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/shards/{shardName}/force-leader" : {
+ "post" : {
+ "tags" : [ "shards" ],
+ "summary" : "Force leader election to occur on the specified
collection and shard",
+ "operationId" : "forceShardLeader",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/node/commands/{requestId}" : {
+ "get" : {
+ "tags" : [ "node" ],
+ "summary" : "Request the status of an already submitted asynchronous
CoreAdmin API call.",
+ "operationId" : "getCommandStatus",
+ "parameters" : [ {
+ "name" : "requestId",
+ "in" : "path",
+ "description" : "The user defined request-id for the asynchronous
request.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/GetNodeCommandStatusResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/node/key" : {
+ "get" : {
+ "tags" : [ "node" ],
+ "summary" : "Retrieve the public key of the receiving Solr node.",
+ "operationId" : "getPublicKey",
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/PublicKeyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Fetch the entire schema of the specified core or
collection",
+ "operationId" : "getSchemaInfo",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaInfoResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/name" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Get the name of the schema used by the specified core or
collection",
+ "operationId" : "getSchemaName",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaNameResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/similarity" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Get the default similarity configuration used by the
specified core or collection",
+ "operationId" : "getSchemaSimilarity",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaSimilarityResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/uniquekey" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Fetch the uniquekey of the specified core or collection",
+ "operationId" : "getSchemaUniqueKey",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaUniqueKeyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/version" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Fetch the schema version currently used by the specified
core or collection",
+ "operationId" : "getSchemaVersion",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaVersionResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/zkversion" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Fetch the schema version currently used by the specified
core or collection",
+ "operationId" : "getSchemaZkVersion",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "refreshIfBelowVersion",
+ "in" : "query",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32",
+ "default" : -1
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaZkVersionResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/dynamicfields/{fieldName}" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Get detailed info about a single dynamic field",
+ "operationId" : "getDynamicFieldInfo",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "fieldName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SchemaGetDynamicFieldInfoResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/fields/{fieldName}" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Get detailed info about a single non-dynamic field",
+ "operationId" : "getFieldInfo",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "fieldName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaGetFieldInfoResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/fieldtypes/{fieldTypeName}" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "Get detailed info about a single field type",
+ "operationId" : "getFieldTypeInfo",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "fieldTypeName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SchemaGetFieldTypeInfoResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/copyfields" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "List all copy-fields in the schema of the specified core
or collection",
+ "operationId" : "listCopyFields",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaListCopyFieldsResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/dynamicfields" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "List all dynamic-fields in the schema of the specified
core or collection",
+ "operationId" : "listDynamicFields",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SchemaListDynamicFieldsResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/fieldtypes" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "List all field types in the schema used by the specified
core or collection",
+ "operationId" : "listSchemaFieldTypes",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaListFieldTypesResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/schema/fields" : {
+ "get" : {
+ "tags" : [ "schema" ],
+ "summary" : "List all non-dynamic fields in the schema of the
specified core or collection",
+ "operationId" : "listSchemaFields",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SchemaListFieldsResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/install" : {
+ "post" : {
+ "tags" : [ "cores" ],
+ "summary" : "Install an offline index to a specified core",
+ "operationId" : "installCoreData",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/InstallCoreDataRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collName}/shards/{shardName}/install" : {
+ "post" : {
+ "tags" : [ "shards" ],
+ "summary" : "Install offline index into an existing shard",
+ "operationId" : "installShardData",
+ "parameters" : [ {
+ "name" : "collName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "shardName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/InstallShardDataRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/configs" : {
+ "get" : {
+ "tags" : [ "configsets" ],
+ "summary" : "List the configsets available to Solr.",
+ "operationId" : "listConfigSet",
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListConfigsetsResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/merge-indices" : {
+ "post" : {
+ "tags" : [ "cores" ],
+ "summary" : "The MERGEINDEXES action merges one or more indexes to
another index.",
+ "operationId" : "mergeIndexes",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "description" : "The core that the specified indices are merged
into.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Additional properties for merge indexes.",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/MergeIndexesRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/replicas/migrate" : {
+ "post" : {
+ "tags" : [ "cluster" ],
+ "summary" : "Migrate Replicas from a given set of nodes.",
+ "operationId" : "migrateReplicas",
+ "requestBody" : {
+ "description" : "Contains user provided parameters",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/MigrateReplicasRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/node/files{path}" : {
+ "get" : {
+ "tags" : [ "file-store" ],
+ "summary" : "Retrieve file contents or metadata from the filestore.",
+ "operationId" : "getFile",
+ "parameters" : [ {
+ "name" : "path",
+ "in" : "path",
+ "description" : "Path to a file or directory within the filestore",
+ "required" : true,
+ "schema" : {
+ "pattern" : ".+",
+ "type" : "string"
+ }
+ }, {
+ "name" : "sync",
+ "in" : "query",
+ "description" : "If true, triggers syncing for this file across all
nodes in the filestore",
+ "schema" : {
+ "type" : "boolean"
+ }
+ }, {
+ "name" : "getFrom",
+ "in" : "query",
+ "description" : "An optional Solr node name to fetch the file from",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "meta",
+ "in" : "query",
+ "description" : "Indicates that (only) file metadata should be
fetched",
+ "schema" : {
+ "type" : "boolean"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ },
+ "x-omitFromCodegen" : "true"
+ }
+ },
+ "/node/logging/messages" : {
+ "get" : {
+ "tags" : [ "logging" ],
+ "summary" : "Fetch recent log messages on the targeted node.",
+ "operationId" : "fetchLocalLogMessages",
+ "parameters" : [ {
+ "name" : "since",
+ "in" : "query",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/LogMessagesResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/node/logging/levels" : {
+ "get" : {
+ "tags" : [ "logging" ],
+ "summary" : "List all log-levels for the target node.",
+ "operationId" : "listAllLoggersAndLevels",
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListLevelsResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "put" : {
+ "tags" : [ "logging" ],
+ "summary" : "Set one or more logger levels on the target node.",
+ "operationId" : "modifyLocalLogLevel",
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/LogLevelChange"
+ }
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/LoggingResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/node/logging/messages/threshold" : {
+ "put" : {
+ "tags" : [ "logging" ],
+ "summary" : "Set a threshold level for the targeted node's log message
watcher.",
+ "operationId" : "setMessageThreshold",
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SetThresholdRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/LoggingResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/reload" : {
+ "post" : {
+ "tags" : [ "collections" ],
+ "summary" : "Reload all cores in the specified collection.",
+ "operationId" : "reloadCollection",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ReloadCollectionRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/reload" : {
+ "post" : {
+ "tags" : [ "cores" ],
+ "summary" : "Reload the specified core.",
+ "operationId" : "reloadCore",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "description" : "The name of the core to reload.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/rename" : {
+ "post" : {
+ "tags" : [ "collections" ],
+ "summary" : "Rename a SolrCloud collection",
+ "operationId" : "renameCollection",
+ "parameters" : [ {
+ "name" : "collectionName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RenameCollectionRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" :
"#/components/schemas/SubResponseAccumulatingJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/rename" : {
+ "post" : {
+ "tags" : [ "cores" ],
+ "summary" : "The RENAME action changes the name of a Solr core",
+ "operationId" : "renameCore",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Additional properties related to the core renaming",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RenameCoreRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cluster/nodes/{sourceNodeName}/replace" : {
+ "post" : {
+ "tags" : [ "node" ],
+ "summary" : "'Replace' a specified node by moving all replicas
elsewhere",
+ "operationId" : "replaceNode",
+ "parameters" : [ {
+ "name" : "sourceNodeName",
+ "in" : "path",
+ "description" : "The name of the node to be replaced.",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Contains user provided parameters",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ReplaceNodeRequestBody"
+ }
+ }
+ },
+ "required" : true
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/replication/files/{filePath}" : {
+ "get" : {
+ "tags" : [ "core-replication" ],
+ "summary" : "Get a stream of a specific file path of a core",
+ "operationId" : "fetchFile",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "filePath",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "dirType",
+ "in" : "query",
+ "description" : "Directory type for specific filePath (cf or
tlogFile). Defaults to Lucene index (file) directory if empty",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "offset",
+ "in" : "query",
+ "description" : "Output stream read/write offset",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "len",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "compression",
+ "in" : "query",
+ "description" : "Compress file output",
+ "schema" : {
+ "type" : "boolean",
+ "default" : false
+ }
+ }, {
+ "name" : "checksum",
+ "in" : "query",
+ "description" : "Write checksum with output stream",
+ "schema" : {
+ "type" : "boolean",
+ "default" : false
+ }
+ }, {
+ "name" : "maxWriteMBPerSec",
+ "in" : "query",
+ "description" : "Limit data write per seconds. Defaults to no
throttling",
+ "schema" : {
+ "type" : "number",
+ "format" : "double"
+ }
+ }, {
+ "name" : "generation",
+ "in" : "query",
+ "description" : "The generation number of the index",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : { }
+ }
+ }
+ },
+ "x-omitFromCodegen" : "true"
+ }
+ },
+ "/cores/{coreName}/replication/files" : {
+ "get" : {
+ "tags" : [ "replication" ],
+ "summary" : "Return the list of index file that make up the specified
core.",
+ "operationId" : "fetchFileList",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "generation",
+ "in" : "query",
+ "description" : "The generation number of the index",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "format" : "int64"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/FileListResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/replication/indexversion" : {
+ "get" : {
+ "tags" : [ "replication" ],
+ "summary" : "Return the index version of the specified core.",
+ "operationId" : "fetchIndexVersion",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexVersionResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/replication/backups" : {
+ "post" : {
+ "tags" : [ "replication-backups" ],
+ "summary" : "Create a backup of a single core using Solr's
'Replication Handler'",
+ "operationId" : "createBackup_1",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ReplicationBackupResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/restore" : {
+ "post" : {
+ "tags" : [ "cores" ],
+ "summary" : "Restore a previously-taken backup to the specified core",
+ "operationId" : "restoreCore",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "description" : "The name of the core to be restored",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/RestoreCoreRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/{indexType}/{indexName}/select" : {
+ "get" : {
+ "tags" : [ "querying" ],
+ "summary" : "Query a Solr core or collection using individual query
parameters",
+ "operationId" : "query",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "q",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "fq",
+ "in" : "query",
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }, {
+ "name" : "fl",
+ "in" : "query",
+ "schema" : {
+ "type" : "string"
+ }
+ }, {
+ "name" : "rows",
+ "in" : "query",
+ "schema" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ } ],
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/FlexibleSolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post" : {
+ "tags" : [ "querying" ],
+ "summary" : "Query a Solr core or collection using the structured
request DSL",
+ "operationId" : "jsonQuery",
+ "parameters" : [ {
+ "name" : "indexType",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/IndexType"
+ }
+ }, {
+ "name" : "indexName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "type" : "object"
+ }
+ }
+ },
+ "required" : true,
+ "x-genericEntity" : "true"
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/FlexibleSolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
[... 2380 lines stripped ...]
