[ci skip] updating documentation

adobe · Mar 20, 2018 · 9608b27 · 9608b27
1 parent c4c2dbf
commit 9608b27
Show file tree

Hide file tree

Showing 9 changed files with 162 additions and 162 deletions.
diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -20,29 +20,6 @@
 * [Rectangular Object (measured in variable unit)](./assets/variable-unit-rectangular.schema.md) – `https://ns.adobe.com/xdm/assets/variable-unit-rectangular`
 * [Video](./assets/video.schema.md) – `https://ns.adobe.com/xdm/assets/video`
 
-## /content/
-
-* [Component Container](./content/component-container.schema.md) – `https://ns.adobe.com/xdm/content/component-container`
-* [Componentized Page](./content/componentized-page.schema.md) – `https://ns.adobe.com/xdm/content/componentized-page`
-* [Content](./content/content.schema.md) – `https://ns.adobe.com/xdm/content/content`
-* [Page Component](./content/page-component.schema.md) – `https://ns.adobe.com/xdm/content/page-component`
-* [Product](./content/product.schema.md) – `https://ns.adobe.com/xdm/context/product`
-* [Product List Item](./content/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem`
-* [Content Repository](./content/repository.schema.md) – `https://ns.adobe.com/xdm/content/repository`
-
-## /common/
-
-* [Address](./common/address.schema.md) – `https://ns.adobe.com/xdm/common/address`
-* [Audit Trail](./common/auditable.schema.md) – `https://ns.adobe.com/xdm/common/auditable`
-* [EventEnvelope](./common/eventenvelope.schema.md) – `https://ns.adobe.com/xdm/common/eventenvelope`
-* [Extensibility base schema](./common/extensible.schema.md) – `https://ns.adobe.com/xdm/common/extensible`
-* [Geo](./common/geo.schema.md) – `https://ns.adobe.com/xdm/common/geo`
-* [Identity Provider](./common/identity-provider.schema.md) – `https://ns.adobe.com/xdm/common/identity-provider`
-* [Organization](./common/organization.schema.md) – `https://ns.adobe.com/xdm/common/organization`
-* [Page](./common/page.schema.md) – `https://ns.adobe.com/xdm/common/page`
-* [Principal](./common/principal.schema.md) – `https://ns.adobe.com/xdm/common/principal`
-* [Customer Managed Environment](./common/selfservice.schema.md) – `https://ns.adobe.com/xdm/selfservice`
-
 ## /channels/
 
 * [ADM](./channels/adm.schema.md) – `https://ns.adobe.com/xdm/channels/adm`
@@ -66,6 +43,29 @@
 * [WeChat](./channels/wechat.schema.md) – `https://ns.adobe.com/xdm/channels/wechat`
 * [WNS](./channels/wns.schema.md) – `https://ns.adobe.com/xdm/channels/wns`
 
+## /content/
+
+* [Component Container](./content/component-container.schema.md) – `https://ns.adobe.com/xdm/content/component-container`
+* [Componentized Page](./content/componentized-page.schema.md) – `https://ns.adobe.com/xdm/content/componentized-page`
+* [Content](./content/content.schema.md) – `https://ns.adobe.com/xdm/content/content`
+* [Page Component](./content/page-component.schema.md) – `https://ns.adobe.com/xdm/content/page-component`
+* [Product](./content/product.schema.md) – `https://ns.adobe.com/xdm/context/product`
+* [Product List Item](./content/productlistitem.schema.md) – `https://ns.adobe.com/xdm/content/productlistitem`
+* [Content Repository](./content/repository.schema.md) – `https://ns.adobe.com/xdm/content/repository`
+
+## /common/
+
+* [Address](./common/address.schema.md) – `https://ns.adobe.com/xdm/common/address`
+* [Audit Trail](./common/auditable.schema.md) – `https://ns.adobe.com/xdm/common/auditable`
+* [EventEnvelope](./common/eventenvelope.schema.md) – `https://ns.adobe.com/xdm/common/eventenvelope`
+* [Extensibility base schema](./common/extensible.schema.md) – `https://ns.adobe.com/xdm/common/extensible`
+* [Geo](./common/geo.schema.md) – `https://ns.adobe.com/xdm/common/geo`
+* [Identity Provider](./common/identity-provider.schema.md) – `https://ns.adobe.com/xdm/common/identity-provider`
+* [Organization](./common/organization.schema.md) – `https://ns.adobe.com/xdm/common/organization`
+* [Page](./common/page.schema.md) – `https://ns.adobe.com/xdm/common/page`
+* [Principal](./common/principal.schema.md) – `https://ns.adobe.com/xdm/common/principal`
+* [Customer Managed Environment](./common/selfservice.schema.md) – `https://ns.adobe.com/xdm/selfservice`
+
 ## /context/
 
 * [Browser Details](./context/browserdetails.schema.md) – `https://ns.adobe.com/xdm/context/browserdetails`
@@ -135,6 +135,17 @@
 * [Unpublished Event](./common/event/unpublished.schema.md) – `https://ns.adobe.com/xdm/common/event/unpublished`
 * [Updated Event](./common/event/updated.schema.md) – `https://ns.adobe.com/xdm/common/event/updated`
 
+## /external/hal/
+
+* [HAL Link](./external/hal/hal-link.schema.md) – `https://ns.adobe.com/xdm/external/hal/link`
+* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource`
+
+## /external/schema/
+
+* [Geo Circle](./external/schema/geocircle.schema.md) – `http://schema.org/GeoCircle`
+* [Geo Coordinates](./external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates`
+* [Geo Shape](./external/schema/geoshape.schema.md) – `http://schema.org/GeoShape`
+
 ## /external/activity-streams-2/
 
 * [Activity](./external/activity-streams-2/activity.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/activity`
@@ -149,17 +160,6 @@
 * [RDF Language Tagged String](./external/activity-streams-2/rdf-langstring.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring`
 * [JSON-LD `@type`](./external/activity-streams-2/type.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/type`
 
-## /external/schema/
-
-* [Geo Circle](./external/schema/geocircle.schema.md) – `http://schema.org/GeoCircle`
-* [Geo Coordinates](./external/schema/geocoordinates.schema.md) – `http://schema.org/GeoCoordinates`
-* [Geo Shape](./external/schema/geoshape.schema.md) – `http://schema.org/GeoShape`
-
-## /external/hal/
-
-* [HAL Link](./external/hal/hal-link.schema.md) – `https://ns.adobe.com/xdm/external/hal/link`
-* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource`
-
 ## /external/repo/
 
 * [Access Control Entry](./external/repo/accesscontrolentry.schema.md) – `https://ns.adobe.com/xdm/external/repo/accesscontrolentry`

diff --git a/docs/reference/common/eventenvelope.schema.json b/docs/reference/common/eventenvelope.schema.json
@@ -61,38 +61,38 @@
             "activitystreams:object": {
                 "@type": "http://ns.adobe.com/xdm/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"
             }
         },
         {
-            "@type": "http://ns.adobe.com/xdm/event/created",
+            "@type": "http://ns.adobe.com/xdm/event/updated",
             "xdm:objectType": "http://ns.adobe.com/xdm/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/xdm/IMSUser",
-                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+                "@type": "http://ns.adobe.com/xdm/IMSOrg",
+                "@id": "1362"
             },
             "activitystreams:generator": {
-                "@type": "http://ns.adobe.com/xdm/services",
-                "@id": "creative-cloud"
+                "@type": "http://ns.adobe.com/xdm/aem/instance",
+                "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com"
             },
             "activitystreams:actor": {
-                "@type": "http://ns.adobe.com/xdm/IMSUser",
-                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+                "@type": "http://ns.adobe.com/xdm/aem/user",
+                "@id": "admin"
             },
             "activitystreams:object": {
                 "@type": "http://ns.adobe.com/xdm/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\""
             }
         },
         {
-            "@type": "http://ns.adobe.com/xdm/event/published",
+            "@type": "http://ns.adobe.com/xdm/event/unpublished",
             "xdm:objectType": "http://ns.adobe.com/xdm/page",
             "activitystreams:published": "2016-07-16T19:20:30+01:00",
             "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
@@ -116,7 +116,7 @@
             }
         },
         {
-            "@type": "http://ns.adobe.com/xdm/event/unpublished",
+            "@type": "http://ns.adobe.com/xdm/event/published",
             "xdm:objectType": "http://ns.adobe.com/xdm/page",
             "activitystreams:published": "2016-07-16T19:20:30+01:00",
             "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
@@ -140,30 +140,30 @@
             }
         },
         {
-            "@type": "http://ns.adobe.com/xdm/event/updated",
+            "@type": "http://ns.adobe.com/xdm/event/created",
             "xdm:objectType": "http://ns.adobe.com/xdm/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/xdm/IMSOrg",
-                "@id": "1362"
+                "@type": "http://ns.adobe.com/xdm/IMSUser",
+                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
             },
             "activitystreams:generator": {
-                "@type": "http://ns.adobe.com/xdm/aem/instance",
-                "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com"
+                "@type": "http://ns.adobe.com/xdm/services",
+                "@id": "creative-cloud"
             },
             "activitystreams:actor": {
-                "@type": "http://ns.adobe.com/xdm/aem/user",
-                "@id": "admin"
+                "@type": "http://ns.adobe.com/xdm/IMSUser",
+                "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
             },
             "activitystreams:object": {
                 "@type": "http://ns.adobe.com/xdm/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\""
             }
         }
     ]

