Resource URL: /platform/<<version=1>>/fsa/settings

    Overview: This resource exposes FSA settings.

     Methods: GET, PUT, DELETE

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

Method GET: List all settings.

       URL: GET /platform/<<version=1>>/fsa/settings

Query arguments:
scope=<enum> Where <enum> is one of effective, user, default.  If specified as
             effective or not specified, all fields are returned.  If specified
             as user, only fields with non-default values are shown.  If
             specified as default, the original values are returned.

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": {
        "settings": {
          "type": "object", 
          "properties": {
            "disk_usage_depth": {
              "type": "integer", 
              "description": "Maximum directory depth used for disk_usage question if not specified in the question."
            }, 
            "max_age": {
              "type": "integer", 
              "description": "Maximum age of non-pinned results in seconds."
            }, 
            "top_n_max": {
              "type": "integer", 
              "description": "Maximum number of items in a Top-N question result if not specified in the question."
            }, 
            "use_snapshot": {
              "type": "boolean", 
              "description": "If true, use a snapshot for consistency, otherwise analyze head."
            }, 
            "max_count": {
              "type": "integer", 
              "description": "Maximum number of non-pinned result sets to keep."
            }, 
            "default_template": {
              "type": "string", 
              "description": "Name of question template to use for new FSA jobs."
            }, 
            "squash_depth": {
              "type": "integer", 
              "description": "Squash depth to use for squash binning questions if not specified in the question."
            }
          }
        }
      }
    }
  ]
}

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

Method PUT: Modify one or more settings.

       URL: PUT /platform/<<version=1>>/fsa/settings

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "properties": {
    "disk_usage_depth": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Maximum directory depth used for disk_usage question if not specified in the question."
        }
      ]
    }, 
    "max_age": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Maximum age of non-pinned results in seconds."
        }
      ]
    }, 
    "top_n_max": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Maximum number of items in a Top-N question result if not specified in the question."
        }
      ]
    }, 
    "use_snapshot": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "boolean", 
          "description": "If true, use a snapshot for consistency, otherwise analyze head."
        }
      ]
    }, 
    "max_count": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Maximum number of non-pinned result sets to keep."
        }
      ]
    }, 
    "default_template": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "string", 
          "description": "Name of question template to use for new FSA jobs."
        }
      ]
    }, 
    "squash_depth": {
      "type": [
        {
          "enum": [
            "@DEFAULT"
          ], 
          "type": "string"
        }, 
        {
          "type": "integer", 
          "description": "Squash depth to use for squash binning questions if not specified in the question."
        }
      ]
    }
  }
}

There is no JSON response body for this method.

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

Method DELETE: Revert all settings to their defaults.

          URL: DELETE /platform/<<version=1>>/fsa/settings

There are no query arguments for this method.

There is no JSON response body for this method.
