[ci skip] updating documentation

harleensahni · Jun 8, 2018 · 9c96017 · 9c96017
1 parent 4e7fe70
commit 9c96017
Show file tree

Hide file tree

Showing 20 changed files with 630 additions and 577 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -147,8 +147,8 @@
 * [measured-window-inactive](./data/measuredwindowinactive.schema.md) – `https://ns.adobe.com/xdm/data/measuredwindowinactive` (Stabilizing)
 * [midpoints](./data/midpoints.schema.md) – `https://ns.adobe.com/xdm/data/midpoints` (Stabilizing)
 * [page views](./data/pageviews.schema.md) – `https://ns.adobe.com/xdm/data/metrics/web/pageviews` (Stabilizing)
-* [poi-entries](./data/poi-entries.schema.md) – `https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries` (Experimental)
 * [poi-entries](./data/poi-exits.schema.md) – `https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits` (Experimental)
+* [poi-entries](./data/poi-entries.schema.md) – `https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries` (Experimental)
 * [starts](./data/starts.schema.md) – `https://ns.adobe.com/xdm/data/starts` (Stabilizing)
 * [third-quartiles](./data/thirdquartiles.schema.md) – `https://ns.adobe.com/xdm/data/thirdquartiles` (Stabilizing)
 * [unmeasurable-iframe](./data/unmeasurableiframe.schema.md) – `https://ns.adobe.com/xdm/data/unmeasurableiframe` (Stabilizing)
@@ -160,11 +160,6 @@
 * [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)
 
