Resource URL: /platform/<<version=1>>/snapshot/aliases

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

     Methods: GET, POST, DELETE

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

Method GET: List all or matching snapshot aliases.

       URL: GET /platform/<<version=1>>/snapshot/aliases

Query arguments:
  sort=<string> The field that will be used for sorting.  Choices are id, name,
                snapshot, and created.  Default is id.
limit=<integer> Return no more than this many results at once (see resume).
     dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the sort.
resume=<string> Continue returning results from previous call using this token
                (token should come from the previous call, resume cannot be
                used with other options).

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": {
        "aliases": {
          "items": {
            "type": "object", 
            "properties": {
              "target_name": {
                "required": true, 
                "type": "string", 
                "description": "The name of the snapshot pointed to."
              }, 
              "created": {
                "required": true, 
                "type": "integer", 
                "description": "The Unix Epoch time the snapshot alias was created."
              }, 
              "target_id": {
                "required": true, 
                "type": "integer", 
                "description": "The ID of the snapshot pointed to."
              }, 
              "id": {
                "required": true, 
                "type": "integer", 
                "description": "The system ID given to the snapshot alias."
              }, 
              "name": {
                "required": true, 
                "type": "string", 
                "description": "The user or system supplied snapshot alias name."
              }
            }
          }, 
          "type": "array"
        }, 
        "total": {
          "type": "integer", 
          "description": "Total number of items available."
        }, 
        "resume": {
          "required": false, 
          "type": [
            "string", 
            "null"
          ], 
          "description": "Resume token value to use in subsequent calls for continuation."
        }
      }
    }
  ]
}

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

Method POST: Create a new snapshot alias.

        URL: POST /platform/<<version=1>>/snapshot/aliases

There are no query arguments for this method.

Required POST request body fields:
name, target

POST request body schema:
{
  "type": "object", 
  "properties": {
    "name": {
      "required": true, 
      "type": "string", 
      "description": "The user or system supplied snapshot name."
    }, 
    "target": {
      "required": true, 
      "type": "string", 
      "description": "Snapshot name target for the alias."
    }
  }
}

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", 
      "properties": {
        "id": {
          "required": true, 
          "type": "integer", 
          "description": "The ID of the newly created snapshot alias."
        }
      }
    }
  ]
}

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

Method DELETE: Delete all or matching snapshot aliases.

          URL: DELETE /platform/<<version=1>>/snapshot/aliases

There are no query arguments for this method.

There is no JSON response body for this method.
