apispec.cluster.Commands.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of solr-solrj Show documentation

Apache Solr Solrj

There is a newer version: 9.7.0

{
  "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
  "description": "Cluster-wide commands to assign roles to nodes, remove role assignments, or add, edit or remove a cluster-wide property.",
  "methods": [
    "POST"
  ],
  "url": {
    "paths": [
      "/cluster"
    ]
  },
  "commands": {
    "add-role":{
      "type":"object",
      "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#addrole",
      "description":"Assign a specific role to a node in the cluster.",
      "properties": {
        "role": {
          "type": "string",
          "description": "The name of the role. The only supported role is 'overseer'."

        },
        "node": {
          "type": "string",
          "description": "The name of the node. It is possible to assign a role even before that node is started."

        }
      },
      "required": [
        "role",
        "node"
      ]
    },
    "remove-role":{
      "type":"object",
      "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#removerole",
      "description":"Unassign a role from a node in the cluster.",
      "properties": {
        "role": {
          "type": "string",
          "description": "The name of the role. The only supported role as of now is 'overseer'."

        },
        "node": {
          "type": "string",
          "description": "The name of the node where the role should be removed."
        }
      },
      "required": [
        "role",
        "node"
      ]
    },
    "set-property": {
      "type": "object",
      "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#clusterprop",
      "description": "Add, edit, or delete a cluster-wide property.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the property"
        },
        "val": {
          "type": ["string","boolean","null"],
          "description": "The value of the property. If the value is empty or null, the property is unset."
        }
      },
      "required": [
        "name",
        "val"
      ]
    }
  }
}