diff --git a/package.json b/package.json index 00f90c94f..4c37deefb 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "aem_user": "packageUser", "aem_password": "override me securely", "markdown-importer-version": "0.0.4", - "schemas": 139 + "schemas": 141 }, "scripts": { "clean": "rm -rf docs/reference", diff --git a/schemas/common/geounit.example.1.json b/schemas/common/geounit.example.1.json new file mode 100644 index 000000000..1fa256767 --- /dev/null +++ b/schemas/common/geounit.example.1.json @@ -0,0 +1,7 @@ +{ + "@id": "https://data.adobe.io/geo-san-jose", + "xdm:label": "San Jose", + "xdm:parentGeoUnit": { + "@id": "https://data.adobe.io/geo-sf-bay-area" + } +} \ No newline at end of file diff --git a/schemas/common/geounit.schema.json b/schemas/common/geounit.schema.json new file mode 100644 index 000000000..bc9cd5b65 --- /dev/null +++ b/schemas/common/geounit.schema.json @@ -0,0 +1,44 @@ +{ + "meta:license": [ + "Copyright 2018 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/common/geounit", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "title": "Geo Unit", + "description": "The geographical unit of a parent geographical unit.", + "definitions": { + "geounit": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri", + "description": + "The ID associated with this geographical unit." + }, + "xdm:label": { + "title": "Friendly lable of the geographical unit.", + "type": "string", + "description": "The user-friendly name for the geographical unit." + }, + "xdm:parentGeoUnit": { + "title": "Parent Geographical Unit.", + "$ref": "https://ns.adobe.com/xdm/common/geounit", + "description": "Parent geographical unit of the current geographical unit in the geographical heirarchy." + } + }, + "required": ["@id"] + } + }, + "allOf": [ + { + "$ref": "#/definitions/geounit" + } + ], + "meta:status": "experimental" +} diff --git a/schemas/common/orgunit.example.1.json b/schemas/common/orgunit.example.1.json new file mode 100644 index 000000000..1ca7e2c66 --- /dev/null +++ b/schemas/common/orgunit.example.1.json @@ -0,0 +1,7 @@ +{ + "@id": "https://data.adobe.io/org-apparals-men", + "xdm:label": "Men Apparals", + "xdm:parentOrgUnit": { + "@id": "https://data.adobe.io/org-apparals" + } +} \ No newline at end of file diff --git a/schemas/common/orgunit.schema.json b/schemas/common/orgunit.schema.json new file mode 100644 index 000000000..7ddfb9fad --- /dev/null +++ b/schemas/common/orgunit.schema.json @@ -0,0 +1,44 @@ +{ + "meta:license": [ + "Copyright 2018 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/common/orgunit", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "title": "Org Unit", + "description": "The organisation unit of a parent organisation.", + "definitions": { + "orgunit": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri", + "description": + "The ID associated with this organisation unit." + }, + "xdm:label": { + "title": "Friendly lable of the organisation unit.", + "type": "string", + "description": "The user-friendly name for the organisation unit." + }, + "xdm:parentOrgUnit": { + "title": "Parent Organisation.", + "$ref": "https://ns.adobe.com/xdm/common/orgunit", + "description": "The parent organisation unit of the current organisation unit in the org heirarchy." + } + }, + "required": ["@id"] + } + }, + "allOf": [ + { + "$ref": "#/definitions/orgunit" + } + ], + "meta:status": "experimental" +} diff --git a/schemas/context/profile.example.1.json b/schemas/context/profile.example.1.json index 7b3ebc184..71ef08ae1 100644 --- a/schemas/context/profile.example.1.json +++ b/schemas/context/profile.example.1.json @@ -53,5 +53,11 @@ "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided", "https://ns.adobe.com/xdm/channels/apns": "not_provided", "xdm:globalOptout": false + }, + "xdm:orgUnit": { + "@id" : "https://data.adobe.io/org-apparals-men" + }, + "xdm:geoUnit": { + "@id" : "https://data.adobe.io/geo-france" } } diff --git a/schemas/context/profile.schema.json b/schemas/context/profile.schema.json index a0a153d61..5e6e53342 100644 --- a/schemas/context/profile.schema.json +++ b/schemas/context/profile.schema.json @@ -80,17 +80,17 @@ "$ref": "https://ns.adobe.com/xdm/context/pushnotificationtoken" } }, - "xdm:orgUnitID": { - "title": "Organizational Unit Identifier", - "type": "string", + "xdm:orgUnit": { + "title": "Organizational Unit", + "$ref": "https://ns.adobe.com/xdm/common/orgunit", "description": - "The unit ID within the organization owning the profile. This ID can be used to reference the organization details maintained in another dataset." + "The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset." }, - "xdm:geoUnitID": { - "title": "Geographical Unit Identifier", - "type": "string", + "xdm:geoUnit": { + "title": "Geographical Unit", + "$ref": "https://ns.adobe.com/xdm/common/geounit", "description": - "The geographical unit ID within the organization owning the profile. This ID can be used to reference the geographical information maintained in another dataset." + "The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset." }, "xdm:organizations": { "title": "Organizations",