diff --git a/docs/reference/common/eventenvelope.schema.md b/docs/reference/common/eventenvelope.schema.md
@@ -40,44 +40,44 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
   "activitystreams:object": {
     "@type": "http://ns.adobe.com/xdm/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": "http://ns.adobe.com/xdm/event/created",
+  "@type": "http://ns.adobe.com/xdm/event/updated",
   "xdm:objectType": "http://ns.adobe.com/xdm/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/xdm/IMSUser",
-    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+    "@type": "http://ns.adobe.com/xdm/IMSOrg",
+    "@id": "1362"
   },
   "activitystreams:generator": {
-    "@type": "http://ns.adobe.com/xdm/services",
-    "@id": "creative-cloud"
+    "@type": "http://ns.adobe.com/xdm/aem/instance",
+    "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com"
   },
   "activitystreams:actor": {
-    "@type": "http://ns.adobe.com/xdm/IMSUser",
-    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
+    "@type": "http://ns.adobe.com/xdm/aem/user",
+    "@id": "admin"
   },
   "activitystreams:object": {
     "@type": "http://ns.adobe.com/xdm/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\""
   }
 }
 ```
 
 ```json
 {
-  "@type": "http://ns.adobe.com/xdm/event/published",
+  "@type": "http://ns.adobe.com/xdm/event/unpublished",
   "xdm:objectType": "http://ns.adobe.com/xdm/page",
   "activitystreams:published": "2016-07-16T19:20:30+01:00",
   "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
@@ -104,7 +104,7 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
 
 ```json
 {
-  "@type": "http://ns.adobe.com/xdm/event/unpublished",
+  "@type": "http://ns.adobe.com/xdm/event/published",
   "xdm:objectType": "http://ns.adobe.com/xdm/page",
   "activitystreams:published": "2016-07-16T19:20:30+01:00",
   "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b",
@@ -131,30 +131,30 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
 
 ```json
 {
-  "@type": "http://ns.adobe.com/xdm/event/updated",
+  "@type": "http://ns.adobe.com/xdm/event/created",
   "xdm:objectType": "http://ns.adobe.com/xdm/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/xdm/IMSOrg",
-    "@id": "1362"
+    "@type": "http://ns.adobe.com/xdm/IMSUser",
+    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
   },
   "activitystreams:generator": {
-    "@type": "http://ns.adobe.com/xdm/aem/instance",
-    "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com"
+    "@type": "http://ns.adobe.com/xdm/services",
+    "@id": "creative-cloud"
   },
   "activitystreams:actor": {
-    "@type": "http://ns.adobe.com/xdm/aem/user",
-    "@id": "admin"
+    "@type": "http://ns.adobe.com/xdm/IMSUser",
+    "@id": "D13A1E7053E46A220A4C86E1@AdobeID"
   },
   "activitystreams:object": {
     "@type": "http://ns.adobe.com/xdm/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\""
   }
 }
 ```

diff --git a/docs/reference/common/extensible.schema.json b/docs/reference/common/extensible.schema.json
@@ -257,6 +257,20 @@
     ],
     "meta:status": "experimental",
     "examples": [
+        {
+            "repo:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab",
+            "xdm:createDate": "2017-09-26T15:52:25+00:00",
+            "repo:createdDate": "2017-09-26T15:52:25+00:00",
+            "xdm:repositoryCreatedBy": "lars",
+            "xdm:modifyDate": "2017-09-26T15:52:25+00:00",
+            "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00",
+            "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00",
+            "repo:version": "15",
+            "dc:title": "This is an example",
+            "repo:size": 1632418,
+            "xdm:path": "/here",
+            "repo:etag": "15"
+        },
         {
             "https://ns.example.com/asset_name": "custom_asset_1",
             "repo:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab",
@@ -317,20 +331,6 @@
             "repo:size": 1632418,
             "xdm:path": "here",
             "repo:etag": "15"
-        },
-        {
-            "repo:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab",
-            "xdm:createDate": "2017-09-26T15:52:25+00:00",
-            "repo:createdDate": "2017-09-26T15:52:25+00:00",
-            "xdm:repositoryCreatedBy": "lars",
-            "xdm:modifyDate": "2017-09-26T15:52:25+00:00",
-            "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00",
-            "xdm:repositoryLastModifiedBy": "2017-09-26T15:52:25+00:00",
-            "repo:version": "15",
-            "dc:title": "This is an example",
-            "repo:size": 1632418,
-            "xdm:path": "/here",
-            "repo:etag": "15"
         }
     ]
 }