| { |
| "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html", |
| "description": "Actions that are peformed on individual cores, such as reloading, swapping cores, renaming, and others.", |
| "methods": [ |
| "POST" |
| ], |
| "url": { |
| "paths": [ |
| "/cores/{core}" |
| ] |
| }, |
| "commands": { |
| "reload": { |
| "type":"object", |
| "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-reload", |
| "description": "Reloads a core. This is useful when you have made changes on disk such as editing the schema or solrconfig.xml files. Most APIs reload cores automatically, so this should not be necessary if changes were made with those APIs." |
| }, |
| "swap": { |
| "type":"object", |
| "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-swap", |
| "description": "Swaps the names of two existing Solr cores. This can be used to swap new content into production. The former core can be swapped back if necessary. Using this API is not supported in SolrCloud mode.", |
| "properties": { |
| "with": { |
| "type": "string", |
| "description": "The name of the other core to be swapped (the first core name is included in the request)." |
| }, |
| "async": { |
| "type": "string", |
| "description": "Defines a request ID that can be used to track this action after it's submitted. The action will be processed asynchronously when this is defined." |
| } |
| }, |
| "required": [ |
| "with" |
| ] |
| }, |
| "rename": { |
| "type": "object", |
| "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-rename", |
| "description": "Change the name of a core.", |
| "properties": { |
| "to": { |
| "type": "string", |
| "description": "The new name for the core." |
| }, |
| "async": { |
| "type": "string", |
| "description": "Defines a request ID that can be used to track this action after it's submitted. The action will be processed asynchronously when this is defined." |
| } |
| }, |
| "required": [ |
| "to" |
| ] |
| }, |
| "unload": { |
| "type": "object", |
| "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-unload", |
| "description": "Removes a core. Active requests would continue to be processed, but new requests will not be sent to the new core. If a core is registered under more than one name, only the name given in the request is removed.", |
| "properties": { |
| "deleteIndex": { |
| "type": "boolean", |
| "description": "If true, the index will be removed while unloading the core.", |
| "default": "false" |
| }, |
| "deleteDataDir": { |
| "type": "boolean", |
| "description": "If true, the data directory and all sub-directories will be removed while unloading the core.", |
| "default": "false" |
| }, |
| "deleteInstanceDir": { |
| "type": "boolean", |
| "description": "If true, everything related to the core, including the index, data, and conf directories, will be removed while unloading the core.", |
| "default": "false" |
| }, |
| "async": { |
| "type": "string", |
| "description": "Defines a request ID that can be used to track this action after it's submitted. The action will be processed asynchronously when this is defined." |
| } |
| } |
| }, |
| "merge-indexes": { |
| "type":"object", |
| "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-mergeindexes", |
| "description":"Merges one or more indexes to another index. The indexes must have completed commits, and should be locked against writes until the merge is complete to avoid index corruption. The target core (which is the core that should be used as the endpoint for this command) must exist before using this command. A commit should also be performed on this core after the merge is complete.", |
| "properties": { |
| "indexDir": { |
| "type": "array", |
| "description": "A comma-separated list index directories for each source core that will be merged with the target core.", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "srcCore": { |
| "type": "array", |
| "description": "A comma-separated list of the names of each source core to be merged with the target core.", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "async": { |
| "type": "string", |
| "description": "Defines a request ID that can be used to track this action after it's submitted. The action will be processed asynchronously when this is defined." |
| } |
| } |
| }, |
| "split": { "#include": "cores.core.Commands.split"}, |
| "request-recovery": { |
| "type":"object", |
| "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-requestrecovery", |
| "description": "Manually asks a core to recover by synching with a leader. It may help SolrCloud clusters where a node refuses to come back up. However, it is considered an expert-level command, and should be used very carefully." |
| }, |
| "force-prepare-for-leadership": { |
| "type": "object", |
| "description": "An internal API used by the Collections API to force leader election. This should not be used directly by end-users." |
| }, |
| "prep-recovery": { |
| "type": "object", |
| "additionalProperties": true, |
| "description": "An internal API used by the Collections API. This should not be used directly by end-users." |
| }, |
| "request-apply-updates": { |
| "type": "object", |
| "additionalProperties": true, |
| "description": "An internal API used by the Collections API. This should not be used directly by end-users." |
| }, |
| "request-sync-shard": { |
| "type": "object", |
| "additionalProperties": true, |
| "description": "An internal API used by the Collections API. This should not be used directly by end-users." |
| }, |
| "request-buffer-updates": { |
| "type": "object", |
| "additionalProperties": true, |
| "description": "An internal API used by the Collections API. This should not be used directly by end-users." |
| } |
| } |
| } |
