Resource URL: /platform/<<version=1>>/snapshot/snapshots-summary

    Overview: This resource applies the standard collection summary pattern to
              OneFS snapshots.

     Methods: GET

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

Method GET: Return summary information about snapshots.

       URL: GET /platform/<<version=1>>/snapshot/snapshots-summary

There are no query arguments for this method.

GET 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", 
      "properties": {
        "summary": {
          "type": "object", 
          "properties": {
            "count": {
              "required": true, 
              "type": "integer", 
              "description": "Total number of snapshots."
            }, 
            "aliases_count": {
              "required": true, 
              "type": "integer", 
              "description": "Total number of snapshot aliases."
            }, 
            "shadow_bytes": {
              "required": true, 
              "type": "integer", 
              "description": "Sum of shadow bytes of all snapshots."
            }, 
            "deleting_size": {
              "required": true, 
              "type": "integer", 
              "description": "Sum of sizes of delete-pending snapshots."
            }, 
            "active_size": {
              "required": true, 
              "type": "integer", 
              "description": "Sum of sizes of active snapshots."
            }, 
            "deleting_count": {
              "required": true, 
              "type": "integer", 
              "description": "Total number of delete-pending snapshots."
            }, 
            "active_count": {
              "required": true, 
              "type": "integer", 
              "description": "Total number of active snapshots."
            }, 
            "size": {
              "required": true, 
              "type": "integer", 
              "description": "Sum of sizes in bytes of all snapshots."
            }
          }
        }
      }
    }
  ]
}