-## /common/descriptors/
-
-* [Item Selector](./common/descriptors/itemselector.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/itemselector` (Experimental)
-* [Schema Descriptor](./common/descriptors/schemadescriptor.schema.md) – `https://ns.adobe.com/xdm/common/desciptors/schemadescriptor` (Experimental)
-
 ## /common/event/
 
 * [Created Event](./common/event/created.schema.md) – `https://ns.adobe.com/xdm/common/event/created` (Experimental)
@@ -175,17 +170,22 @@
 * [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)
 
+## /common/descriptors/
+
+* [Item Selector](./common/descriptors/itemselector.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/itemselector` (Experimental)
+* [Schema Descriptor](./common/descriptors/schemadescriptor.schema.md) – `https://ns.adobe.com/xdm/common/desciptors/schemadescriptor` (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/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/schema/
-
-* [Geo Circle](./external/schema/geocircle.schema.md) – `http://schema.org/GeoCircle` (Experimental)
-* [Geo Coordinates](./external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` (Experimental)
-* [Geo Shape](./external/schema/geoshape.schema.md) – `http://schema.org/GeoShape` (Experimental)
-
 ## /external/activity-streams-2/
 
 * [Activity](./external/activity-streams-2/activity.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/activity` (Experimental)
@@ -210,9 +210,9 @@
 * [Effective Privileges](./external/repo/effectiveprivileges.schema.md) – `https://ns.adobe.com/xdm/external/repo/effectiveprivileges` (Experimental)
 * [Sub-Directory](./external/repo/sub-directory.schema.md) – `http://ns.adobe.com/adobecloud/core/1.0/sub-directory` (Experimental)
 
-## /content/repository-policies/
+## /external/schema/
 
-* [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)
+* [Geo Circle](./external/schema/geocircle.schema.md) – `http://schema.org/GeoCircle` (Experimental)
+* [Geo Coordinates](./external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates` (Experimental)
+* [Geo Shape](./external/schema/geoshape.schema.md) – `http://schema.org/GeoShape` (Experimental)
 
diff --git a/docs/reference/common/descriptors/itemselector.schema.json b/docs/reference/common/descriptors/itemselector.schema.json
@@ -80,14 +80,14 @@
         {
             "xdm:id": "https://example.com/objects/12345"
         },
-        {
-            "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
-        },
         {
             "xdm:index": 0
         },
         {
             "xdm:type": "https://ns.adobe.com/experience/mcid"
+        },
+        {
+            "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
         }
     ]
 }
diff --git a/docs/reference/common/descriptors/itemselector.schema.md b/docs/reference/common/descriptors/itemselector.schema.md
@@ -24,19 +24,19 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.
 
 ```json
 {
-  "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
+  "xdm:index": 0
 }
 ```
 
 ```json
 {
-  "xdm:index": 0
+  "xdm:type": "https://ns.adobe.com/experience/mcid"
 }
 ```
 
 ```json
 {
-  "xdm:type": "https://ns.adobe.com/experience/mcid"
+  "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
 }
 ```
 
diff --git a/docs/reference/common/eventenvelope.schema.json b/docs/reference/common/eventenvelope.schema.json
@@ -41,6 +41,29 @@
     ],
     "meta:status": "experimental",
     "examples": [
+        {
+            "@type": "https://ns.adobe.com/xdm/common/event/created",
+            "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
+            "activitystreams:published": "2016-07-16T19:20:30+01:00",
+            "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
+            "activitystreams:to": {
+                "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
+                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+            },
+            "activitystreams:generator": {
+                "@type": "https://ns.adobe.com/xdm/content/repository",
+                "xdm:root": "https://cc-api-storage-stage.adobe.io/"
+            },
+            "activitystreams:actor": {
+                "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
+                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+            },
+            "activitystreams:object": {
+                "@type": "https://ns.adobe.com/xdm/assets/asset",
+                "repo:assetID": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
+                "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185"
+            }
+        },
         {
             "@type": "https://ns.adobe.com/xdm/common/event/created",
             "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
@@ -95,29 +118,6 @@
                 "repo:etag": "\"6fc55d0389d856ae7wddwebba54f110e\""
             }
         },
-        {
-            "@type": "https://ns.adobe.com/xdm/common/event/created",
-            "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
-            "activitystreams:published": "2016-07-16T19:20:30+01:00",
-            "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
-            "activitystreams:to": {
-                "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
-                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
-            },
-            "activitystreams:generator": {
-                "@type": "https://ns.adobe.com/xdm/content/repository",
-                "xdm:root": "https://cc-api-storage-stage.adobe.io/"
-            },
-            "activitystreams:actor": {
-                "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
-                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
-            },
-            "activitystreams:object": {
-                "@type": "https://ns.adobe.com/xdm/assets/asset",
-                "repo:assetID": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
-                "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185"
-            }
-        },
         {
             "@type": "https://ns.adobe.com/xdm/common/event/published",
             "xdm:objectType": "https://ns.adobe.com/xdm/content/componentized-page",

diff --git a/docs/reference/common/eventenvelope.schema.md b/docs/reference/common/eventenvelope.schema.md
@@ -40,67 +40,67 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
   "activitystreams:object": {
     "@type": "https://ns.adobe.com/xdm/assets/asset",
     "repo:assetID": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
-    "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
-    "xdm:name": "example.jpg",
-    "xdm:path": "/MyFolder/example.jpg",
-    "dc:format": "image/jpg",
-    "repo:etag": "\"6fc55d0389d856ae7deccebba54f110e\""
+    "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185"
   }
 }
 ```
 
 ```json
 {
-  "@type": "https://ns.adobe.com/xdm/common/event/updated",
+  "@type": "https://ns.adobe.com/xdm/common/event/created",
   "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
   "activitystreams:published": "2016-07-16T19:20:30+01:00",
   "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
   "activitystreams:to": {
-    "@type": "http://ns.adobe.com/adobecloudplatform/ims/organization",
-    "@id": "08B3E5CE5822FC520A494229@AdobeOrg"
+    "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
+    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
   },
   "activitystreams:generator": {
     "@type": "https://ns.adobe.com/xdm/content/repository",
-    "@id": "https://francois.corp.adobe.com:4502/"
+    "xdm:root": "https://cc-api-storage-stage.adobe.io/"
   },
   "activitystreams:actor": {
-    "@type": "https://ns.adobe.com/experience/aem/user",
-    "@id": "admin"
+    "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
+    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
   },
   "activitystreams:object": {
     "@type": "https://ns.adobe.com/xdm/assets/asset",
-    "repo:assetID": "urn:aaid:aem:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
-    "@id": "https://francois.corp.adobe.com:4502/content/dam/Fx_DUKE-small.jpg",
-    "xdm:name": "Fx_DUKE-small.png",
-    "xdm:path": "/content/dam/Fx_DUKE-small.png",
-    "dc:format": "image/png",
-    "repo:etag": "\"6fc55d0389d856ae7wddwebba54f110e\""
+    "repo:assetID": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
+    "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
+    "xdm:name": "example.jpg",
+    "xdm:path": "/MyFolder/example.jpg",
+    "dc:format": "image/jpg",
+    "repo:etag": "\"6fc55d0389d856ae7deccebba54f110e\""
   }
 }
 ```
 
 ```json
 {
-  "@type": "https://ns.adobe.com/xdm/common/event/created",
+  "@type": "https://ns.adobe.com/xdm/common/event/updated",
   "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
   "activitystreams:published": "2016-07-16T19:20:30+01:00",
   "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
   "activitystreams:to": {
-    "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
-    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+    "@type": "http://ns.adobe.com/adobecloudplatform/ims/organization",
+    "@id": "08B3E5CE5822FC520A494229@AdobeOrg"
   },
   "activitystreams:generator": {
     "@type": "https://ns.adobe.com/xdm/content/repository",
-    "xdm:root": "https://cc-api-storage-stage.adobe.io/"
+    "@id": "https://francois.corp.adobe.com:4502/"
   },
   "activitystreams:actor": {
-    "@type": "https://ns.adobe.com/adobecloudplatform/ims/user",
-    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+    "@type": "https://ns.adobe.com/experience/aem/user",
+    "@id": "admin"
   },
   "activitystreams:object": {
     "@type": "https://ns.adobe.com/xdm/assets/asset",
-    "repo:assetID": "urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
-    "@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185"
+    "repo:assetID": "urn:aaid:aem:4123ba4c-93a8-4c5d-b979-ffbbe4318185",
+    "@id": "https://francois.corp.adobe.com:4502/content/dam/Fx_DUKE-small.jpg",
+    "xdm:name": "Fx_DUKE-small.png",
+    "xdm:path": "/content/dam/Fx_DUKE-small.png",
+    "dc:format": "image/png",
+    "repo:etag": "\"6fc55d0389d856ae7wddwebba54f110e\""
   }
 }
 ```

diff --git a/docs/reference/common/geo.schema.json b/docs/reference/common/geo.schema.json
@@ -67,6 +67,13 @@
     ],
     "meta:status": "experimental",
     "examples": [
+        {
+            "@id": "https://data.adobe.io/entities/geo/potsdam",
+            "xdm:countryCode": "DE",
+            "xdm:stateProvince": "DE-BB",
+            "xdm:city": "Potsdam",
+            "xdm:postalCode": "14482"
+        },
         {
             "@id": "https://data.adobe.io/entities/geo/tokyo",
             "xdm:countryCode": "JP",
@@ -75,13 +82,6 @@
             "xdm:postalCode": "141-0032",
             "schema:latitude": 35.6185,
             "schema:longitude": 139.73237
-        },
-        {
-            "@id": "https://data.adobe.io/entities/geo/potsdam",
-            "xdm:countryCode": "DE",
-            "xdm:stateProvince": "DE-BB",
-            "xdm:city": "Potsdam",
-            "xdm:postalCode": "14482"
         }
     ]
 }
diff --git a/docs/reference/common/geo.schema.md b/docs/reference/common/geo.schema.md
@@ -18,6 +18,16 @@ The geographic related data where an event was observed.
 
 ## Geo Examples
 
+```json
+{
+  "@id": "https://data.adobe.io/entities/geo/potsdam",
+  "xdm:countryCode": "DE",
+  "xdm:stateProvince": "DE-BB",
+  "xdm:city": "Potsdam",
+  "xdm:postalCode": "14482"
+}
+```
+
 ```json
 {
   "@id": "https://data.adobe.io/entities/geo/tokyo",
@@ -30,16 +40,6 @@ The geographic related data where an event was observed.
 }
 ```
 
-```json
-{
-  "@id": "https://data.adobe.io/entities/geo/potsdam",
-  "xdm:countryCode": "DE",
-  "xdm:stateProvince": "DE-BB",
-  "xdm:city": "Potsdam",
-  "xdm:postalCode": "14482"
-}
-```
-
 
 # Geo Properties
 

diff --git a/docs/reference/common/page.schema.json b/docs/reference/common/page.schema.json
@@ -64,13 +64,13 @@
             "orderBy": "id",
             "start": "123",
             "next": "789",
-            "type": "image/jpeg",
             "count": 100
         },
         {
             "orderBy": "id",
             "start": "123",
             "next": "789",
+            "type": "image/jpeg",
             "count": 100
         }
     ]

diff --git a/docs/reference/common/page.schema.md b/docs/reference/common/page.schema.md
@@ -19,7 +19,6 @@ Page information for paginated resource list operations.
   "orderBy": "id",
   "start": "123",
   "next": "789",
-  "type": "image/jpeg",
   "count": 100
 }
 ```
@@ -29,6 +28,7 @@ Page information for paginated resource list operations.
   "orderBy": "id",
   "start": "123",
   "next": "789",
+  "type": "image/jpeg",
   "count": 100
 }
 ```

diff --git a/docs/reference/context/enduserids.schema.json b/docs/reference/context/enduserids.schema.json
@@ -41,14 +41,27 @@
             "title": "Adobe AdCloud End User IDs",
             "$ref": "https://ns.adobe.com/xdm/context/identity",
             "description": "Adobe Adcloud extension to End User IDs."
+        },
+        "https://ns.adobe.com/experience/emailid": {
+            "title": "Email Address IDs",
+            "$ref": "https://ns.adobe.com/xdm/context/identity",
+            "description": "Email addresses used as IDs."
+        },
+        "https://ns.adobe.com/experience/phonenumberid": {
+            "title": "Phone Number IDs",
+            "$ref": "https://ns.adobe.com/xdm/context/identity",
+            "description": "Phone numbers used as IDs."
         }
     },
     "meta:keys": {
         "https://ns.adobe.com/experience/adcloud": "Adobe AdCloud",
         "https://ns.adobe.com/experience/tntid": "Adobe Target",
         "https://ns.adobe.com/experience/acid": "Adobe Campaign",
         "https://ns.adobe.com/experience/aaid": "Adobe Analytics",
-        "https://ns.adobe.com/experience/mcid": "Marketing Cloud Identity Core Service"
+        "https://ns.adobe.com/experience/aacustomid": "Adobe Analytics Custom",
+        "https://ns.adobe.com/experience/mcid": "Marketing Cloud Identity Core Service",
+        "https://ns.adobe.com/experience/emailid": "Email Address",
+        "https://ns.adobe.com/experience/phonenumberid": "Phone Number"
     },
     "patternProperties": {
         ".+://.+": {