quota.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$schema": "http://json-schema.org/draft-06/schema#",
  "$id": "https://ns.adobe.com/xdm/content/repository-policies/quota",
  "title": "Storage Quota",
  "description": "Representation of hard and soft quota on content storage",
  "meta:extensible": true,
  "definitions": {
    "quota": {
      "type": "object",
      "properties": {
        "xdm:enforcement": {
          "name": "Enforcement Type",
          "decription":
            "Determines whether the quota is being enforced (hard quota) or only reported on (soft quota)",
          "type": "string",
          "enum": ["hard", "soft"]
        },
        "xdm:amount": {
          "name": "Quota amount",
          "decription":
            "The quota against which consumption is measured at the point of the repository that links to this document.",
          "type": "number",
          "minimum": 0
        },
        "xdm:consumed": {
          "name": "Currently consumed amount",
          "decription":
            "The amount currently consumed against the quota at the point of the repository that links to this document.",
          "meta:usereditable": false,
          "type": "number"
        },
        "xdm:unit": {
          "name": "Unit of the 'limit' and 'consumed' properties",
          "decription":
            "The unit that is used to determine the quota and measure consumption. This property is optional, but fixed, i.e. it allows consumers to quickly understand the value just by looking at the JSON response from the API.",
          "meta:usereditable": false,
          "type": "string",
          "const": "Bytes"
        }
      },
      "required": ["xdm:enforcement", "xdm:amount"]
    }
  },
  "type": "object",
  "$ref": "#/definitions/quota",
  "meta:status": "experimental"
}