Resource URL: /platform/<<version=3>>/upgrade/cluster/upgrade

    Overview: Upgrade OneFS cluster.

     Methods: PUT, POST

********************************************************************************

Method PUT: Add nodes to a running upgrade.

       URL: PUT /platform/<<version=3>>/upgrade/cluster/upgrade

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "Add nodes to a running upgrade.", 
  "properties": {
    "nodes_to_rolling_upgrade": {
      "items": {
        "type": "integer", 
        "description": "The lnn of the node."
      }, 
      "type": "array", 
      "description": "The nodes (to be) scheduled for an existing upgrade ordered by queue position number. [<lnn-1>, <lnn-2>, ... ], 'All', null"
    }
  }
}

PUT response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "description": "Any empty JSON object is required.", 
      "properties": {}
    }
  ]
}

********************************************************************************

Method POST: The settings necessary to start an upgrade.

        URL: POST /platform/<<version=3>>/upgrade/cluster/upgrade

There are no query arguments for this method.

POST request body schema:
{
  "type": "object", 
  "description": "The settings necessary to start an upgrade.", 
  "properties": {
    "install_image_path": {
      "type": "string", 
      "description": "The location (path) of the upgrade image which must be within /ifs."
    }, 
    "upgrade_type": {
      "type": "string", 
      "description": "The type of upgrade to perform. One of the following values: 'rolling', 'simultaneous'"
    }, 
    "nodes_to_rolling_upgrade": {
      "items": {
        "type": "integer", 
        "description": "The lnn of the node."
      }, 
      "type": [
        "array", 
        "string", 
        "null"
      ], 
      "description": "The nodes (to be) scheduled for upgrade ordered by queue position number. Null if the cluster_state is 'partially upgraded' or upgrade_type is 'simultaneous'. One of the following values: [<lnn-1>, <lnn-2>, ... ], 'All', null"
    }, 
    "skip_optional": {
      "type": "boolean", 
      "description": "Used to indicate that the pre-upgrade check should be skipped"
    }
  }
}

POST response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "type": "object", 
      "description": "Any empty JSON object is required.", 
      "properties": {}
    }
  ]
}
