Resource URL: /platform/<<version=1>>/storagepool/compatibilities/class/active

    Overview: n/a

     Methods: GET, POST

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

Method GET: Get a list of active compatibilities

       URL: GET /platform/<<version=1>>/storagepool/compatibilities/class/active

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "active": {
      "items": {
        "type": "object", 
        "properties": {
          "class_2": {
            "required": true, 
            "type": "string", 
            "description": "The second class in an active compatibility"
          }, 
          "class_1": {
            "required": true, 
            "type": "string", 
            "description": "The first class in an active compatibility"
          }, 
          "id": {
            "required": true, 
            "type": "integer", 
            "description": "The id of this active compatibility"
          }
        }
      }, 
      "type": "array"
    }, 
    "total": {
      "type": "integer", 
      "description": "Total number of items available."
    }
  }
}

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

Method POST: Create a new compatibility

        URL: POST
             /platform/<<version=1>>/storagepool/compatibilities/class/active

There are no query arguments for this method.

Required POST request body fields:
class_2, class_1

POST request body schema:
{
  "type": "object", 
  "properties": {
    "assess": {
      "type": "boolean", 
      "description": "Do not create compatibility, only assess if creation is possible."
    }, 
    "class_2": {
      "required": true, 
      "type": "string", 
      "description": "The second class in the desired compatibility"
    }, 
    "class_1": {
      "required": true, 
      "type": "string", 
      "description": "The first class in the desired compatibility"
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "merges": {
      "items": {
        "type": "object", 
        "properties": {
          "result_name": {
            "required": true, 
            "type": "string", 
            "description": "The name of the nodepool all others will merge into"
          }, 
          "ids": {
            "items": {
              "type": "integer"
            }, 
            "required": true, 
            "type": "array", 
            "description": "The nodepool ids that will be merged"
          }, 
          "names": {
            "items": {
              "type": "string"
            }, 
            "required": true, 
            "type": "array", 
            "description": "The nodepool names that will be merged, in the sameorder as the ids"
          }
        }
      }, 
      "required": false, 
      "type": "array", 
      "description": "A list of all merges that will occur given this compatibility operation"
    }, 
    "message": {
      "required": true, 
      "type": "string", 
      "description": "A string describing the effects of the compatibility operation."
    }, 
    "splits": {
      "items": {
        "type": "object", 
        "properties": {
          "tier_name": {
            "required": true, 
            "type": "string", 
            "description": "A message explaining how the nodepools tier membership will change."
          }, 
          "id": {
            "required": true, 
            "type": "integer", 
            "description": "The nodepool id that will be split"
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "The nodepool name that will be split"
          }
        }
      }, 
      "required": false, 
      "type": "array", 
      "description": "A list of all splits that will occur given this compatibility operation"
    }
  }
}
