descriptorTimeSeriesGranularity.schema.json

{
  "meta:license": [
    "Copyright 2022 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/"
  ],
  "$id": "https://ns.adobe.com/xdm/descriptors/descriptorTimeSeriesGranularity",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Time-series Granularity Descriptor",
  "meta:extensible": false,
  "meta:extends": [
    "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor"
  ],
  "meta:abstract": false,
  "type": "object",
  "description": "Defines the granularity of time-series/summary data.",
  "definitions": {
    "descriptorTimeSeriesGranularity": {
      "properties": {
        "xdm:granularity": {
          "title": "Granularity",
          "description": "Granularity of the time-series / summary data.  The schema's `xdm:timestamp` field is the first timestamp in a period of this granularity.",
          "type": "string",
          "default": "day",
          "enum": ["hour", "day", "week", "month", "quarter", "year"],
          "meta:enum": {
            "hour": "Hourly data",
            "day": "Daily data",
            "week": "Weekly data",
            "month": "Monthly data",
            "quarter": "Quarterly data",
            "year": "Yearly data"
          },
          "meta:titleId": "descriptorTimeSeriesGranularity##xdm:granularity##title##56551",
          "meta:descriptionId": "descriptorTimeSeriesGranularity##xdm:granularity##description##79851"
        }
      },
      "required": ["xdm:granularity"]
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor"
    },
    {
      "$ref": "#/definitions/descriptorTimeSeriesGranularity"
    }
  ],
  "meta:status": "experimental",
  "meta:createdDate": "2022-03-28",
  "meta:titleId": "descriptorTimeSeriesGranularity##title##26941",
  "meta:descriptionId": "descriptorTimeSeriesGranularity##description##51361"
}