[ci skip] updating documentation

adobe · Apr 12, 2018 · d1ce03f · d1ce03f
1 parent 2edd2cd
commit d1ce03f
Show file tree

Hide file tree

Showing 9 changed files with 188 additions and 188 deletions.
diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -4,6 +4,29 @@
 
 
 
+## /channels/
+
+* [ADM](./channels/adm.schema.md) – `https://ns.adobe.com/xdm/channels/adm`
+* [E-Mail](./channels/agency.schema.md) – `https://ns.adobe.com/xdm/channels/agency`
+* [APNS](./channels/apns.schema.md) – `https://ns.adobe.com/xdm/channels/apns`
+* [Application](./channels/application.schema.md) – `https://ns.adobe.com/xdm/channels/application`
+* [Baidu](./channels/baidu.schema.md) – `https://ns.adobe.com/xdm/channels/baidu`
+* [Experience Channel](./channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel`
+* [Direct Mail](./channels/direct-mail.schema.md) – `https://ns.adobe.com/xdm/channels/direct-mail`
+* [E-Mail](./channels/email.schema.md) – `https://ns.adobe.com/xdm/channels/email`
+* [Facebook News Feed](./channels/facebook-feed.schema.md) – `https://ns.adobe.com/xdm/channels/facebook-feed`
+* [Fax](./channels/fax.schema.md) – `https://ns.adobe.com/xdm/channels/fax`
+* [GCM](./channels/gcm.schema.md) – `https://ns.adobe.com/xdm/channels/gcm`
+* [LINE](./channels/line.schema.md) – `https://ns.adobe.com/xdm/channels/line`
+* [Web](./channels/mobile-app.schema.md) – `https://ns.adobe.com/xdm/channels/mobile-app`
+* [MPNS](./channels/mpns.schema.md) – `https://ns.adobe.com/xdm/channels/mpns`
+* [Phone](./channels/phone.schema.md) – `https://ns.adobe.com/xdm/channels/phone`
+* [SMS](./channels/sms.schema.md) – `https://ns.adobe.com/xdm/channels/sms`
+* [Twitter Feed](./channels/twitter-feed.schema.md) – `https://ns.adobe.com/xdm/channels/twitter-feed`
+* [Web](./channels/web.schema.md) – `https://ns.adobe.com/xdm/channels/web`
+* [WeChat](./channels/wechat.schema.md) – `https://ns.adobe.com/xdm/channels/wechat`
+* [WNS](./channels/wns.schema.md) – `https://ns.adobe.com/xdm/channels/wns`
+
 ## /common/
 
 * [Address](./common/address.schema.md) – `https://ns.adobe.com/xdm/common/address`
@@ -43,29 +66,6 @@
 * [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`
 
-## /channels/
-
-* [ADM](./channels/adm.schema.md) – `https://ns.adobe.com/xdm/channels/adm`
-* [E-Mail](./channels/agency.schema.md) – `https://ns.adobe.com/xdm/channels/agency`
-* [APNS](./channels/apns.schema.md) – `https://ns.adobe.com/xdm/channels/apns`
-* [Application](./channels/application.schema.md) – `https://ns.adobe.com/xdm/channels/application`
-* [Baidu](./channels/baidu.schema.md) – `https://ns.adobe.com/xdm/channels/baidu`
-* [Experience Channel](./channels/channel.schema.md) – `https://ns.adobe.com/xdm/channels/channel`
-* [Direct Mail](./channels/direct-mail.schema.md) – `https://ns.adobe.com/xdm/channels/direct-mail`
-* [E-Mail](./channels/email.schema.md) – `https://ns.adobe.com/xdm/channels/email`
-* [Facebook News Feed](./channels/facebook-feed.schema.md) – `https://ns.adobe.com/xdm/channels/facebook-feed`
-* [Fax](./channels/fax.schema.md) – `https://ns.adobe.com/xdm/channels/fax`
-* [GCM](./channels/gcm.schema.md) – `https://ns.adobe.com/xdm/channels/gcm`
-* [LINE](./channels/line.schema.md) – `https://ns.adobe.com/xdm/channels/line`
-* [Web](./channels/mobile-app.schema.md) – `https://ns.adobe.com/xdm/channels/mobile-app`
-* [MPNS](./channels/mpns.schema.md) – `https://ns.adobe.com/xdm/channels/mpns`
-* [Phone](./channels/phone.schema.md) – `https://ns.adobe.com/xdm/channels/phone`
-* [SMS](./channels/sms.schema.md) – `https://ns.adobe.com/xdm/channels/sms`
-* [Twitter Feed](./channels/twitter-feed.schema.md) – `https://ns.adobe.com/xdm/channels/twitter-feed`
-* [Web](./channels/web.schema.md) – `https://ns.adobe.com/xdm/channels/web`
-* [WeChat](./channels/wechat.schema.md) – `https://ns.adobe.com/xdm/channels/wechat`
-* [WNS](./channels/wns.schema.md) – `https://ns.adobe.com/xdm/channels/wns`
-
 ## /context/
 
 * [Browser Details](./context/browserdetails.schema.md) – `https://ns.adobe.com/xdm/context/browserdetails`
@@ -136,26 +136,26 @@
 * [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`
 
-## /content/repository-policies/
-
-* [At-Rest Encryption](./content/repository-policies/encryption.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/encryption`
-* [Storage Quota](./content/repository-policies/quota.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/quota`
-* [Versioning](./content/repository-policies/versioning.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/versioning`
-
 ## /external/activity-streams-2/
 
 * [Activity](./external/activity-streams-2/activity.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/activity`
 * [Collection Page](./external/activity-streams-2/collection-page.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/collection-page`
 * [Collection](./external/activity-streams-2/collection.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/collection`
-* [Document](./external/activity-streams-2/document.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/document`
 * [JSON-LD `@context`](./external/activity-streams-2/context.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/context`
+* [Document](./external/activity-streams-2/document.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/document`
 * [JSON-LD `@id`](./external/activity-streams-2/id.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/id`
 * [Image Document](./external/activity-streams-2/image.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/image`
 * [Link](./external/activity-streams-2/link.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/link`
 * [Object](./external/activity-streams-2/object.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/object`
 * [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`
@@ -171,8 +171,8 @@
 * [Effective Privileges](./external/repo/effectiveprivileges.schema.md) – `https://ns.adobe.com/xdm/external/repo/effectiveprivileges`
 * [Sub-Directory](./external/repo/sub-directory.schema.md) – `http://ns.adobe.com/adobecloud/core/1.0/sub-directory`
 
-## /external/schema/
+## /content/repository-policies/
 
-* [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`
+* [At-Rest Encryption](./content/repository-policies/encryption.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/encryption`
+* [Storage Quota](./content/repository-policies/quota.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/quota`
+* [Versioning](./content/repository-policies/versioning.schema.md) – `https://ns.adobe.com/xdm/content/repository-policies/versioning`
diff --git a/docs/reference/common/eventenvelope.schema.json b/docs/reference/common/eventenvelope.schema.json
@@ -41,6 +41,33 @@
     ],
     "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",
+                "xdm:name": "example.jpg",
+                "xdm:path": "/MyFolder/example.jpg",
+                "dc:format": "image/jpg",
+                "repo:etag": "\"6fc55d0389d856ae7deccebba54f110e\""
+            }
+        },
         {
             "@type": "https://ns.adobe.com/xdm/common/event/created",
             "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
@@ -138,33 +165,6 @@
                 "dc:title": "Vintage Collection",
                 "xdm:path": "/content/geometrixx/en/vintage.html"
             }
-        },
-        {
-            "@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",
-                "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
@@ -19,6 +19,36 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
 
 ## EventEnvelope Examples
 
+```json
+{
+  "@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",
+    "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",
@@ -129,36 +159,6 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
 }
 ```
 
-```json
-{
-  "@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",
-    "xdm:name": "example.jpg",
-    "xdm:path": "/MyFolder/example.jpg",
-    "dc:format": "image/jpg",
-    "repo:etag": "\"6fc55d0389d856ae7deccebba54f110e\""
-  }
-}
-```
-
 
 # EventEnvelope Properties
 

diff --git a/docs/reference/common/extensible.schema.json b/docs/reference/common/extensible.schema.json
@@ -264,21 +264,6 @@
             "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",
-            "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:repository_lastModifiedBy": "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"
-        },
         {
             "@context": {
                 "xdm": "https://ns.adobe.com/xdm/",
@@ -323,6 +308,21 @@
             "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",
+            "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:repository_lastModifiedBy": "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"
         }
     ]
 }
diff --git a/docs/reference/common/extensible.schema.md b/docs/reference/common/extensible.schema.md
@@ -42,24 +42,6 @@ Replace `#/definitions/…` with the correct path to the `definitions` object in
 }
 ```
 
-```json
-{
-  "https://ns.example.com/asset_name": "custom_asset_1",
-  "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:repository_lastModifiedBy": "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"
-}
-```
-
 ```json
 {
   "@context": {
@@ -108,3 +90,21 @@ Replace `#/definitions/…` with the correct path to the `definitions` object in
 }
 ```
 
+```json
+{
+  "https://ns.example.com/asset_name": "custom_asset_1",
+  "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:repository_lastModifiedBy": "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"
+}
+```
+
diff --git a/docs/reference/context/person-name.schema.json b/docs/reference/context/person-name.schema.json
@@ -48,11 +48,6 @@
     ],
     "meta:status": "experimental",
     "examples": [
-        {
-            "xdm:firstName": "فلانة",
-            "xdm:lastName": "الفلانية",
-            "xdm:fullName": "فلانة الفلانية"
-        },
         {
             "xdm:firstName": "John",
             "xdm:middleName": "S",
@@ -63,6 +58,11 @@
             "xdm:firstName": "张",
             "xdm:lastName": "三",
             "xdm:fullName": "张三"
+        },
+        {
+            "xdm:firstName": "فلانة",
+            "xdm:lastName": "الفلانية",
+            "xdm:fullName": "فلانة الفلانية"
         }
     ]
 }
diff --git a/docs/reference/context/person-name.schema.md b/docs/reference/context/person-name.schema.md
@@ -16,14 +16,6 @@ In addition, a number of optional properties are made available that can be used
 
 ## Person Name Examples
 
-```json
-{
-  "xdm:firstName": "فلانة",
-  "xdm:lastName": "الفلانية",
-  "xdm:fullName": "فلانة الفلانية"
-}
-```
-
 ```json
 {
   "xdm:firstName": "John",
@@ -41,6 +33,14 @@ In addition, a number of optional properties are made available that can be used
 }
 ```
 
+```json
+{
+  "xdm:firstName": "فلانة",
+  "xdm:lastName": "الفلانية",
+  "xdm:fullName": "فلانة الفلانية"
+}
+```
+
 
 # Person Name Properties