You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ge...@apache.org on 2024/02/05 14:39:24 UTC
svn commit: r67190 [19/20] - in /dev/solr/solr-9.5.0-RC1-rev-1fb7d127fc064b0bab8435a431d71a44050e654b: ./ solr/ solr/9.5.0/ solr/9.5.0/changes/ solr/9.5.0/docker/ solr/9.5.0/maven/ solr/9.5.0/maven/org/ solr/9.5.0/maven/org/apache/ solr/9.5.0/maven/org...
Added: dev/solr/solr-9.5.0-RC1-rev-1fb7d127fc064b0bab8435a431d71a44050e654b/solr/9.5.0/openApi/solr-openapi-9.5.0.json
==============================================================================
--- dev/solr/solr-9.5.0-RC1-rev-1fb7d127fc064b0bab8435a431d71a44050e654b/solr/9.5.0/openApi/solr-openapi-9.5.0.json (added)
+++ dev/solr/solr-9.5.0-RC1-rev-1fb7d127fc064b0bab8435a431d71a44050e654b/solr/9.5.0/openApi/solr-openapi-9.5.0.json Mon Feb 5 14:39:21 2024
@@ -0,0 +1,3607 @@
+{
+ "openapi" : "3.0.1",
+ "info" : {
+ "title" : "v2 API",
+ "description" : "OpenAPI spec for Solr's v2 API endpoints",
+ "license" : {
+ "name" : "ASL 2.0"
+ },
+ "version" : "9.5.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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/aliases" : {
+ "get" : {
+ "tags" : [ "aliases" ],
+ "summary" : "List the existing collection aliases.",
+ "operationId" : "getAliases",
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/ListAliasesResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/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}/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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/swap" : {
+ "post" : {
+ "tags" : [ "cores" ],
+ "summary" : "SWAP atomically swaps the names used to access two existing Solr cores.",
+ "operationId" : "swapCores",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Additional properties related to core swapping.",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SwapCoresRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/collections/{collectionName}/shards/{shardName}/sync" : {
+ "post" : {
+ "tags" : [ "shards" ],
+ "summary" : "Trigger a 'sync' operation for the specified shard",
+ "operationId" : "syncShard",
+ "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"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/cores/{coreName}/unload" : {
+ "post" : {
+ "tags" : [ "cores" ],
+ "summary" : "Unloads a single core specified by name",
+ "operationId" : "unloadCore",
+ "parameters" : [ {
+ "name" : "coreName",
+ "in" : "path",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "requestBody" : {
+ "description" : "Additional properties related to the core unloading",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/UnloadCoreRequestBody"
+ }
+ }
+ }
+ },
+ "responses" : {
+ "default" : {
+ "description" : "default response",
+ "content" : {
+ "*/*" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/SolrJerseyResponse"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components" : {
+ "schemas" : {
+ "ErrorInfo" : {
+ "type" : "object",
+ "properties" : {
+ "metadata" : {
+ "$ref" : "#/components/schemas/ErrorMetadata"
+ },
+ "details" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object"
+ }
+ }
+ },
+ "msg" : {
+ "type" : "string"
+ },
+ "trace" : {
+ "type" : "string"
+ },
+ "code" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "ErrorMetadata" : {
+ "type" : "object",
+ "properties" : {
+ "error-class" : {
+ "type" : "string"
+ },
+ "root-error-class" : {
+ "type" : "string"
+ }
+ }
+ },
+ "ResponseHeader" : {
+ "type" : "object",
+ "properties" : {
+ "status" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "QTime" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "partialResults" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "SolrJerseyResponse" : {
+ "type" : "object",
+ "properties" : {
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ }
+ }
+ },
+ "AddReplicaPropertyRequestBody" : {
+ "required" : [ "value" ],
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string",
+ "description" : "The value to assign to the property."
+ },
+ "shardUnique" : {
+ "type" : "boolean",
+ "description" : "If `true`, then setting this property in one replica will remove the property from all other replicas in that shard. The default is `false`.\\nThere is one pre-defined property `preferredLeader` for which `shardUnique` is forced to `true` and an error returned if `shardUnique` is explicitly set to `false`.",
+ "default" : false
+ }
+ }
+ },
+ "UpdateAliasPropertyRequestBody" : {
+ "required" : [ "value" ],
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "object"
+ }
+ }
+ },
+ "GetAliasPropertyResponse" : {
+ "type" : "object",
+ "properties" : {
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "value" : {
+ "type" : "string",
+ "description" : "Property value."
+ }
+ }
+ },
+ "GetAllAliasPropertiesResponse" : {
+ "type" : "object",
+ "properties" : {
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string",
+ "description" : "Properties and values associated with alias."
+ },
+ "description" : "Properties and values associated with alias."
+ }
+ }
+ },
+ "UpdateAliasPropertiesRequestBody" : {
+ "required" : [ "properties" ],
+ "type" : "object",
+ "properties" : {
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "description" : "Properties and values to be updated on alias."
+ },
+ "description" : "Properties and values to be updated on alias."
+ },
+ "async" : {
+ "type" : "string",
+ "description" : "Request ID to track this action which will be processed asynchronously."
+ }
+ }
+ },
+ "BalanceReplicasRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "nodes" : {
+ "uniqueItems" : true,
+ "type" : "array",
+ "description" : "The set of nodes across which replicas will be balanced. Defaults to all live data nodes.",
+ "items" : {
+ "type" : "string",
+ "description" : "The set of nodes across which replicas will be balanced. Defaults to all live data nodes."
+ }
+ },
+ "waitForFinalState" : {
+ "type" : "boolean",
+ "description" : "If true, the request will complete only when all affected replicas become active. If false, the API will return the status of the single action, which may be before the new replica is online and active."
+ },
+ "async" : {
+ "type" : "string",
+ "description" : "Request ID to track this action which will be processed asynchronously."
+ }
+ }
+ },
+ "SubResponseAccumulatingJerseyResponse" : {
+ "type" : "object",
+ "properties" : {
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "requestid" : {
+ "type" : "string"
+ },
+ "success" : {
+ "type" : "object"
+ },
+ "failure" : {
+ "type" : "object"
+ },
+ "warning" : {
+ "type" : "string"
+ }
+ }
+ },
+ "BalanceShardUniqueRequestBody" : {
+ "required" : [ "property" ],
+ "type" : "object",
+ "properties" : {
+ "property" : {
+ "type" : "string"
+ },
+ "onlyActiveNodes" : {
+ "type" : "boolean"
+ },
+ "shardUnique" : {
+ "type" : "boolean"
+ },
+ "async" : {
+ "type" : "string"
+ }
+ }
+ },
+ "UpdateCollectionPropertyRequestBody" : {
+ "required" : [ "value" ],
+ "type" : "object",
+ "properties" : {
+ "value" : {
+ "type" : "string"
+ }
+ }
+ },
+ "CreateCoreSnapshotResponse" : {
+ "type" : "object",
+ "properties" : {
+ "core" : {
+ "type" : "string",
+ "description" : "The name of the core."
+ },
+ "indexDirPath" : {
+ "type" : "string",
+ "description" : "The path to the directory containing the index files."
+ },
+ "generation" : {
+ "type" : "integer",
+ "description" : "The generation value for the created snapshot.",
+ "format" : "int64"
+ },
+ "files" : {
+ "type" : "array",
+ "description" : "The list of index filenames contained within the created snapshot.",
+ "items" : {
+ "type" : "string",
+ "description" : "The list of index filenames contained within the created snapshot."
+ }
+ },
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "commitName" : {
+ "type" : "string",
+ "description" : "The name of the created snapshot."
+ }
+ }
+ },
+ "DeleteSnapshotResponse" : {
+ "type" : "object",
+ "properties" : {
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "coreName" : {
+ "type" : "string",
+ "description" : "The name of the core."
+ },
+ "commitName" : {
+ "type" : "string",
+ "description" : "The name of the deleted snapshot."
+ }
+ }
+ },
+ "ListCoreSnapshotsResponse" : {
+ "type" : "object",
+ "properties" : {
+ "snapshots" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "$ref" : "#/components/schemas/SnapshotInformation"
+ },
+ "description" : "The collection of snapshots found for the requested core."
+ },
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ }
+ }
+ },
+ "SnapshotInformation" : {
+ "type" : "object",
+ "properties" : {
+ "indexDirPath" : {
+ "type" : "string",
+ "description" : "The path to the directory containing the index files."
+ },
+ "generationNumber" : {
+ "type" : "integer",
+ "description" : "The generation value for the snapshot.",
+ "format" : "int64"
+ }
+ },
+ "description" : "The collection of snapshots found for the requested core."
+ },
+ "CreateCollectionRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "replicationFactor" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "config" : {
+ "type" : "string"
+ },
+ "numShards" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "shardNames" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "pullReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "tlogReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "nrtReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "waitForFinalState" : {
+ "type" : "boolean"
+ },
+ "perReplicaState" : {
+ "type" : "boolean"
+ },
+ "alias" : {
+ "type" : "string"
+ },
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "async" : {
+ "type" : "string"
+ },
+ "router" : {
+ "$ref" : "#/components/schemas/CreateCollectionRouterProperties"
+ },
+ "nodeSet" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "createReplicas" : {
+ "type" : "boolean"
+ },
+ "shuffleNodes" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "CreateCollectionRouterProperties" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "field" : {
+ "type" : "string"
+ }
+ }
+ },
+ "CreateCollectionBackupRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "location" : {
+ "type" : "string"
+ },
+ "repository" : {
+ "type" : "string"
+ },
+ "followAliases" : {
+ "type" : "boolean"
+ },
+ "backupStrategy" : {
+ "type" : "string"
+ },
+ "snapshotName" : {
+ "type" : "string"
+ },
+ "incremental" : {
+ "type" : "boolean"
+ },
+ "backupConfigset" : {
+ "type" : "boolean"
+ },
+ "maxNumBackupPoints" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "async" : {
+ "type" : "string"
+ },
+ "extraProperties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "CreateCollectionSnapshotResponse" : {
+ "type" : "object",
+ "properties" : {
+ "collection" : {
+ "type" : "string",
+ "description" : "The name of the collection."
+ },
+ "followAliases" : {
+ "type" : "boolean",
+ "description" : "A flag that treats the collName parameter as a collection alias."
+ },
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "requestid" : {
+ "type" : "string"
+ },
+ "snapshot" : {
+ "type" : "string",
+ "description" : "The name of the snapshot to be created."
+ }
+ }
+ },
+ "CreateCollectionSnapshotRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "async" : {
+ "type" : "string"
+ },
+ "followAliases" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "CreateCoreBackupRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "repository" : {
+ "type" : "string",
+ "description" : "The name of the repository to be used for backup."
+ },
+ "location" : {
+ "type" : "string",
+ "description" : "The path where the backup will be created"
+ },
+ "shardBackupId" : {
+ "type" : "string"
+ },
+ "prevShardBackupId" : {
+ "type" : "string"
+ },
+ "commitName" : {
+ "type" : "string",
+ "description" : "The name of the commit which was used while taking a snapshot using the CREATESNAPSHOT command."
+ },
+ "incremental" : {
+ "type" : "boolean",
+ "description" : "To turn on incremental backup feature"
+ },
+ "async" : {
+ "type" : "string",
+ "description" : "Request ID to track this action which will be processed asynchronously."
+ },
+ "backupName" : {
+ "type" : "string",
+ "description" : "A descriptive name for the backup. Only used by non-incremental backups."
+ }
+ },
+ "description" : "Additional backup params"
+ },
+ "CreateReplicaRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "instanceDir" : {
+ "type" : "string"
+ },
+ "dataDir" : {
+ "type" : "string"
+ },
+ "ulogDir" : {
+ "type" : "string"
+ },
+ "route" : {
+ "type" : "string"
+ },
+ "nrtReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "tlogReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "pullReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "waitForFinalState" : {
+ "type" : "boolean"
+ },
+ "followAliases" : {
+ "type" : "boolean"
+ },
+ "async" : {
+ "type" : "string"
+ },
+ "node" : {
+ "type" : "string"
+ },
+ "skipNodeAssignment" : {
+ "type" : "boolean"
+ },
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "nodeSet" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "CreateShardRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "replicationFactor" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "nrtReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "tlogReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "pullReplicas" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "waitForFinalState" : {
+ "type" : "boolean"
+ },
+ "followAliases" : {
+ "type" : "boolean"
+ },
+ "async" : {
+ "type" : "string"
+ },
+ "properties" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ },
+ "shardName" : {
+ "type" : "string"
+ },
+ "createReplicas" : {
+ "type" : "boolean"
+ },
+ "nodeSet" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "BackupDeletionData" : {
+ "type" : "object",
+ "properties" : {
+ "startTime" : {
+ "type" : "string"
+ },
+ "backupId" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "size" : {
+ "type" : "integer",
+ "format" : "int64"
+ },
+ "numFiles" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "BackupDeletionResponseBody" : {
+ "type" : "object",
+ "properties" : {
+ "collection" : {
+ "type" : "string"
+ },
+ "deleted" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/BackupDeletionData"
+ }
+ },
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "requestid" : {
+ "type" : "string"
+ },
+ "success" : {
+ "type" : "object"
+ },
+ "failure" : {
+ "type" : "object"
+ },
+ "warning" : {
+ "type" : "string"
+ }
+ }
+ },
+ "PurgeUnusedResponse" : {
+ "type" : "object",
+ "properties" : {
+ "deleted" : {
+ "$ref" : "#/components/schemas/PurgeUnusedStats"
+ },
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "requestid" : {
+ "type" : "string"
+ },
+ "success" : {
+ "type" : "object"
+ },
+ "failure" : {
+ "type" : "object"
+ },
+ "warning" : {
+ "type" : "string"
+ }
+ }
+ },
+ "PurgeUnusedStats" : {
+ "type" : "object",
+ "properties" : {
+ "numBackupIds" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "numShardBackupIds" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "numIndexFiles" : {
+ "type" : "integer",
+ "format" : "int32"
+ }
+ }
+ },
+ "PurgeUnusedFilesRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "location" : {
+ "type" : "string"
+ },
+ "repositoryName" : {
+ "type" : "string"
+ },
+ "async" : {
+ "type" : "string"
+ }
+ }
+ },
+ "DeleteCollectionSnapshotResponse" : {
+ "type" : "object",
+ "properties" : {
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "requestid" : {
+ "type" : "string"
+ },
+ "collection" : {
+ "type" : "string",
+ "description" : "The name of the collection."
+ },
+ "snapshot" : {
+ "type" : "string",
+ "description" : "The name of the snapshot to be deleted."
+ },
+ "followAliases" : {
+ "type" : "boolean",
+ "description" : "A flag that treats the collName parameter as a collection alias."
+ }
+ }
+ },
+ "DeleteNodeRequestBody" : {
+ "type" : "object",
+ "properties" : {
+ "async" : {
+ "type" : "string",
+ "description" : "Request ID to track this action which will be processed asynchronously."
+ }
+ }
+ },
+ "ScaleCollectionRequestBody" : {
+ "required" : [ "numToDelete" ],
+ "type" : "object",
+ "properties" : {
+ "numToDelete" : {
+ "type" : "integer",
+ "format" : "int32"
+ },
+ "followAliases" : {
+ "type" : "boolean"
+ },
+ "deleteInstanceDir" : {
+ "type" : "boolean"
+ },
+ "deleteDataDir" : {
+ "type" : "boolean"
+ },
+ "deleteIndex" : {
+ "type" : "boolean"
+ },
+ "onlyIfDown" : {
+ "type" : "boolean"
+ },
+ "async" : {
+ "type" : "string"
+ }
+ }
+ },
+ "GetNodeCommandStatusResponse" : {
+ "type" : "object",
+ "properties" : {
+ "msg" : {
+ "type" : "string"
+ },
+ "response" : {
+ "type" : "object"
+ },
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
+ "$ref" : "#/components/schemas/ErrorInfo"
+ },
+ "STATUS" : {
+ "type" : "string"
+ }
+ }
+ },
+ "PublicKeyResponse" : {
+ "type" : "object",
+ "properties" : {
+ "responseHeader" : {
+ "$ref" : "#/components/schemas/ResponseHeader"
+ },
+ "error" : {
[... 474 lines stripped ...]