diff --git a/docs/reference/README.md b/docs/reference/README.md index b94d458565..555a6eaf30 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -4,6 +4,22 @@ +## /assets/ + +* [Aggregated Asset](./assets/aggregated-asset.schema.md) – `https://ns.adobe.com/xdm/assets/aggregated-asset` (Experimental) +* [Artboard](./assets/artboard.schema.md) – `https://ns.adobe.com/xdm/assets/artboard` (Experimental) +* [Asset](./assets/asset.schema.md) – `https://ns.adobe.com/xdm/assets/asset` (Experimental) +* [Copyright Owner](./assets/copyright-owner.schema.md) – `https://ns.adobe.com/xdm/assets/copyright-owner` (Stabilizing) +* [Font](./assets/font.schema.md) – `https://ns.adobe.com/xdm/assets/font` (Experimental) +* [Image](./assets/image.schema.md) – `https://ns.adobe.com/xdm/assets/image` (Experimental) +* [Language Alternative](./assets/language-alternative.schema.md) – `https://ns.adobe.com/xdm/assets/language-alternative` (Stabilizing) +* [Layer](./assets/layer.schema.md) – `https://ns.adobe.com/xdm/assets/layer` (Experimental) +* [Layer Group](./assets/layer-group.schema.md) – `https://ns.adobe.com/xdm/assets/layer-group` (Experimental) +* [Rectangular Object (measured in variable unit)](./assets/variable-unit-rectangular.schema.md) – `https://ns.adobe.com/xdm/assets/variable-unit-rectangular` (Experimental) +* [Resource Event](./assets/resource-event.schema.md) – `https://ns.adobe.com/xdm/assets/resource-event` (Experimental) +* [Simple Rectangular Area](./assets/rectangular.schema.md) – `https://ns.adobe.com/xdm/assets/rectangular` (Stabilizing) +* [Video](./assets/video.schema.md) – `https://ns.adobe.com/xdm/assets/video` (Experimental) + ## /channels/ * [ADM](./channels/adm.schema.md) – `https://ns.adobe.com/xdm/channels/adm` (Experimental) @@ -27,6 +43,16 @@ * [Web](./channels/mobile-app.schema.md) – `https://ns.adobe.com/xdm/channels/mobile-app` (Experimental) * [Web](./channels/web.schema.md) – `https://ns.adobe.com/xdm/channels/web` (Experimental) +## /content/ + +* [Component Container](./content/component-container.schema.md) – `https://ns.adobe.com/xdm/content/component-container` (Experimental) +* [Componentized Page](./content/componentized-page.schema.md) – `https://ns.adobe.com/xdm/content/componentized-page` (Experimental) +* [Content](./content/content.schema.md) – `https://ns.adobe.com/xdm/content/content` (Experimental) +* [Content Repository](./content/repository.schema.md) – `https://ns.adobe.com/xdm/content/repository` (Experimental) +* [Page Component](./content/page-component.schema.md) – `https://ns.adobe.com/xdm/content/page-component` (Experimental) +* [Product](./content/product.schema.md) – `https://ns.adobe.com/xdm/context/product` (Experimental) +* [Product List Item](./content/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` (Experimental) + ## /common/ * [Address](./common/address.schema.md) – `https://ns.adobe.com/xdm/common/address` (Stabilizing) @@ -42,32 +68,6 @@ * [Page](./common/page.schema.md) – `https://ns.adobe.com/xdm/common/page` (Experimental) * [Principal](./common/principal.schema.md) – `https://ns.adobe.com/xdm/common/principal` (Experimental) -## /assets/ - -* [Aggregated Asset](./assets/aggregated-asset.schema.md) – `https://ns.adobe.com/xdm/assets/aggregated-asset` (Experimental) -* [Artboard](./assets/artboard.schema.md) – `https://ns.adobe.com/xdm/assets/artboard` (Experimental) -* [Asset](./assets/asset.schema.md) – `https://ns.adobe.com/xdm/assets/asset` (Experimental) -* [Copyright Owner](./assets/copyright-owner.schema.md) – `https://ns.adobe.com/xdm/assets/copyright-owner` (Stabilizing) -* [Font](./assets/font.schema.md) – `https://ns.adobe.com/xdm/assets/font` (Experimental) -* [Image](./assets/image.schema.md) – `https://ns.adobe.com/xdm/assets/image` (Experimental) -* [Language Alternative](./assets/language-alternative.schema.md) – `https://ns.adobe.com/xdm/assets/language-alternative` (Stabilizing) -* [Layer](./assets/layer.schema.md) – `https://ns.adobe.com/xdm/assets/layer` (Experimental) -* [Layer Group](./assets/layer-group.schema.md) – `https://ns.adobe.com/xdm/assets/layer-group` (Experimental) -* [Rectangular Object (measured in variable unit)](./assets/variable-unit-rectangular.schema.md) – `https://ns.adobe.com/xdm/assets/variable-unit-rectangular` (Experimental) -* [Resource Event](./assets/resource-event.schema.md) – `https://ns.adobe.com/xdm/assets/resource-event` (Experimental) -* [Simple Rectangular Area](./assets/rectangular.schema.md) – `https://ns.adobe.com/xdm/assets/rectangular` (Stabilizing) -* [Video](./assets/video.schema.md) – `https://ns.adobe.com/xdm/assets/video` (Experimental) - -## /content/ - -* [Component Container](./content/component-container.schema.md) – `https://ns.adobe.com/xdm/content/component-container` (Experimental) -* [Componentized Page](./content/componentized-page.schema.md) – `https://ns.adobe.com/xdm/content/componentized-page` (Experimental) -* [Content](./content/content.schema.md) – `https://ns.adobe.com/xdm/content/content` (Experimental) -* [Content Repository](./content/repository.schema.md) – `https://ns.adobe.com/xdm/content/repository` (Experimental) -* [Page Component](./content/page-component.schema.md) – `https://ns.adobe.com/xdm/content/page-component` (Experimental) -* [Product](./content/product.schema.md) – `https://ns.adobe.com/xdm/context/product` (Experimental) -* [Product List Item](./content/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem` (Experimental) - ## /context/ * [Ad Asset Reference](./context/advertising-timed-asset-reference.schema.md) – `https://ns.adobe.com/xdm/context/advertising-timed-asset-reference` (Experimental) @@ -192,6 +192,12 @@ * [viewable-midpoints](./data/viewablemidpoints.schema.md) – `https://ns.adobe.com/xdm/data/viewablemidpoints` (Stabilizing) * [viewable-third-quartiles](./data/viewablethirdquartiles.schema.md) – `https://ns.adobe.com/xdm/data/viewablethirdquartiles` (Stabilizing) +## /content/repository-policies/ + +* [At-Rest Encryption](./content/repository-policies/encryption.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/encryption` (Experimental) +* [Storage Quota](./content/repository-policies/quota.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/quota` (Experimental) +* [Versioning](./content/repository-policies/versioning.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/versioning` (Experimental) + ## /common/descriptors/ * [Item Selector](./common/descriptors/itemselector.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/itemselector` (Experimental) @@ -208,12 +214,6 @@ * [Unpublished Event](./common/event/unpublished.schema.md) – `https://ns.adobe.com/xdm/common/event/unpublished` (Experimental) * [Updated Event](./common/event/updated.schema.md) – `https://ns.adobe.com/xdm/common/event/updated` (Experimental) -## /content/repository-policies/ - -* [At-Rest Encryption](./content/repository-policies/encryption.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/encryption` (Experimental) -* [Storage Quota](./content/repository-policies/quota.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/quota` (Experimental) -* [Versioning](./content/repository-policies/versioning.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/versioning` (Experimental) - ## /external/activity-streams-2/ * [Activity](./external/activity-streams-2/activity.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/activity` (Experimental) @@ -228,6 +228,11 @@ * [Object](./external/activity-streams-2/object.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/object` (Experimental) * [RDF Language Tagged String](./external/activity-streams-2/rdf-langstring.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring` (Experimental) +## /external/hal/ + +* [HAL Link](./external/hal/hal-link.schema.md) – `https://ns.adobe.com/xdm/external/hal/link` (Experimental) +* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource` (Experimental) + ## /external/iptc/ * [Creator](./external/iptc/creator.schema.md) – `http://www.iptc.org/creator` (Experimental) @@ -236,11 +241,6 @@ * [Season](./external/iptc/season.schema.md) – `http://www.iptc.org/episode` (Experimental) * [Series](./external/iptc/series.schema.md) – `http://www.iptc.org/series` (Experimental) -## /external/hal/ - -* [HAL Link](./external/hal/hal-link.schema.md) – `https://ns.adobe.com/xdm/external/hal/link` (Experimental) -* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource` (Experimental) - ## /external/repo/ * [Access Control Entry](./external/repo/accesscontrolentry.schema.md) – `https://ns.adobe.com/xdm/external/repo/accesscontrolentry` (Experimental) diff --git a/docs/reference/channels/webpage.schema.json b/docs/reference/channels/webpage.schema.json deleted file mode 100644 index 5a0745fa4f..0000000000 --- a/docs/reference/channels/webpage.schema.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "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/" - ], - "$id": "https://ns.adobe.com/xdm/channels/webpage", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Web Page", - "type": "object", - "description": "Information about the web page of the `ExperienceEvent`.", - "definitions": { - "webpage": { - "properties": { - "xdm:section": { - "title": "Section", - "type": "string", - "description": "The section of the web page." - }, - "xdm:name": { - "title": "Name", - "type": "string", - "description": "The name of the web page." - }, - "xdm:URL": { - "title": "URL", - "type": "string", - "format": "uri", - "description": "The web page URL." - }, - "xdm:server": { - "title": "Server", - "type": "string", - "format": "hostname", - "description": "The server hosts the web page." - }, - "xdm:isErrorPage": { - "title": "Is Error Page", - "type": "boolean", - "description": "Indicate if the page is error page or not." - }, - "xdm:isHomePage": { - "title": "Is Home Page", - "type": "boolean", - "description": "Indicate if the page is home page or not." - }, - "xdm:referrer": { - "title": "Referrer", - "type": "object", - "description": "The referrer of the web page.", - "properties": { - "URL": { - "title": "URL", - "type": "string", - "description": "The referrer URL." - }, - "domain": { - "title": "Domain", - "type": "string", - "description": "The domain of the referrer." - }, - "type": { - "title": "Type", - "type": "string", - "description": "The referrer type." - } - } - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/webpage" - } - ], - "meta:status": "experimental", - "examples": [ - { - "xdm:section": "Search section", - "xdm:name": "search", - "xdm:URL": "https://www.google.com", - "xdm:isErrorPage": false, - "xdm:isHomePage": true - } - ] -} \ No newline at end of file diff --git a/docs/reference/channels/webpage.schema.md b/docs/reference/channels/webpage.schema.md deleted file mode 100644 index bd33bc3f1d..0000000000 --- a/docs/reference/channels/webpage.schema.md +++ /dev/null @@ -1,246 +0,0 @@ - -# Web Page Schema - -``` -https://ns.adobe.com/xdm/channels/webpage -``` - -Information about the web page of the `ExperienceEvent`. - -| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | -|----------|------------|--------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [channels/webpage.schema.json](channels/webpage.schema.json) | - -## Web Page Example -```json -{ - "xdm:section": "Search section", - "xdm:name": "search", - "xdm:URL": "https://www.google.com", - "xdm:isErrorPage": false, - "xdm:isHomePage": true -} -``` - -# Web Page Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [xdm:URL](#xdmurl) | `string` | Optional | Web Page (this schema) | -| [xdm:isErrorPage](#xdmiserrorpage) | `boolean` | Optional | Web Page (this schema) | -| [xdm:isHomePage](#xdmishomepage) | `boolean` | Optional | Web Page (this schema) | -| [xdm:name](#xdmname) | `string` | Optional | Web Page (this schema) | -| [xdm:referrer](#xdmreferrer) | `object` | Optional | Web Page (this schema) | -| [xdm:section](#xdmsection) | `string` | Optional | Web Page (this schema) | -| [xdm:server](#xdmserver) | `string` | Optional | Web Page (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## xdm:URL -### URL - -The web page URL. - -`xdm:URL` -* is optional -* type: `string` -* defined in this schema - -### xdm:URL Type - - -`string` -* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) - - - - - - -## xdm:isErrorPage -### Is Error Page - -Indicate if the page is error page or not. - -`xdm:isErrorPage` -* is optional -* type: `boolean` -* defined in this schema - -### xdm:isErrorPage Type - - -`boolean` - - - - - -## xdm:isHomePage -### Is Home Page - -Indicate if the page is home page or not. - -`xdm:isHomePage` -* is optional -* type: `boolean` -* defined in this schema - -### xdm:isHomePage Type - - -`boolean` - - - - - -## xdm:name -### Name - -The name of the web page. - -`xdm:name` -* is optional -* type: `string` -* defined in this schema - -### xdm:name Type - - -`string` - - - - - - -## xdm:referrer -### Referrer - -The referrer of the web page. - -`xdm:referrer` -* is optional -* type: `object` -* defined in this schema - -### xdm:referrer Type - - -`object` with following properties: - - -| Property | Type | Required -|----------|------|----------| -| `URL`| string | Optional | -| `domain`| string | Optional | -| `type`| string | Optional | - - - -#### URL -##### URL - -The referrer URL. - -`URL` -* is optional -* type: `string` - -##### URL Type - - -`string` - - - - - - - - -#### domain -##### Domain - -The domain of the referrer. - -`domain` -* is optional -* type: `string` - -##### domain Type - - -`string` - - - - - - - - -#### type -##### Type - -The referrer type. - -`type` -* is optional -* type: `string` - -##### type Type - - -`string` - - - - - - - - - - - -## xdm:section -### Section - -The section of the web page. - -`xdm:section` -* is optional -* type: `string` -* defined in this schema - -### xdm:section Type - - -`string` - - - - - - -## xdm:server -### Server - -The server hosts the web page. - -`xdm:server` -* is optional -* type: `string` -* defined in this schema - -### xdm:server Type - - -`string` -* format: `hostname` – Domain Name (according to [RFC 1034, section 3.1](https://tools.ietf.org/html/rfc1034)) - - - - - diff --git a/docs/reference/common/accesscontrolentry.schema.json b/docs/reference/common/accesscontrolentry.schema.json deleted file mode 100644 index f1db9d512e..0000000000 --- a/docs/reference/common/accesscontrolentry.schema.json +++ /dev/null @@ -1,122 +0,0 @@ -{ - "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/accesscontrolentry", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Access Control Entry", - "description": "Schema for the Access Control Entry for the Access Control List of a resource", - "type": "object", - "definitions": { - "acl": { - "title": "Access Control List", - "description": "Schema for the Access Control List of a resource", - "type": "array", - "items": { - "$ref": "https://ns.adobe.com/xdm/common/accesscontrolentry" - } - }, - "ace": { - "type": "object", - "properties": { - "repo:principal": { - "anyOf": [ - { - "$ref": "https://ns.adobe.com/xdm/common/principal" - }, - { - "description": "A special principal to which the entry applies. 'Authenticated' refers to any authenticated user, 'Unauthenticated' refers to an unknown user, 'all' refers to any user regardless of authenticated or not.", - "meta:enum": { - "authenticated": "A special Principal which is implicitly part of any Subject relating to an authenticated (identified) user.", - "unauthenticated": "A special Principal representing an unknown user. If a session is established without credentials, such as an HTTP request without the Authentication header, a Subject is used consisting of the Unauthenticated Principal.", - "all": "A special Principal representing all users." - } - } - ] - }, - "repo:privilege": { - "description": "Privilege granted or denied to the Principal", - "anyOf": [ - { - "type": "array", - "items": { - "$ref": "#/definitions/privilege" - } - }, - { - "$ref": "#/definitions/privilege" - } - ] - }, - "repo:relations": { - "description": "List of relation link types to which this privilege applies", - "type": "array", - "items": { - "type": "string" - } - }, - "repo:modifier": { - "description": "Optional modified to the privilege: either grant or deny to grant or deny, resp., the privilege. The default modifier is grant if this property is missing or has an invalid value.", - "type": "string", - "meta:enum": { - "grant": "Permission is granted to the Principal.", - "deny": "Permission is denied to the Principal." - }, - "default": "grant" - } - }, - "required": [ - "repo:principal", - "repo:privilege" - ], - "additionalProperties": { - "type": [ - "object", - "array", - "string" - ] - } - }, - "privilege": { - "type": "string", - "meta:enum": { - "ack": "Existence of the resource can be confirmed.", - "read": "The resource can be retrieved.", - "write": "The resource can be updated.", - "modify": "Implies `read` and `write` privileges.", - "attach": "Attached resources can be created.", - "delete": "The resource can be deleted.", - "full": "Implies all of the above privileges." - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/ace" - } - ], - "examples": [ - { - "repo:principal": "authenticated", - "repo:privilege": "read", - "repo:modifier": "grant" - }, - { - "repo:principal": { - "xdm:provider": { - "@id": "https://ims-na1.adobelogin.com/" - }, - "@id": "C0B648DE57D701277F000101@AdobeID", - "@type": "https://ns.adobe.com/xdm-extensions/ims/user" - }, - "repo:privilege": [ - "write", - "delete" - ], - "repo:modifier": "grant" - } - ] -} \ No newline at end of file diff --git a/docs/reference/common/accesscontrolentry.schema.md b/docs/reference/common/accesscontrolentry.schema.md deleted file mode 100644 index 7e47655602..0000000000 --- a/docs/reference/common/accesscontrolentry.schema.md +++ /dev/null @@ -1,166 +0,0 @@ - -# Access Control Entry Schema - -``` -https://ns.adobe.com/xdm/common/accesscontrolentry -``` - -Schema for the Access Control Entry for the Access Control List of a resource - -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [common/accesscontrolentry.schema.json](common/accesscontrolentry.schema.json) | - -## Access Control Entry Examples - -```json -{ - "repo:principal": "authenticated", - "repo:privilege": "read", - "repo:modifier": "grant" -} -``` - -```json -{ - "repo:principal": { - "xdm:provider": { - "@id": "https://ims-na1.adobelogin.com/" - }, - "@id": "C0B648DE57D701277F000101@AdobeID", - "@type": "https://ns.adobe.com/xdm-extensions/ims/user" - }, - "repo:privilege": [ - "write", - "delete" - ], - "repo:modifier": "grant" -} -``` - - -# Access Control Entry Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [repo:modifier](#repomodifier) | `string` | Optional | Access Control Entry (this schema) | -| [repo:principal](#repoprincipal) | complex | Optional | Access Control Entry (this schema) | -| [repo:privilege](#repoprivilege) | complex | Optional | Access Control Entry (this schema) | -| [repo:relations](#reporelations) | `string[]` | Optional | Access Control Entry (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## repo:modifier - -Optional modified to the privilege: either grant or deny to grant or deny, resp., the privilege. The default modifier is grant if this property is missing or has an invalid value. - -`repo:modifier` -* is optional -* type: `string` -* defined in this schema - -### repo:modifier Type - - -`string` - - - -### repo:modifier Known Values -| Value | Description | -|-------|-------------| -| `grant` | Permission is granted to the Principal. | -| `deny` | Permission is denied to the Principal. | - - - - -## repo:principal - - -`repo:principal` -* is optional -* type: complex -* defined in this schema - -### repo:principal Type - - -**Any** following *options* needs to be fulfilled. - - -#### Option 1 - - -* []() – `https://ns.adobe.com/xdm/common/principal` - - -#### Option 2 - - - - - - - -## repo:privilege - -Privilege granted or denied to the Principal - -`repo:privilege` -* is optional -* type: complex -* defined in this schema - -### repo:privilege Type - - -**Any** following *options* needs to be fulfilled. - - -#### Option 1 - - -Array type: - -All items must be of the type: -* []() – `#/definitions/privilege` - - - - - -#### Option 2 - - -* []() – `#/definitions/privilege` - - - - - - -## repo:relations - -List of relation link types to which this privilege applies - -`repo:relations` -* is optional -* type: `string[]` - -* defined in this schema - -### repo:relations Type - - -Array type: `string[]` - -All items must be of the type: -`string` - - - - - - - - diff --git a/docs/reference/common/accesscontrolpolicy.schema.json b/docs/reference/common/accesscontrolpolicy.schema.json deleted file mode 100644 index d91a7eebc1..0000000000 --- a/docs/reference/common/accesscontrolpolicy.schema.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "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/accesscontrolpolicy", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Access Control Policy", - "description": "Schema for the Access Control Policy of a resource", - "type": "object", - "definitions": { - "accesscontrolpolicy": { - "type": "object", - "properties": { - "repo:acl": { - "$ref": "https://ns.adobe.com/xdm/common/accesscontrolentry#/definitions/acl" - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/accesscontrolpolicy" - } - ], - "examples": [ - { - "repo:acl": [ - { - "repo:principal": "authenticated", - "repo:privilege": "read", - "repo:modifier": "grant" - }, - { - "repo:principal": { - "xdm:provider": { - "@id": "https://ims-na1.adobelogin.com/" - }, - "@id": "C0B648DE57D701277F000101@AdobeID", - "@type": "https://ns.adobe.com/xdm-extensions/ims/user" - }, - "repo:privilege": [ - "write", - "delete" - ], - "repo:modifier": "grant" - } - ] - } - ] -} \ No newline at end of file diff --git a/docs/reference/common/accesscontrolpolicy.schema.md b/docs/reference/common/accesscontrolpolicy.schema.md deleted file mode 100644 index c7d895037e..0000000000 --- a/docs/reference/common/accesscontrolpolicy.schema.md +++ /dev/null @@ -1,77 +0,0 @@ - -# Access Control Policy Schema - -``` -https://ns.adobe.com/xdm/common/accesscontrolpolicy -``` - -Schema for the Access Control Policy of a resource - -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [common/accesscontrolpolicy.schema.json](common/accesscontrolpolicy.schema.json) | - -## Schema Hierarchy - -* Access Control Policy `https://ns.adobe.com/xdm/common/accesscontrolpolicy` - * [Access Control Entry](accesscontrolentry.schema.md) `https://ns.adobe.com/xdm/common/accesscontrolentry` - -## Access Control Policy Example -```json -{ - "repo:acl": [ - { - "repo:principal": "authenticated", - "repo:privilege": "read", - "repo:modifier": "grant" - }, - { - "repo:principal": { - "xdm:provider": { - "@id": "https://ims-na1.adobelogin.com/" - }, - "@id": "C0B648DE57D701277F000101@AdobeID", - "@type": "https://ns.adobe.com/xdm-extensions/ims/user" - }, - "repo:privilege": [ - "write", - "delete" - ], - "repo:modifier": "grant" - } - ] -} -``` - -# Access Control Policy Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [repo:acl](#repoacl) | Access Control Entry | Optional | Access Control Policy (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## repo:acl -### Access Control List - -Schema for the Access Control List of a resource - -`repo:acl` -* is optional -* type: Access Control Entry - -* defined in this schema - -### repo:acl Type - - -Array type: Access Control Entry - -All items must be of the type: -* [Access Control Entry](accesscontrolentry.schema.md) – `https://ns.adobe.com/xdm/common/accesscontrolentry` - - - - - - - diff --git a/docs/reference/common/descriptors/itemselector.schema.json b/docs/reference/common/descriptors/itemselector.schema.json index afb2aa47a5..0c2a1dd79d 100644 --- a/docs/reference/common/descriptors/itemselector.schema.json +++ b/docs/reference/common/descriptors/itemselector.schema.json @@ -78,16 +78,16 @@ "meta:status": "experimental", "examples": [ { - "xdm:type": "https://ns.adobe.com/experience/mcid" + "xdm:index": 0 }, { "xdm:id": "https://example.com/objects/12345" }, { - "xdm:index": 0 + "xdm:schema": "https://ns.adobe.com/xdm/context/identity" }, { - "xdm:schema": "https://ns.adobe.com/xdm/context/identity" + "xdm:type": "https://ns.adobe.com/experience/mcid" } ] } \ No newline at end of file diff --git a/docs/reference/common/descriptors/itemselector.schema.md b/docs/reference/common/descriptors/itemselector.schema.md index 5feeea7ab3..1ed898e0a0 100644 --- a/docs/reference/common/descriptors/itemselector.schema.md +++ b/docs/reference/common/descriptors/itemselector.schema.md @@ -18,7 +18,7 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI. ```json { - "xdm:type": "https://ns.adobe.com/experience/mcid" + "xdm:index": 0 } ``` @@ -30,13 +30,13 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI. ```json { - "xdm:index": 0 + "xdm:schema": "https://ns.adobe.com/xdm/context/identity" } ``` ```json { - "xdm:schema": "https://ns.adobe.com/xdm/context/identity" + "xdm:type": "https://ns.adobe.com/experience/mcid" } ``` diff --git a/docs/reference/common/eventenvelope.schema.json b/docs/reference/common/eventenvelope.schema.json index f26e89777c..5e1c011ad3 100644 --- a/docs/reference/common/eventenvelope.schema.json +++ b/docs/reference/common/eventenvelope.schema.json @@ -119,7 +119,7 @@ } }, { - "@type": "https://ns.adobe.com/xdm/common/event/unpublished", + "@type": "https://ns.adobe.com/xdm/common/event/published", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", @@ -143,7 +143,7 @@ } }, { - "@type": "https://ns.adobe.com/xdm/common/event/published", + "@type": "https://ns.adobe.com/xdm/common/event/unpublished", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", diff --git a/docs/reference/common/eventenvelope.schema.md b/docs/reference/common/eventenvelope.schema.md index 28a99813d2..6e6418d691 100644 --- a/docs/reference/common/eventenvelope.schema.md +++ b/docs/reference/common/eventenvelope.schema.md @@ -107,7 +107,7 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream ```json { - "@type": "https://ns.adobe.com/xdm/common/event/unpublished", + "@type": "https://ns.adobe.com/xdm/common/event/published", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", @@ -134,7 +134,7 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream ```json { - "@type": "https://ns.adobe.com/xdm/common/event/published", + "@type": "https://ns.adobe.com/xdm/common/event/unpublished", "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", diff --git a/docs/reference/common/identityprovider.schema.json b/docs/reference/common/identityprovider.schema.json deleted file mode 100644 index 7006b73b4c..0000000000 --- a/docs/reference/common/identityprovider.schema.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "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/common/identityprovider", - "title": "Identity Provider", - "description": "An identity provider (abbreviated IdP) is a system entity that creates, maintains, and manages identity information for principals while providing authentication services to relying party applications within a federation or distributed network. An identity provider offers subject authentication as a service.", - "definitions": { - "xdm:name": { - "type": "string", - "description": "A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the identity provider. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986)." - } - }, - "type": "object", - "properties": { - "name": { - "$ref": "#/definitions/xdm:name" - } - }, - "required": [ - "xdm:name" - ], - "examples": [ - { - "xdm:name": "ims" - } - ] -} \ No newline at end of file diff --git a/docs/reference/common/identityprovider.schema.md b/docs/reference/common/identityprovider.schema.md deleted file mode 100644 index dad2d0baa2..0000000000 --- a/docs/reference/common/identityprovider.schema.md +++ /dev/null @@ -1,46 +0,0 @@ ---- ---- - -# Identity Provider Schema - -``` -https://ns.adobe.com/xdm/common/identityprovider -``` - -An identity provider (abbreviated IdP) is a system entity that creates, maintains, and manages identity information for principals while providing authentication services to relying party applications within a federation or distributed network. An identity provider offers subject authentication as a service. - -| Abstract | Extensible | Custom Properties | Defined In | -|----------|------------|-------------------|------------| -| Can be instantiated | Yes | Forbidden | [common/identityprovider.schema.json](common/identityprovider.schema.json) | - -## Identity Provider Example -```json -{ - "xdm:name": "ims" -} -``` - -# Identity Provider Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [name](#name) | `string` | Optional | Identity Provider (this schema) | - -## name - -A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the identity provider. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986). - -`name` -* is optional -* type: `string` -* defined in this schema - -### name Type - - -`string` - - - - - diff --git a/docs/reference/content/page-component.schema.json b/docs/reference/content/page-component.schema.json index f16502a736..dd49beb513 100644 --- a/docs/reference/content/page-component.schema.json +++ b/docs/reference/content/page-component.schema.json @@ -32,10 +32,6 @@ ], "meta:status": "experimental", "examples": [ - { - "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", - "dc:title": "Protect Your Eyes" - }, { "@type": "https://francois.corp.adobe.com:4502/apps/foundation/image", "image": { @@ -43,6 +39,10 @@ "repo:assetID": "urn:aaid:aem:4123ba4c-93a8-4c5d-b979-1234e4318185", "@id": "https://francois.corp.adobe.com:4502/content/dam/Glasses-small.jpg" } + }, + { + "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", + "dc:title": "Protect Your Eyes" } ] } \ No newline at end of file diff --git a/docs/reference/content/page-component.schema.md b/docs/reference/content/page-component.schema.md index 0e84fb2d65..c23e5d3bcf 100644 --- a/docs/reference/content/page-component.schema.md +++ b/docs/reference/content/page-component.schema.md @@ -21,13 +21,6 @@ The type determines how the component will be displayed, rendered, and authored. ## Page Component Examples -```json -{ - "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", - "dc:title": "Protect Your Eyes" -} -``` - ```json { "@type": "https://francois.corp.adobe.com:4502/apps/foundation/image", @@ -39,6 +32,13 @@ The type determines how the component will be displayed, rendered, and authored. } ``` +```json +{ + "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", + "dc:title": "Protect Your Eyes" +} +``` + # Page Component Properties diff --git a/docs/reference/context/experienceevent.schema.json b/docs/reference/context/experienceevent.schema.json index 0f366d6c57..975134da37 100644 --- a/docs/reference/context/experienceevent.schema.json +++ b/docs/reference/context/experienceevent.schema.json @@ -130,7 +130,7 @@ "meta:status": "stabilizing", "examples": [ { - "@id": "https://data.adobe.io/experienceid-123456", + "@id": "https://data.adobe.io/experienceid-23456782", "xdm:dataSource": { "@id": "https://data.adobe.io/datasources/datasource-123", "xdm:code": "DataSourceIntegrationCode-123" @@ -141,81 +141,19 @@ "https://ns.adobe.com/experience/mcid": { "xdm:id": "92312748749128", "xdm:namespace": { + "@id": "https://data.adobe.io/entities/namespace/4", "xdm:code": "ECID" } - }, - "https://ns.adobe.com/experience/aaid": { - "xdm:id": "2394509340-30453470347", - "xdm:namespace": { - "xdm:code": "AVID" - } - }, - "https://ns.adobe.com/experience/tntid": { - "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d", - "xdm:namespace": { - "xdm:code": "tnt0051" - } } }, - "xdm:channel": { - "@id": "https://ns.adobe.com/xdm/channels/apns", - "@type": "https://ns.adobe.com/xdm/channel-types/mobile" - }, "xdm:environment": { - "xdm:type": "browser", - "xdm:browserDetails": { - "xdm:name": "Chrome", - "xdm:version": "63.0.3239", - "xdm:acceptLanguage": "en", - "xdm:cookiesEnabled": true, - "xdm:javaScriptEnabled": true, - "xdm:javaScriptVersion": "1.8.5", - "xdm:javaEnabled": true, - "xdm:javaVersion": "Java SE 8", - "xdm:viewportHeight": 900, - "xdm:viewportWidth": 1680 - }, - "xdm:operatingSystem": "MAC OS", + "xdm:type": "application", + "xdm:operatingSystem": "iOS", "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "cable" - }, - "xdm:productListItems": [ - { - "xdm:SKU": "1002352692", - "xdm:lineItemId": "12345678", - "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", - "xdm:currencyCode": "USD", - "xdm:quantity": 1, - "xdm:priceTotal": 159 - } - ], - "xdm:commerce": { - "xdm:order": { - "xdm:purchaseID": "a8g784hjq1mnp3", - "xdm:purchaseOrderNumber": "123456", - "xdm:payments": [ - { - "xdm:transactionID": "transactid-a111", - "xdm:paymentAmount": 59, - "xdm:paymentType": "credit_card", - "xdm:currencyCode": "USD" - }, - { - "xdm:transactionId": "transactid-a222", - "xdm:paymentAmount": 100, - "xdm:paymentType": "gift_card", - "xdm:currencyCode": "USD" - } - ], - "xdm:currencyCode": "USD", - "xdm:priceTotal": 159 - }, - "xdm:purchases": { - "xdm:value": 1 - } + "xdm:connectionType": "mobile_lte" }, "xdm:placeContext": { - "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:localTime": "2001-07-04T12:08:56+01:00", "xdm:geo": { "@id": "https://data.adobe.io/entities/geo/tokyo", "xdm:countryCode": "JP", @@ -224,47 +162,72 @@ "xdm:postalCode": "141-0032", "schema:latitude": 35.6185, "schema:longitude": 139.73237 - } - }, - "xdm:web": { - "xdm:webPageDetails": { - "xdm:siteSection": "Shopping Cart", - "xdm:server": "example.com", - "xdm:name": "Purchase Confirmation", - "xdm:URL": "https://www.example.com/orderConf", - "xdm:errorPage": false, - "xdm:homePage": false, - "xdm:pageViews": { + }, + "xdm:POIinteraction": { + "xdm:poiEntries": { "xdm:value": 1 + }, + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 } }, - "xdm:webReferrer": { - "xdm:URL": "https://www.example.com/checkout", - "xdm:referrerType": "internal" - } - }, - "xdm:marketing": { - "xdm:trackingCode": "marketingcampaign111" - } - }, - { - "@id": "https://data.adobe.io/experienceid-2345678", - "xdm:dataSource": { - "@id": "https://data.adobe.io/datasources/datasource-123", - "xdm:code": "DataSourceIntegrationCode-123" - }, - "https://ns.adobe.com/experience/datasetID": "12345677888", - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:endUserIDs": { - "https://ns.adobe.com/experience/mcid": { - "xdm:id": "92312748749128", - "xdm:namespace": { - "@id": "https://data.adobe.io/entities/namespace/4", - "xdm:code": "ECID" + "xdm:activePOIs": [ + { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Tokyo City", + "xdm:locatingType": "gps", + "xdm:geoInteractionDetails": { + "xdm:distanceToCenter": 320, + "xdm:accuracy": 30, + "xdm:geoShape": { + "@id": "https://data.adobe.io/entities/geoShape/shapeid123", + "schema:circle": { + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "Tokyo Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "Tokyo", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 + } + } + } } - } - }, - "xdm:environment": { + ], "xdm:type": "browser", "xdm:browserDetails": { "xdm:name": "Chrome", @@ -326,7 +289,7 @@ } }, { - "@id": "https://data.adobe.io/experienceid-23456782", + "@id": "https://data.adobe.io/experienceid-2345678", "xdm:dataSource": { "@id": "https://data.adobe.io/datasources/datasource-123", "xdm:code": "DataSourceIntegrationCode-123" @@ -343,87 +306,6 @@ } }, "xdm:environment": { - "xdm:type": "application", - "xdm:operatingSystem": "iOS", - "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "mobile_lte" - }, - "xdm:placeContext": { - "xdm:localTime": "2001-07-04T12:08:56+01:00", - "xdm:geo": { - "@id": "https://data.adobe.io/entities/geo/tokyo", - "xdm:countryCode": "JP", - "xdm:stateProvince": "JP-13", - "xdm:city": "Tōkyō", - "xdm:postalCode": "141-0032", - "schema:latitude": 35.6185, - "schema:longitude": 139.73237 - }, - "xdm:POIinteraction": { - "xdm:poiEntries": { - "xdm:value": 1 - }, - "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", - "xdm:name": "Acme Hotel Tokyo Lobby", - "xdm:category": "Resorts", - "xdm:type": "Hotel", - "xdm:locatingType": "beacon", - "xdm:beaconInteractionDetails": { - "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", - "xdm:beaconMajor": 300, - "xdm:beaconMinor": 34 - } - }, - "xdm:activePOIs": [ - { - "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", - "xdm:name": "Acme Hotel Tokyo", - "xdm:category": "Resorts", - "xdm:type": "Hotel", - "xdm:locatingType": "beacon", - "xdm:beaconInteractionDetails": { - "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", - "xdm:beaconMajor": 100, - "xdm:beaconMinor": 23 - } - }, - { - "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", - "xdm:name": "Acme Hotel Tokyo Lobby", - "xdm:category": "Resorts", - "xdm:type": "Hotel", - "xdm:locatingType": "beacon", - "xdm:beaconInteractionDetails": { - "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", - "xdm:beaconMajor": 300, - "xdm:beaconMinor": 34 - } - }, - { - "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", - "xdm:name": "Tokyo City", - "xdm:locatingType": "gps", - "xdm:geoInteractionDetails": { - "xdm:distanceToCenter": 320, - "xdm:accuracy": 30, - "xdm:geoShape": { - "@id": "https://data.adobe.io/entities/geoShape/shapeid123", - "schema:circle": { - "@id": "https://data.adobe.io/entities/geo/circleid123", - "schema:description": "Tokyo Metro", - "schema:coordinates": { - "@id": "https://data.adobe.io/entities/geo/111", - "schema:description": "Tokyo", - "schema:latitude": 37.3308953, - "schema:longitude": -121.8939894, - "schema:elevation": 31.0896 - }, - "schema:radius": 80000 - } - } - } - } - ], "xdm:type": "browser", "xdm:browserDetails": { "xdm:name": "Chrome", @@ -484,6 +366,124 @@ } } }, + { + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "https://ns.adobe.com/experience/datasetID": "12345677888", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "xdm:id": "92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "xdm:id": "2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } + }, { "@id": "https://data.adobe.io/experienceid-123457", "xdm:timestamp": "2017-09-26T15:52:25+00:00", diff --git a/docs/reference/context/experienceevent.schema.md b/docs/reference/context/experienceevent.schema.md index b4cf335778..dae98f935f 100644 --- a/docs/reference/context/experienceevent.schema.md +++ b/docs/reference/context/experienceevent.schema.md @@ -34,7 +34,7 @@ The core ExperienceEvent XDM is used to capture observations that are altering o ```json { - "@id": "https://data.adobe.io/experienceid-123456", + "@id": "https://data.adobe.io/experienceid-23456782", "xdm:dataSource": { "@id": "https://data.adobe.io/datasources/datasource-123", "xdm:code": "DataSourceIntegrationCode-123" @@ -45,81 +45,19 @@ The core ExperienceEvent XDM is used to capture observations that are altering o "https://ns.adobe.com/experience/mcid": { "xdm:id": "92312748749128", "xdm:namespace": { + "@id": "https://data.adobe.io/entities/namespace/4", "xdm:code": "ECID" } - }, - "https://ns.adobe.com/experience/aaid": { - "xdm:id": "2394509340-30453470347", - "xdm:namespace": { - "xdm:code": "AVID" - } - }, - "https://ns.adobe.com/experience/tntid": { - "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d", - "xdm:namespace": { - "xdm:code": "tnt0051" - } } }, - "xdm:channel": { - "@id": "https://ns.adobe.com/xdm/channels/apns", - "@type": "https://ns.adobe.com/xdm/channel-types/mobile" - }, "xdm:environment": { - "xdm:type": "browser", - "xdm:browserDetails": { - "xdm:name": "Chrome", - "xdm:version": "63.0.3239", - "xdm:acceptLanguage": "en", - "xdm:cookiesEnabled": true, - "xdm:javaScriptEnabled": true, - "xdm:javaScriptVersion": "1.8.5", - "xdm:javaEnabled": true, - "xdm:javaVersion": "Java SE 8", - "xdm:viewportHeight": 900, - "xdm:viewportWidth": 1680 - }, - "xdm:operatingSystem": "MAC OS", + "xdm:type": "application", + "xdm:operatingSystem": "iOS", "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "cable" - }, - "xdm:productListItems": [ - { - "xdm:SKU": "1002352692", - "xdm:lineItemId": "12345678", - "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", - "xdm:currencyCode": "USD", - "xdm:quantity": 1, - "xdm:priceTotal": 159 - } - ], - "xdm:commerce": { - "xdm:order": { - "xdm:purchaseID": "a8g784hjq1mnp3", - "xdm:purchaseOrderNumber": "123456", - "xdm:payments": [ - { - "xdm:transactionID": "transactid-a111", - "xdm:paymentAmount": 59, - "xdm:paymentType": "credit_card", - "xdm:currencyCode": "USD" - }, - { - "xdm:transactionId": "transactid-a222", - "xdm:paymentAmount": 100, - "xdm:paymentType": "gift_card", - "xdm:currencyCode": "USD" - } - ], - "xdm:currencyCode": "USD", - "xdm:priceTotal": 159 - }, - "xdm:purchases": { - "xdm:value": 1 - } + "xdm:connectionType": "mobile_lte" }, "xdm:placeContext": { - "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:localTime": "2001-07-04T12:08:56+01:00", "xdm:geo": { "@id": "https://data.adobe.io/entities/geo/tokyo", "xdm:countryCode": "JP", @@ -128,50 +66,72 @@ The core ExperienceEvent XDM is used to capture observations that are altering o "xdm:postalCode": "141-0032", "schema:latitude": 35.6185, "schema:longitude": 139.73237 - } - }, - "xdm:web": { - "xdm:webPageDetails": { - "xdm:siteSection": "Shopping Cart", - "xdm:server": "example.com", - "xdm:name": "Purchase Confirmation", - "xdm:URL": "https://www.example.com/orderConf", - "xdm:errorPage": false, - "xdm:homePage": false, - "xdm:pageViews": { + }, + "xdm:POIinteraction": { + "xdm:poiEntries": { "xdm:value": 1 + }, + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 } }, - "xdm:webReferrer": { - "xdm:URL": "https://www.example.com/checkout", - "xdm:referrerType": "internal" - } - }, - "xdm:marketing": { - "xdm:trackingCode": "marketingcampaign111" - } -} -``` - -```json -{ - "@id": "https://data.adobe.io/experienceid-2345678", - "xdm:dataSource": { - "@id": "https://data.adobe.io/datasources/datasource-123", - "xdm:code": "DataSourceIntegrationCode-123" - }, - "https://ns.adobe.com/experience/datasetID": "12345677888", - "xdm:timestamp": "2017-09-26T15:52:25+00:00", - "xdm:endUserIDs": { - "https://ns.adobe.com/experience/mcid": { - "xdm:id": "92312748749128", - "xdm:namespace": { - "@id": "https://data.adobe.io/entities/namespace/4", - "xdm:code": "ECID" + "xdm:activePOIs": [ + { + "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", + "xdm:name": "Acme Hotel Tokyo", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", + "xdm:beaconMajor": 100, + "xdm:beaconMinor": 23 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Acme Hotel Tokyo Lobby", + "xdm:category": "Resorts", + "xdm:type": "Hotel", + "xdm:locatingType": "beacon", + "xdm:beaconInteractionDetails": { + "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", + "xdm:beaconMajor": 300, + "xdm:beaconMinor": 34 + } + }, + { + "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", + "xdm:name": "Tokyo City", + "xdm:locatingType": "gps", + "xdm:geoInteractionDetails": { + "xdm:distanceToCenter": 320, + "xdm:accuracy": 30, + "xdm:geoShape": { + "@id": "https://data.adobe.io/entities/geoShape/shapeid123", + "schema:circle": { + "@id": "https://data.adobe.io/entities/geo/circleid123", + "schema:description": "Tokyo Metro", + "schema:coordinates": { + "@id": "https://data.adobe.io/entities/geo/111", + "schema:description": "Tokyo", + "schema:latitude": 37.3308953, + "schema:longitude": -121.8939894, + "schema:elevation": 31.0896 + }, + "schema:radius": 80000 + } + } + } } - } - }, - "xdm:environment": { + ], "xdm:type": "browser", "xdm:browserDetails": { "xdm:name": "Chrome", @@ -236,7 +196,7 @@ The core ExperienceEvent XDM is used to capture observations that are altering o ```json { - "@id": "https://data.adobe.io/experienceid-23456782", + "@id": "https://data.adobe.io/experienceid-2345678", "xdm:dataSource": { "@id": "https://data.adobe.io/datasources/datasource-123", "xdm:code": "DataSourceIntegrationCode-123" @@ -253,87 +213,6 @@ The core ExperienceEvent XDM is used to capture observations that are altering o } }, "xdm:environment": { - "xdm:type": "application", - "xdm:operatingSystem": "iOS", - "xdm:operatingSystemVersion": "10.13", - "xdm:connectionType": "mobile_lte" - }, - "xdm:placeContext": { - "xdm:localTime": "2001-07-04T12:08:56+01:00", - "xdm:geo": { - "@id": "https://data.adobe.io/entities/geo/tokyo", - "xdm:countryCode": "JP", - "xdm:stateProvince": "JP-13", - "xdm:city": "Tōkyō", - "xdm:postalCode": "141-0032", - "schema:latitude": 35.6185, - "schema:longitude": 139.73237 - }, - "xdm:POIinteraction": { - "xdm:poiEntries": { - "xdm:value": 1 - }, - "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", - "xdm:name": "Acme Hotel Tokyo Lobby", - "xdm:category": "Resorts", - "xdm:type": "Hotel", - "xdm:locatingType": "beacon", - "xdm:beaconInteractionDetails": { - "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", - "xdm:beaconMajor": 300, - "xdm:beaconMinor": 34 - } - }, - "xdm:activePOIs": [ - { - "xdm:POIID": "c7f4bf28-c8d9-4b89-a81f-2a8ef9367390", - "xdm:name": "Acme Hotel Tokyo", - "xdm:category": "Resorts", - "xdm:type": "Hotel", - "xdm:locatingType": "beacon", - "xdm:beaconInteractionDetails": { - "xdm:proximityUUID": "dd0094a0-52bb-4d3a-ab15-fcccb9b9b48e", - "xdm:beaconMajor": 100, - "xdm:beaconMinor": 23 - } - }, - { - "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", - "xdm:name": "Acme Hotel Tokyo Lobby", - "xdm:category": "Resorts", - "xdm:type": "Hotel", - "xdm:locatingType": "beacon", - "xdm:beaconInteractionDetails": { - "xdm:proximityUUID": "c6c03ed9-ea23-481c-ab15-833e88cfb22f", - "xdm:beaconMajor": 300, - "xdm:beaconMinor": 34 - } - }, - { - "xdm:POIID": "d8a5c08c-1e79-4051-8a8b-675fb235e03d", - "xdm:name": "Tokyo City", - "xdm:locatingType": "gps", - "xdm:geoInteractionDetails": { - "xdm:distanceToCenter": 320, - "xdm:accuracy": 30, - "xdm:geoShape": { - "@id": "https://data.adobe.io/entities/geoShape/shapeid123", - "schema:circle": { - "@id": "https://data.adobe.io/entities/geo/circleid123", - "schema:description": "Tokyo Metro", - "schema:coordinates": { - "@id": "https://data.adobe.io/entities/geo/111", - "schema:description": "Tokyo", - "schema:latitude": 37.3308953, - "schema:longitude": -121.8939894, - "schema:elevation": 31.0896 - }, - "schema:radius": 80000 - } - } - } - } - ], "xdm:type": "browser", "xdm:browserDetails": { "xdm:name": "Chrome", @@ -396,6 +275,127 @@ The core ExperienceEvent XDM is used to capture observations that are altering o } ``` +```json +{ + "@id": "https://data.adobe.io/experienceid-123456", + "xdm:dataSource": { + "@id": "https://data.adobe.io/datasources/datasource-123", + "xdm:code": "DataSourceIntegrationCode-123" + }, + "https://ns.adobe.com/experience/datasetID": "12345677888", + "xdm:timestamp": "2017-09-26T15:52:25+00:00", + "xdm:endUserIDs": { + "https://ns.adobe.com/experience/mcid": { + "xdm:id": "92312748749128", + "xdm:namespace": { + "xdm:code": "ECID" + } + }, + "https://ns.adobe.com/experience/aaid": { + "xdm:id": "2394509340-30453470347", + "xdm:namespace": { + "xdm:code": "AVID" + } + }, + "https://ns.adobe.com/experience/tntid": { + "xdm:id": "1233ce17-20e0-4a2c-8198-2a77fd60cf4d", + "xdm:namespace": { + "xdm:code": "tnt0051" + } + } + }, + "xdm:channel": { + "@id": "https://ns.adobe.com/xdm/channels/apns", + "@type": "https://ns.adobe.com/xdm/channel-types/mobile" + }, + "xdm:environment": { + "xdm:type": "browser", + "xdm:browserDetails": { + "xdm:name": "Chrome", + "xdm:version": "63.0.3239", + "xdm:acceptLanguage": "en", + "xdm:cookiesEnabled": true, + "xdm:javaScriptEnabled": true, + "xdm:javaScriptVersion": "1.8.5", + "xdm:javaEnabled": true, + "xdm:javaVersion": "Java SE 8", + "xdm:viewportHeight": 900, + "xdm:viewportWidth": 1680 + }, + "xdm:operatingSystem": "MAC OS", + "xdm:operatingSystemVersion": "10.13", + "xdm:connectionType": "cable" + }, + "xdm:productListItems": [ + { + "xdm:SKU": "1002352692", + "xdm:lineItemId": "12345678", + "xdm:name": "24-Watt 8-Light Chrome Integrated LED Bath Light", + "xdm:currencyCode": "USD", + "xdm:quantity": 1, + "xdm:priceTotal": 159 + } + ], + "xdm:commerce": { + "xdm:order": { + "xdm:purchaseID": "a8g784hjq1mnp3", + "xdm:purchaseOrderNumber": "123456", + "xdm:payments": [ + { + "xdm:transactionID": "transactid-a111", + "xdm:paymentAmount": 59, + "xdm:paymentType": "credit_card", + "xdm:currencyCode": "USD" + }, + { + "xdm:transactionId": "transactid-a222", + "xdm:paymentAmount": 100, + "xdm:paymentType": "gift_card", + "xdm:currencyCode": "USD" + } + ], + "xdm:currencyCode": "USD", + "xdm:priceTotal": 159 + }, + "xdm:purchases": { + "xdm:value": 1 + } + }, + "xdm:placeContext": { + "xdm:localTime": "2017-09-26T15:52:25+13:00", + "xdm:geo": { + "@id": "https://data.adobe.io/entities/geo/tokyo", + "xdm:countryCode": "JP", + "xdm:stateProvince": "JP-13", + "xdm:city": "Tōkyō", + "xdm:postalCode": "141-0032", + "schema:latitude": 35.6185, + "schema:longitude": 139.73237 + } + }, + "xdm:web": { + "xdm:webPageDetails": { + "xdm:siteSection": "Shopping Cart", + "xdm:server": "example.com", + "xdm:name": "Purchase Confirmation", + "xdm:URL": "https://www.example.com/orderConf", + "xdm:errorPage": false, + "xdm:homePage": false, + "xdm:pageViews": { + "xdm:value": 1 + } + }, + "xdm:webReferrer": { + "xdm:URL": "https://www.example.com/checkout", + "xdm:referrerType": "internal" + } + }, + "xdm:marketing": { + "xdm:trackingCode": "marketingcampaign111" + } +} +``` + ```json { "@id": "https://data.adobe.io/experienceid-123457", diff --git a/docs/reference/context/identity.schema.json b/docs/reference/context/identity.schema.json index f6a0245e88..a857796ce0 100644 --- a/docs/reference/context/identity.schema.json +++ b/docs/reference/context/identity.schema.json @@ -49,15 +49,15 @@ "meta:status": "stabilizing", "examples": [ { - "xdm:id": "id123", + "xdm:id": "someone@example.com", "xdm:namespace": { - "xdm:code": "AA12345" + "xdm:code": "Email" } }, { - "xdm:id": "someone@example.com", + "xdm:id": "id123", "xdm:namespace": { - "xdm:code": "Email" + "xdm:code": "AA12345" } } ] diff --git a/docs/reference/context/identity.schema.md b/docs/reference/context/identity.schema.md index 585f34dec0..f6be0964b4 100644 --- a/docs/reference/context/identity.schema.md +++ b/docs/reference/context/identity.schema.md @@ -21,18 +21,18 @@ Identity is used to clearly distinguish people that are interacting with digital ```json { - "xdm:id": "id123", + "xdm:id": "someone@example.com", "xdm:namespace": { - "xdm:code": "AA12345" + "xdm:code": "Email" } } ``` ```json { - "xdm:id": "someone@example.com", + "xdm:id": "id123", "xdm:namespace": { - "xdm:code": "Email" + "xdm:code": "AA12345" } } ``` diff --git a/docs/reference/context/locationcontext.schema.json b/docs/reference/context/locationcontext.schema.json deleted file mode 100644 index b83113e4ef..0000000000 --- a/docs/reference/context/locationcontext.schema.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "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/" - ], - "$id": "https://ns.adobe.com/xdm/context/locationcontext", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Location Context", - "type": "object", - "description": "The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, working hours.", - "definitions": { - "locationcontext": { - "properties": { - "xdm:localTime": { - "title": "Local Time", - "type": "string", - "format": "date-time", - "description": "The local time using RFC3339 with a stated timezone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." - }, - "xdm:geo": { - "title": "Geo", - "$ref": "https://ns.adobe.com/xdm/common/geo", - "description": "The geographic location where the experience was delivered ." - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/locationcontext" - } - ], - "meta:status": "experimental", - "examples": [ - { - "xdm:localTime": "2001-07-04T12:08:56+01:00", - "xdm:geo": { - "@id": "https://data.adobe.io/entities/geo/tokyo", - "xdm:countryCode": "JP", - "xdm:stateProvince": "JP-13", - "xdm:city": "Tōkyō", - "xdm:postalCode": "141-0032", - "schema:latitude": 35.6185, - "schema:longitude": 139.73237 - } - } - ] -} \ No newline at end of file diff --git a/docs/reference/context/locationcontext.schema.md b/docs/reference/context/locationcontext.schema.md deleted file mode 100644 index 1db30e6d1e..0000000000 --- a/docs/reference/context/locationcontext.schema.md +++ /dev/null @@ -1,81 +0,0 @@ - -# Location Context Schema - -``` -https://ns.adobe.com/xdm/context/locationcontext -``` - -The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, working hours. - -| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | -|----------|------------|--------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [context/locationcontext.schema.json](context/locationcontext.schema.json) | - -## Schema Hierarchy - -* Location Context `https://ns.adobe.com/xdm/context/locationcontext` - * [Geo](../common/geo.schema.md) `https://ns.adobe.com/xdm/common/geo` - -## Location Context Example -```json -{ - "xdm:localTime": "2001-07-04T12:08:56+01:00", - "xdm:geo": { - "@id": "https://data.adobe.io/entities/geo/tokyo", - "xdm:countryCode": "JP", - "xdm:stateProvince": "JP-13", - "xdm:city": "Tōkyō", - "xdm:postalCode": "141-0032", - "schema:latitude": 35.6185, - "schema:longitude": 139.73237 - } -} -``` - -# Location Context Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [xdm:geo](#xdmgeo) | Geo | Optional | Location Context (this schema) | -| [xdm:localTime](#xdmlocaltime) | `string` | Optional | Location Context (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## xdm:geo -### Geo - -The geographic location where the experience was delivered . - -`xdm:geo` -* is optional -* type: Geo -* defined in this schema - -### xdm:geo Type - - -* [Geo](../common/geo.schema.md) – `https://ns.adobe.com/xdm/common/geo` - - - - - -## xdm:localTime -### Local Time - -The local time using RFC3339 with a stated timezone offset such as "2001-07-04T12:08:56-07:00". An example formatting pattern is "yyyy-MM-dd'T'HH:mm:ssXXX". - -`xdm:localTime` -* is optional -* type: `string` -* defined in this schema - -### xdm:localTime Type - - -`string` -* format: `date-time` – date and time (according to [RFC 3339, section 5.6](http://tools.ietf.org/html/rfc3339)) - - - - - diff --git a/docs/reference/context/person-name.schema.json b/docs/reference/context/person-name.schema.json index f6e5aa7756..58171b7ab4 100644 --- a/docs/reference/context/person-name.schema.json +++ b/docs/reference/context/person-name.schema.json @@ -58,15 +58,15 @@ "xdm:lastName": "Doe", "xdm:fullName": "John S. Doe" }, - { - "xdm:firstName": "张", - "xdm:lastName": "三", - "xdm:fullName": "张三" - }, { "xdm:firstName": "فلانة", "xdm:lastName": "الفلانية", "xdm:fullName": "فلانة الفلانية" + }, + { + "xdm:firstName": "张", + "xdm:lastName": "三", + "xdm:fullName": "张三" } ] } \ No newline at end of file diff --git a/docs/reference/context/person-name.schema.md b/docs/reference/context/person-name.schema.md index 4bbd2514be..97ab127725 100644 --- a/docs/reference/context/person-name.schema.md +++ b/docs/reference/context/person-name.schema.md @@ -32,17 +32,17 @@ In addition, a number of optional properties are made available that can be used ```json { - "xdm:firstName": "张", - "xdm:lastName": "三", - "xdm:fullName": "张三" + "xdm:firstName": "فلانة", + "xdm:lastName": "الفلانية", + "xdm:fullName": "فلانة الفلانية" } ``` ```json { - "xdm:firstName": "فلانة", - "xdm:lastName": "الفلانية", - "xdm:fullName": "فلانة الفلانية" + "xdm:firstName": "张", + "xdm:lastName": "三", + "xdm:fullName": "张三" } ``` diff --git a/docs/reference/context/personname.schema.json b/docs/reference/context/personname.schema.json deleted file mode 100644 index bf9ae3f70a..0000000000 --- a/docs/reference/context/personname.schema.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "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/" - ], - "$id": "https://ns.adobe.com/xdm/context/personname", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Person Name", - "type": "object", - "description": "Full name of a person", - "definitions": { - "personname": { - "properties": { - "xdm:givenName": { - "title": "Given name", - "type": "string", - "description": "The personal, given, or first name." - }, - "xdm:surname": { - "title": "Surname", - "type": "string", - "description": "The inherited family name, last name, surname, patronymic, or matronymic name." - }, - "xdm:middleName": { - "title": "Middle name", - "type": "string", - "description": "Middle, alternative, or additional names supplied between the given name and surnames." - }, - "xdm:courtesyTitle": { - "title": "Courtesy title", - "type": "string", - "description": "Normally an abbreviation of a persons *title*, *honorific*, or *salutation*.\nThe `courtesyTitle` is used in front of full or last name in opening texts.\ne.g Mr. Miss. or Dr J. Smith.\n" - }, - "xdm:name": { - "title": "Full name", - "type": "string", - "description": "The full name of the person, in writing order most commonly accepted in the language of the name." - } - } - } - }, - "allOf": [ - { - "ref$": "#/definitions/personname" - } - ], - "examples": [ - { - "xdm:givenName": "三", - "xdm:surname": "张", - "xdm:name": "张三" - }, - { - "xdm:givenName": "فلانة", - "xdm:surname": "الفلانية", - "xdm:name": "فلانة الفلانية" - }, - { - "xdm:givenName": "John", - "xdm:middleName": "S", - "xdm:surname": "Doe" - } - ] -} \ No newline at end of file diff --git a/docs/reference/context/personname.schema.md b/docs/reference/context/personname.schema.md deleted file mode 100644 index 35805ae39a..0000000000 --- a/docs/reference/context/personname.schema.md +++ /dev/null @@ -1,153 +0,0 @@ ---- ---- - -# Person Name Schema - -``` -https://ns.adobe.com/xdm/context/personname -``` - -Full name of a person - -| Abstract | Extensible | Custom Properties | Defined In | -|----------|------------|-------------------|------------| -| Cannot be instantiated | Yes | Forbidden | [context/personname.schema.json](context/personname.schema.json) | - -## Person Name Examples - -```json -{ - "xdm:givenName": "三", - "xdm:surname": "张", - "xdm:name": "张三" -} -``` - -```json -{ - "xdm:givenName": "فلانة", - "xdm:surname": "الفلانية", - "xdm:name": "فلانة الفلانية" -} -``` - -```json -{ - "xdm:givenName": "John", - "xdm:middleName": "S", - "xdm:surname": "Doe" -} -``` - - -# Person Name Definitions - -| Property | Type | Group | -|----------|------|-------| -| [xdm:givenName](#xdm:givenName) | `string` | `#/definitions/personname` | -| [xdm:surname](#xdm:surname) | `string` | `#/definitions/personname` | -| [xdm:middleName](#xdm:middleName) | `string` | `#/definitions/personname` | -| [xdm:courtesyTitle](#xdm:courtesyTitle) | `string` | `#/definitions/personname` | -| [xdm:name](#xdm:name) | `string` | `#/definitions/personname` | - -## xdm:givenName -### Given name - -The personal, given, or first name. - -`xdm:givenName` -* is optional -* type: `string` -* defined in this schema - -### xdm:givenName Type - - -`string` - - - - - - -## xdm:surname -### Surname - -The inherited family name, last name, surname, patronymic, or matronymic name. - -`xdm:surname` -* is optional -* type: `string` -* defined in this schema - -### xdm:surname Type - - -`string` - - - - - - -## xdm:middleName -### Middle name - -Middle, alternative, or additional names supplied between the given name and surnames. - -`xdm:middleName` -* is optional -* type: `string` -* defined in this schema - -### xdm:middleName Type - - -`string` - - - - - - -## xdm:courtesyTitle -### Courtesy title - -Normally an abbreviation of a persons *title*, *honorific*, or *salutation*. -The `courtesyTitle` is used in front of full or last name in opening texts. -e.g Mr. Miss. or Dr J. Smith. - -`xdm:courtesyTitle` -* is optional -* type: `string` -* defined in this schema - -### xdm:courtesyTitle Type - - -`string` - - - - - - -## xdm:name -### Full name - -The full name of the person, in writing order most commonly accepted in the language of the name. - -`xdm:name` -* is optional -* type: `string` -* defined in this schema - -### xdm:name Type - - -`string` - - - - - diff --git a/docs/reference/context/weblink.schema.json b/docs/reference/context/weblink.schema.json deleted file mode 100644 index ac1e5b342a..0000000000 --- a/docs/reference/context/weblink.schema.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "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/" - ], - "$id": "https://ns.adobe.com/xdm/context/weblink", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Web Link", - "type": "object", - "description": "Information about the web link of the ExperienceEvent.", - "definitions": { - "weblink": { - "properties": { - "xdm:type": { - "title": "Type", - "type": "string", - "description": "The link type.", - "enum": [ - "download", - "exit", - "other" - ], - "meta:enum": { - "download": "Download", - "exit": "Exit", - "other": "Other" - } - }, - "xdm:URL": { - "title": "URL", - "type": "string", - "description": "The link URL." - }, - "xdm:name": { - "title": "Name", - "type": "string", - "description": "The link name." - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/weblink" - } - ], - "meta:status": "experimental", - "examples": [ - { - "xdm:type": "other", - "xdm:URL": "https://store.google.com/?utm_source=hp_header&utm_medium=google_oo&utm_campaign=GS100042", - "xdm:name": "google store" - } - ] -} \ No newline at end of file diff --git a/docs/reference/context/weblink.schema.md b/docs/reference/context/weblink.schema.md deleted file mode 100644 index 6328294062..0000000000 --- a/docs/reference/context/weblink.schema.md +++ /dev/null @@ -1,92 +0,0 @@ - -# Web Link Schema - -``` -https://ns.adobe.com/xdm/context/weblink -``` - -Information about the web link of the ExperienceEvent. - -| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | -|----------|------------|--------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [context/weblink.schema.json](context/weblink.schema.json) | - -## Web Link Example -```json -{ - "xdm:type": "other", - "xdm:URL": "https://store.google.com/?utm_source=hp_header&utm_medium=google_oo&utm_campaign=GS100042", - "xdm:name": "google store" -} -``` - -# Web Link Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [xdm:URL](#xdmurl) | `string` | Optional | Web Link (this schema) | -| [xdm:name](#xdmname) | `string` | Optional | Web Link (this schema) | -| [xdm:type](#xdmtype) | `enum` | Optional | Web Link (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## xdm:URL -### URL - -The link URL. - -`xdm:URL` -* is optional -* type: `string` -* defined in this schema - -### xdm:URL Type - - -`string` - - - - - - -## xdm:name -### Name - -The link name. - -`xdm:name` -* is optional -* type: `string` -* defined in this schema - -### xdm:name Type - - -`string` - - - - - - -## xdm:type -### Type - -The link type. - -`xdm:type` -* is optional -* type: `enum` -* defined in this schema - -The value of this property **must** be equal to one of the [known values below](#xdm:type-known-values). - -### xdm:type Known Values -| Value | Description | -|-------|-------------| -| `download` | Download | -| `exit` | Exit | -| `other` | Other | - - - diff --git a/docs/reference/context/webpageview.schema.json b/docs/reference/context/webpageview.schema.json deleted file mode 100644 index de2b4d6d5b..0000000000 --- a/docs/reference/context/webpageview.schema.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "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/context/webpageview", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Web Page View", - "type": "object", - "description": "Details about the web page that has just been loaded and viewed, as recorded by an `ExperienceEvent`.\n\nThis schema is intended for full page views and initial page loads of single page web applications (SPAs).\nFor interactions that are happening on a loaded page that do not trigger a new page load, see `WebInteraction`.\n", - "meta:extensible": true, - "definitions": { - "webpageview": { - "properties": { - "xdm:siteSection": { - "title": "Site Section", - "type": "string", - "description": "The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction" - }, - "xdm:name": { - "title": "Name", - "type": "string", - "description": "The normative name of the web page. This name is not necessarily the page title or directy associate with page content, but is used to organize a site's pages for classification purposes" - }, - "xdm:URL": { - "title": "URL", - "type": "string", - "format": "uri", - "description": "The normative or usual URL of the web page. This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`." - }, - "xdm:server": { - "title": "Server", - "type": "string", - "format": "hostname", - "description": "The normative or usual server that hosts the web page. This may or may not be the host or server that actually served the page interaction, but is used for classification purposes." - }, - "xdm:isErrorPage": { - "title": "Is Error Page", - "type": "boolean", - "description": "Flag that indicate if the page is error page or not. Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code. This flag is used to broadly categorize web interactions." - }, - "xdm:isHomePage": { - "title": "Is Home Page", - "type": "boolean", - "description": "Flag that indicate if the page is the site home page or not. The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point. This flag is used to broadly categorize web interactions." - }, - "xdm:pageViews": { - "$ref": "https://ns.adobe.com/xdm/data/measure", - "description": "View(s) of a webpage has occurred." - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/webpageview" - } - ], - "meta:status": "experimental", - "examples": [ - { - "xdm:siteSection": "Product section", - "xdm:server": "example.com", - "xdm:name": "product home", - "xdm:URL": "https://www.example.com", - "xdm:errorPage": false, - "xdm:homePage": true, - "xdm:pageViews": { - "xdm:value": 1 - } - } - ] -} \ No newline at end of file diff --git a/docs/reference/context/webpageview.schema.md b/docs/reference/context/webpageview.schema.md deleted file mode 100644 index ce94830b53..0000000000 --- a/docs/reference/context/webpageview.schema.md +++ /dev/null @@ -1,187 +0,0 @@ - -# Web Page View Schema - -``` -https://ns.adobe.com/xdm/context/webpageview -``` - -Details about the web page that has just been loaded and viewed, as recorded by an `ExperienceEvent`. - -This schema is intended for full page views and initial page loads of single page web applications (SPAs). -For interactions that are happening on a loaded page that do not trigger a new page load, see `WebInteraction`. - - -| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | -|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| -| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [context/webpageview.schema.json](context/webpageview.schema.json) | -## Schema Hierarchy - -* Web Page View `https://ns.adobe.com/xdm/context/webpageview` - * [Measure](../data/measure.schema.md) `https://ns.adobe.com/xdm/data/measure` - - -## Web Page View Example -```json -{ - "xdm:siteSection": "Product section", - "xdm:server": "example.com", - "xdm:name": "product home", - "xdm:URL": "https://www.example.com", - "xdm:errorPage": false, - "xdm:homePage": true, - "xdm:pageViews": { - "xdm:value": 1 - } -} -``` - -# Web Page View Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [xdm:URL](#xdmurl) | `string` | Optional | Web Page View (this schema) | -| [xdm:isErrorPage](#xdmiserrorpage) | `boolean` | Optional | Web Page View (this schema) | -| [xdm:isHomePage](#xdmishomepage) | `boolean` | Optional | Web Page View (this schema) | -| [xdm:name](#xdmname) | `string` | Optional | Web Page View (this schema) | -| [xdm:pageViews](#xdmpageviews) | Measure | Optional | Web Page View (this schema) | -| [xdm:server](#xdmserver) | `string` | Optional | Web Page View (this schema) | -| [xdm:siteSection](#xdmsitesection) | `string` | Optional | Web Page View (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## xdm:URL -### URL - -The normative or usual URL of the web page. This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`. - -`xdm:URL` -* is optional -* type: `string` -* defined in this schema - -### xdm:URL Type - - -`string` -* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) - - - - - - -## xdm:isErrorPage -### Is Error Page - -Flag that indicate if the page is error page or not. Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code. This flag is used to broadly categorize web interactions. - -`xdm:isErrorPage` -* is optional -* type: `boolean` -* defined in this schema - -### xdm:isErrorPage Type - - -`boolean` - - - - - -## xdm:isHomePage -### Is Home Page - -Flag that indicate if the page is the site home page or not. The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point. This flag is used to broadly categorize web interactions. - -`xdm:isHomePage` -* is optional -* type: `boolean` -* defined in this schema - -### xdm:isHomePage Type - - -`boolean` - - - - - -## xdm:name -### Name - -The normative name of the web page. This name is not necessarily the page title or directy associate with page content, but is used to organize a site's pages for classification purposes - -`xdm:name` -* is optional -* type: `string` -* defined in this schema - -### xdm:name Type - - -`string` - - - - - - -## xdm:pageViews - -View(s) of a webpage has occurred. - -`xdm:pageViews` -* is optional -* type: Measure -* defined in this schema - -### xdm:pageViews Type - - -* [Measure](../data/measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` - - - - - -## xdm:server -### Server - -The normative or usual server that hosts the web page. This may or may not be the host or server that actually served the page interaction, but is used for classification purposes. - -`xdm:server` -* is optional -* type: `string` -* defined in this schema - -### xdm:server Type - - -`string` -* format: `hostname` – Domain Name (according to [RFC 1034, section 3.1](https://tools.ietf.org/html/rfc1034)) - - - - - - -## xdm:siteSection -### Site Section - -The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction - -`xdm:siteSection` -* is optional -* type: `string` -* defined in this schema - -### xdm:siteSection Type - - -`string` - - - - - diff --git a/docs/reference/data/abandons.schema.json b/docs/reference/data/abandons.schema.json deleted file mode 100644 index bd29f0ac93..0000000000 --- a/docs/reference/data/abandons.schema.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "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/data/metrics/commerce/abandons", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "abandons", - "type": "object", - "meta:extensible": true, - "meta:extends": [ - "https://ns.adobe.com/xdm/data/metricdefinition" - ], - "description": "Number of abandons for which a product list has been identified as no longer purchasable or accessible by the user without the user re-creating the product list from scratch.", - "definitions": { - "metricdefinition": { - "properties": { - "@id": { - "type": "string", - "format": "uri", - "const": "https://ns.adobe.com/xdm/data/metrics/commerce/abandons", - "description": "The unique identifier of this metric." - }, - "schema:name": { - "type": "string", - "const": "commerce metric: abandons", - "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." - }, - "xdm:measurement": { - "type": "string", - "description": "How to take measures of this metric.", - "const": "count" - }, - "xdm:unit": { - "const": null - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/metricdefinition" - } - ], - "required": [ - "@id", - "schema:name", - "xdm:measurement", - "xdm:unit" - ], - "meta:status": "experimental", - "examples": [ - { - "schema:name": "commerce metric: abandons", - "@id": "https://ns.adobe.com/xdm/data/metrics/commerce/abandons", - "xdm:measurement": "count", - "xdm:unit": null - } - ] -} \ No newline at end of file diff --git a/docs/reference/data/abandons.schema.md b/docs/reference/data/abandons.schema.md deleted file mode 100644 index 660528f38c..0000000000 --- a/docs/reference/data/abandons.schema.md +++ /dev/null @@ -1,107 +0,0 @@ - -# abandons Schema - -``` -https://ns.adobe.com/xdm/data/metrics/commerce/abandons -``` - -Number of abandons for which a product list has been identified as no longer purchasable or accessible by the user without the user re-creating the product list from scratch. - -| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | -|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| -| Can be instantiated | Yes | Experimental | Yes | Forbidden | Permitted | [data/abandons.schema.json](data/abandons.schema.json) | - -## abandons Example -```json -{ - "schema:name": "commerce metric: abandons", - "@id": "https://ns.adobe.com/xdm/data/metrics/commerce/abandons", - "xdm:measurement": "count", - "xdm:unit": null -} -``` - -# abandons Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [@id](#@id) | `const` | **Required** | abandons (this schema) | -| [schema:name](#schemaname) | `const` | **Required** | abandons (this schema) | -| [xdm:measurement](#xdmmeasurement) | `const` | **Required** | abandons (this schema) | -| [xdm:unit](#xdmunit) | `const` | **Required** | abandons (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## @id - -The unique identifier of this metric. - -`@id` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"https://ns.adobe.com/xdm/data/metrics/commerce/abandons" -``` - - - - - -## schema:name - -The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. - -`schema:name` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"commerce metric: abandons" -``` - - - - - -## xdm:measurement - -How to take measures of this metric. - -`xdm:measurement` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"count" -``` - - - - - -## xdm:unit - - -`xdm:unit` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -null -``` - - - - diff --git a/docs/reference/data/link-clicks.schema.json b/docs/reference/data/link-clicks.schema.json deleted file mode 100644 index b7b62fa361..0000000000 --- a/docs/reference/data/link-clicks.schema.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "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/data/metrics/web/link-clicks", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "link-clicks", - "type": "object", - "meta:extensible": true, - "meta:extends": [ - "https://ns.adobe.com/xdm/data/metricdefinition" - ], - "description": "The web metric link-clicks describes the number of clicks on a link on a web page.", - "definitions": { - "metricdefinition": { - "properties": { - "@id": { - "type": "string", - "format": "uri", - "const": "https://ns.adobe.com/xdm/data/metrics/web/link-clicks", - "description": "The unique identifier of this metric." - }, - "schema:name": { - "type": "string", - "const": "web metric: link-clicks", - "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." - }, - "xdm:measurement": { - "type": "string", - "description": "How to take measures of this metric.", - "const": "count" - }, - "xdm:unit": { - "const": null - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/metricdefinition" - } - ], - "required": [ - "@id", - "schema:name", - "xdm:measurement", - "xdm:unit" - ], - "meta:status": "experimental", - "examples": [ - { - "schema:name": "web metric: link-clicks", - "@id": "https://ns.adobe.com/xdm/data/metrics/web/link-clicks", - "xdm:measurement": "count", - "xdm:unit": null - } - ] -} \ No newline at end of file diff --git a/docs/reference/data/link-clicks.schema.md b/docs/reference/data/link-clicks.schema.md deleted file mode 100644 index 736584dd1f..0000000000 --- a/docs/reference/data/link-clicks.schema.md +++ /dev/null @@ -1,107 +0,0 @@ - -# link-clicks Schema - -``` -https://ns.adobe.com/xdm/data/metrics/web/link-clicks -``` - -The web metric link-clicks describes the number of clicks on a link on a web page. - -| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | -|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| -| Can be instantiated | Yes | Experimental | Yes | Forbidden | Permitted | [data/link-clicks.schema.json](data/link-clicks.schema.json) | - -## link-clicks Example -```json -{ - "schema:name": "web metric: link-clicks", - "@id": "https://ns.adobe.com/xdm/data/metrics/web/link-clicks", - "xdm:measurement": "count", - "xdm:unit": null -} -``` - -# link-clicks Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [@id](#@id) | `const` | **Required** | link-clicks (this schema) | -| [schema:name](#schemaname) | `const` | **Required** | link-clicks (this schema) | -| [xdm:measurement](#xdmmeasurement) | `const` | **Required** | link-clicks (this schema) | -| [xdm:unit](#xdmunit) | `const` | **Required** | link-clicks (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## @id - -The unique identifier of this metric. - -`@id` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"https://ns.adobe.com/xdm/data/metrics/web/link-clicks" -``` - - - - - -## schema:name - -The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. - -`schema:name` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"web metric: link-clicks" -``` - - - - - -## xdm:measurement - -How to take measures of this metric. - -`xdm:measurement` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"count" -``` - - - - - -## xdm:unit - - -`xdm:unit` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -null -``` - - - - diff --git a/docs/reference/data/metric.schema.json b/docs/reference/data/metric.schema.json deleted file mode 100644 index 63367440fc..0000000000 --- a/docs/reference/data/metric.schema.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "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/data/metric", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Metric", - "type": "object", - "meta:extensible": true, - "description": "A metric is a definition of a measurable or countable quantity.\n\nA metric consists of a measurement and a dimension.\nFor easier identification, metrics have a name and a unique URI that can be used when referring to the metric.\n\nThrough XDM's extensibility mechanism, new metrics can be defined by extending `Metric`.\n", - "definitions": { - "metric": { - "properties": { - "@id": { - "type": "string", - "format": "uri", - "description": "The unique identifier of this metric." - }, - "schema:name": { - "type": "string", - "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." - }, - "xdm:measurement": { - "type": "string", - "description": "How to take measures of this metric.", - "examples": [ - "distance", - "time", - "price", - "count" - ] - }, - "xdm:unit": { - "type": "string", - "description": "The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html). For measures that are counts, the `xdm:unit` must be `null`.", - "examples": [ - "m", - "kg", - "s", - "USD" - ] - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/metric" - } - ], - "required": [ - "@id", - "schema:name", - "xdm:measurement", - "xdm:unit" - ], - "meta:status": "experimental", - "examples": [ - { - "schema:name": "Example Metric", - "@id": "https://ns.adobe.com/xdm/data/example-metric", - "xdm:measurement": "weight", - "xdm:unit": "kg" - } - ] -} \ No newline at end of file diff --git a/docs/reference/data/metric.schema.md b/docs/reference/data/metric.schema.md deleted file mode 100644 index e8036d75b3..0000000000 --- a/docs/reference/data/metric.schema.md +++ /dev/null @@ -1,153 +0,0 @@ - -# Metric Schema - -``` -https://ns.adobe.com/xdm/data/metric -``` - -A metric is a definition of a measurable or countable quantity. - -A metric consists of a measurement and a dimension. -For easier identification, metrics have a name and a unique URI that can be used when referring to the metric. - -Through XDM's extensibility mechanism, new metrics can be defined by extending `Metric`. - - -| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | -|----------|------------|--------|--------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Experimental | Yes | Forbidden | Permitted | [data/metric.schema.json](data/metric.schema.json) | - -## Metric Example -```json -{ - "schema:name": "Example Metric", - "@id": "https://ns.adobe.com/xdm/data/example-metric", - "xdm:measurement": "weight", - "xdm:unit": "kg" -} -``` - -# Metric Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [@id](#@id) | `string` | **Required** | Metric (this schema) | -| [schema:name](#schemaname) | `string` | **Required** | Metric (this schema) | -| [xdm:measurement](#xdmmeasurement) | `string` | **Required** | Metric (this schema) | -| [xdm:unit](#xdmunit) | `string` | **Required** | Metric (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## @id - -The unique identifier of this metric. - -`@id` -* is **required** -* type: `string` -* defined in this schema - -### @id Type - - -`string` -* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) - - - - - - -## schema:name - -The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. - -`schema:name` -* is **required** -* type: `string` -* defined in this schema - -### schema:name Type - - -`string` - - - - - - -## xdm:measurement - -How to take measures of this metric. - -`xdm:measurement` -* is **required** -* type: `string` -* defined in this schema - -### xdm:measurement Type - - -`string` - - - - - -### xdm:measurement Examples - -```json -"distance" -``` - -```json -"time" -``` - -```json -"price" -``` - -```json -"count" -``` - - - -## xdm:unit - -The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html). For measures that are counts, the `xdm:unit` must be `null`. - -`xdm:unit` -* is **required** -* type: `string` -* defined in this schema - -### xdm:unit Type - - -`string` - - - - - -### xdm:unit Examples - -```json -"m" -``` - -```json -"kg" -``` - -```json -"s" -``` - -```json -"USD" -``` - - diff --git a/docs/reference/data/metrics.schema.json b/docs/reference/data/metrics.schema.json deleted file mode 100644 index 3affcb1576..0000000000 --- a/docs/reference/data/metrics.schema.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "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/" - ], - "$id": "https://ns.adobe.com/xdm/data/metrics", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "Metrics", - "type": "object", - "description": "This is map of metrics and measures. Each key is the valid URI of a known `Metric`. Each value is a `Measure`, i.e. a concrete data point.", - "definitions": { - "metrics": { - "patternProperties": { - ".+://.+": { - "$ref": "https://ns.adobe.com/xdm/data/measure" - } - }, - "properties": { - "https://ns.adobe.com/xdm/data/metrics/commerce/checkouts": { - "$ref": "https://ns.adobe.com/xdm/data/measure", - "description": "An action during a checkout process of a product-list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order." - }, - "https://ns.adobe.com/xdm/data/metrics/advertising/impressions": { - "$ref": "https://ns.adobe.com/xdm/data/measure", - "description": "Impression(s) of an advertisement to an end user with the potential of being viewed." - }, - "https://ns.adobe.com/xdm/data/metrics/application/upgrades": { - "$ref": "https://ns.adobe.com/xdm/data/measure", - "description": "Upgrade of an application that has previously been installed. Triggered on first launch after upgrade." - } - }, - "additionalProperties": false - } - }, - "allOf": [ - { - "$ref": "#/definitions/metrics" - } - ], - "meta:status": "experimental", - "examples": [ - {} - ] -} \ No newline at end of file diff --git a/docs/reference/data/metrics.schema.md b/docs/reference/data/metrics.schema.md deleted file mode 100644 index 0743634f1e..0000000000 --- a/docs/reference/data/metrics.schema.md +++ /dev/null @@ -1,85 +0,0 @@ - -# Metrics Schema - -``` -https://ns.adobe.com/xdm/data/metrics -``` - -This is map of metrics and measures. Each key is the valid URI of a known `Metric`. Each value is a `Measure`, i.e. a concrete data point. - -| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | -|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| -| Can be instantiated | Yes | Experimental | No | Forbidden | Permitted | [data/metrics.schema.json](data/metrics.schema.json) | -## Schema Hierarchy - -* Metrics `https://ns.adobe.com/xdm/data/metrics` - * [Measure](measure.schema.md) `https://ns.adobe.com/xdm/data/measure` - - -## Metrics Example -```json -{} -``` - -# Metrics Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [https://ns.adobe.com/xdm/data/metrics/advertising/impressions](#https//ns.adobe.com/xdm/data/metrics/advertising/impressions) | Measure | Optional | Metrics (this schema) | -| [https://ns.adobe.com/xdm/data/metrics/application/upgrades](#https//ns.adobe.com/xdm/data/metrics/application/upgrades) | Measure | Optional | Metrics (this schema) | -| [https://ns.adobe.com/xdm/data/metrics/commerce/checkouts](#https//ns.adobe.com/xdm/data/metrics/commerce/checkouts) | Measure | Optional | Metrics (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## https://ns.adobe.com/xdm/data/metrics/advertising/impressions - -Impression(s) of an advertisement to an end user with the potential of being viewed. - -`https://ns.adobe.com/xdm/data/metrics/advertising/impressions` -* is optional -* type: Measure -* defined in this schema - -### https://ns.adobe.com/xdm/data/metrics/advertising/impressions Type - - -* [Measure](measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` - - - - - -## https://ns.adobe.com/xdm/data/metrics/application/upgrades - -Upgrade of an application that has previously been installed. Triggered on first launch after upgrade. - -`https://ns.adobe.com/xdm/data/metrics/application/upgrades` -* is optional -* type: Measure -* defined in this schema - -### https://ns.adobe.com/xdm/data/metrics/application/upgrades Type - - -* [Measure](measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` - - - - - -## https://ns.adobe.com/xdm/data/metrics/commerce/checkouts - -An action during a checkout process of a product-list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order. - -`https://ns.adobe.com/xdm/data/metrics/commerce/checkouts` -* is optional -* type: Measure -* defined in this schema - -### https://ns.adobe.com/xdm/data/metrics/commerce/checkouts Type - - -* [Measure](measure.schema.md) – `https://ns.adobe.com/xdm/data/measure` - - - - diff --git a/docs/reference/data/page-views.schema.json b/docs/reference/data/page-views.schema.json deleted file mode 100644 index c6c360e520..0000000000 --- a/docs/reference/data/page-views.schema.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "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/data/metrics/web/page-views", - "$schema": "http://json-schema.org/draft-06/schema#", - "title": "page-views", - "type": "object", - "meta:extensible": true, - "meta:extends": [ - "https://ns.adobe.com/xdm/data/metricdefinition" - ], - "description": "The web metric page-views describes the number of impressions of a web page.", - "definitions": { - "metricdefinition": { - "properties": { - "@id": { - "type": "string", - "format": "uri", - "const": "https://ns.adobe.com/xdm/data/metrics/web/page-views", - "description": "The unique identifier of this metric." - }, - "schema:name": { - "type": "string", - "const": "web metric: page-views", - "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." - }, - "xdm:measurement": { - "type": "string", - "description": "How to take measures of this metric.", - "const": "count" - }, - "xdm:unit": { - "const": null - } - } - } - }, - "allOf": [ - { - "$ref": "#/definitions/metricdefinition" - } - ], - "required": [ - "@id", - "schema:name", - "xdm:measurement", - "xdm:unit" - ], - "meta:status": "experimental", - "examples": [ - { - "schema:name": "web metric: page-views", - "@id": "https://ns.adobe.com/xdm/data/metrics/web/page-views", - "xdm:measurement": "count", - "xdm:unit": null - } - ] -} \ No newline at end of file diff --git a/docs/reference/data/page-views.schema.md b/docs/reference/data/page-views.schema.md deleted file mode 100644 index 7a6ef66635..0000000000 --- a/docs/reference/data/page-views.schema.md +++ /dev/null @@ -1,107 +0,0 @@ - -# page-views Schema - -``` -https://ns.adobe.com/xdm/data/metrics/web/page-views -``` - -The web metric page-views describes the number of impressions of a web page. - -| [Abstract](../../abstract.md) | [Extensible](../../extensions.md) | [Status](../../status.md) | [Identifiable](../../id.md) | [Custom Properties](../../extensions.md) | [Additional Properties](../../extensions.md) | Defined In | -|-------------------------------|-----------------------------------|---------------------------|-----------------------------|------------------------------------------|----------------------------------------------|------------| -| Can be instantiated | Yes | Experimental | Yes | Forbidden | Permitted | [data/page-views.schema.json](data/page-views.schema.json) | - -## page-views Example -```json -{ - "schema:name": "web metric: page-views", - "@id": "https://ns.adobe.com/xdm/data/metrics/web/page-views", - "xdm:measurement": "count", - "xdm:unit": null -} -``` - -# page-views Properties - -| Property | Type | Required | Defined by | -|----------|------|----------|------------| -| [@id](#@id) | `const` | **Required** | page-views (this schema) | -| [schema:name](#schemaname) | `const` | **Required** | page-views (this schema) | -| [xdm:measurement](#xdmmeasurement) | `const` | **Required** | page-views (this schema) | -| [xdm:unit](#xdmunit) | `const` | **Required** | page-views (this schema) | -| `*` | any | Additional | this schema *allows* additional properties | - -## @id - -The unique identifier of this metric. - -`@id` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"https://ns.adobe.com/xdm/data/metrics/web/page-views" -``` - - - - - -## schema:name - -The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique. - -`schema:name` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"web metric: page-views" -``` - - - - - -## xdm:measurement - -How to take measures of this metric. - -`xdm:measurement` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -"count" -``` - - - - - -## xdm:unit - - -`xdm:unit` -* is **required** -* type: `const` -* defined in this schema - -The value of this property **must** be equal to: - -```json -null -``` - - - - diff --git a/docs/reference/external/hal/hal.schema.json b/docs/reference/external/hal/hal.schema.json index 7bcb6625fb..3fa44f9918 100644 --- a/docs/reference/external/hal/hal.schema.json +++ b/docs/reference/external/hal/hal.schema.json @@ -296,6 +296,30 @@ "status": "shipped", "total": 10.2 }, + { + "_links": { + "self": { + "href": "/orders/523" + }, + "warehouses": [ + { + "href": "/warehouse/56" + }, + { + "href": "/warehouse/56" + }, + { + "href": "/warehouse/56" + } + ], + "invoice": { + "href": "/invoices/873" + } + }, + "currency": "USD", + "status": "shipped", + "total": 10.2 + }, { "_links": { "self": { @@ -340,30 +364,6 @@ "currency": "USD", "status": "shipped", "total": 10.2 - }, - { - "_links": { - "self": { - "href": "/orders/523" - }, - "warehouses": [ - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - } - ], - "invoice": { - "href": "/invoices/873" - } - }, - "currency": "USD", - "status": "shipped", - "total": 10.2 } ] } \ No newline at end of file diff --git a/docs/reference/external/hal/hal.schema.md b/docs/reference/external/hal/hal.schema.md index 82d81c9353..30ee52d37b 100644 --- a/docs/reference/external/hal/hal.schema.md +++ b/docs/reference/external/hal/hal.schema.md @@ -39,6 +39,33 @@ This external schema definition allows adding HAL expressions into an existing s } ``` +```json +{ + "_links": { + "self": { + "href": "/orders/523" + }, + "warehouses": [ + { + "href": "/warehouse/56" + }, + { + "href": "/warehouse/56" + }, + { + "href": "/warehouse/56" + } + ], + "invoice": { + "href": "/invoices/873" + } + }, + "currency": "USD", + "status": "shipped", + "total": 10.2 +} +``` + ```json { "_links": { @@ -87,33 +114,6 @@ This external schema definition allows adding HAL expressions into an existing s } ``` -```json -{ - "_links": { - "self": { - "href": "/orders/523" - }, - "warehouses": [ - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - } - ], - "invoice": { - "href": "/invoices/873" - } - }, - "currency": "USD", - "status": "shipped", - "total": 10.2 -} -``` - # HAL Resource Properties diff --git a/docs/reference/external/repo/accesscontrolentry.schema.json b/docs/reference/external/repo/accesscontrolentry.schema.json index aa9490f85d..9b23c0ee59 100644 --- a/docs/reference/external/repo/accesscontrolentry.schema.json +++ b/docs/reference/external/repo/accesscontrolentry.schema.json @@ -102,6 +102,13 @@ ], "meta:status": "experimental", "examples": [ + { + "repo:principal": "authenticated", + "repo:privileges": [ + "read" + ], + "repo:modifier": "grant" + }, { "repo:principal": { "xdm:provider": { @@ -116,13 +123,6 @@ ], "repo:modifier": "grant", "repo:inheritance": "deep" - }, - { - "repo:principal": "authenticated", - "repo:privileges": [ - "read" - ], - "repo:modifier": "grant" } ] } \ No newline at end of file diff --git a/docs/reference/external/repo/accesscontrolentry.schema.md b/docs/reference/external/repo/accesscontrolentry.schema.md index 6befda3b89..d6421ca64a 100644 --- a/docs/reference/external/repo/accesscontrolentry.schema.md +++ b/docs/reference/external/repo/accesscontrolentry.schema.md @@ -13,6 +13,16 @@ Schema for the Access Control Entry for the Access Control List of a resource ## Access Control Entry Examples +```json +{ + "repo:principal": "authenticated", + "repo:privileges": [ + "read" + ], + "repo:modifier": "grant" +} +``` + ```json { "repo:principal": { @@ -31,16 +41,6 @@ Schema for the Access Control Entry for the Access Control List of a resource } ``` -```json -{ - "repo:principal": "authenticated", - "repo:privileges": [ - "read" - ], - "repo:modifier": "grant" -} -``` - # Access Control Entry Properties