[ci skip] updating documentation

adobe · Nov 26, 2018 · 5fe4c99 · 5fe4c99
1 parent 7e23e03
commit 5fe4c99
Show file tree

Hide file tree

Showing 22 changed files with 788 additions and 788 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -203,17 +203,6 @@
 * [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)
-* [Relationship Descriptor](./common/descriptors/relationshipdescriptor.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` (Experimental)
-* [Schema Descriptor](./common/descriptors/schemadescriptor.schema.md) – `https://ns.adobe.com/xdm/common/desciptors/schemadescriptor` (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)
-
 ## /common/event/
 
 * [Created Event](./common/event/created.schema.md) – `https://ns.adobe.com/xdm/common/event/created` (Experimental)
@@ -224,6 +213,26 @@
 * [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)
+* [Relationship Descriptor](./common/descriptors/relationshipdescriptor.schema.md) – `https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor` (Experimental)
+* [Schema Descriptor](./common/descriptors/schemadescriptor.schema.md) – `https://ns.adobe.com/xdm/common/desciptors/schemadescriptor` (Experimental)
+
+## /external/activity-streams-2/
+
+* [Activity](./external/activity-streams-2/activity.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/activity` (Experimental)
+* [Collection](./external/activity-streams-2/collection.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/collection` (Experimental)
+* [Collection Page](./external/activity-streams-2/collection-page.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/collection-page` (Experimental)
+* [Document](./external/activity-streams-2/document.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/document` (Experimental)
+* [Image Document](./external/activity-streams-2/image.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/image` (Experimental)
+* [JSON-LD `@context`](./external/activity-streams-2/context.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/context` (Experimental)
+* [JSON-LD `@id`](./external/activity-streams-2/id.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/id` (Experimental)
+* [JSON-LD `@type`](./external/activity-streams-2/type.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/type` (Experimental)
+* [Link](./external/activity-streams-2/link.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/link` (Experimental)
+* [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/iptc/
 
 * [Creator](./external/iptc/creator.schema.md) – `http://www.iptc.org/creator` (Experimental)
@@ -232,12 +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/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/repo/
 
 * [Access Control Entry](./external/repo/accesscontrolentry.schema.md) – `https://ns.adobe.com/xdm/external/repo/accesscontrolentry` (Experimental)
@@ -248,17 +251,14 @@
 * [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)
 
-## /external/activity-streams-2/
+## /external/hal/
 
-* [Activity](./external/activity-streams-2/activity.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/activity` (Experimental)
-* [Collection](./external/activity-streams-2/collection.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/collection` (Experimental)
-* [Collection Page](./external/activity-streams-2/collection-page.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/collection-page` (Experimental)
-* [Document](./external/activity-streams-2/document.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/document` (Experimental)
-* [Image Document](./external/activity-streams-2/image.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/image` (Experimental)
-* [JSON-LD `@context`](./external/activity-streams-2/context.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/context` (Experimental)
-* [JSON-LD `@id`](./external/activity-streams-2/id.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/id` (Experimental)
-* [JSON-LD `@type`](./external/activity-streams-2/type.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/type` (Experimental)
-* [Link](./external/activity-streams-2/link.schema.md) – `https://ns.adobe.com/xdm/external/activity-streams-2/link` (Experimental)
-* [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)
+* [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)
 
diff --git a/docs/reference/assets/video.schema.json b/docs/reference/assets/video.schema.json
@@ -65,7 +65,7 @@
     "meta:status": "experimental",
     "examples": [
         {
-            "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ad",
+            "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ac",
             "xmp:createDate": "2017-09-26T15:52:25+00:00",
             "repo:createdDate": "2017-09-26T15:52:25+00:00",
             "xdm:repositoryCreatedBy": "lars",
@@ -79,11 +79,11 @@
             "tiff:imageLength": 2160,
             "tiff:imageWidth": 3840,
             "xdm:aspectRatio": 1.77777777778,
-            "xdm:extent": 10920000,
-            "xdm:videoFrameRate": "f48s1"
+            "xdm:extent": 11700000,
+            "xdm:videoFrameRate": "NTSC"
         },
         {
-            "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ac",
+            "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ad",
             "xmp:createDate": "2017-09-26T15:52:25+00:00",
             "repo:createdDate": "2017-09-26T15:52:25+00:00",
             "xdm:repositoryCreatedBy": "lars",
@@ -97,8 +97,8 @@
             "tiff:imageLength": 2160,
             "tiff:imageWidth": 3840,
             "xdm:aspectRatio": 1.77777777778,
-            "xdm:extent": 11700000,
-            "xdm:videoFrameRate": "NTSC"
+            "xdm:extent": 10920000,
+            "xdm:videoFrameRate": "f48s1"
         }
     ]
 }
diff --git a/docs/reference/assets/video.schema.md b/docs/reference/assets/video.schema.md
@@ -21,7 +21,7 @@ The Video class is for video assets, i.e. assets that consist of moving pictures
 
 ```json
 {
-  "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ad",
+  "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ac",
   "xmp:createDate": "2017-09-26T15:52:25+00:00",
   "repo:createdDate": "2017-09-26T15:52:25+00:00",
   "xdm:repositoryCreatedBy": "lars",
@@ -35,14 +35,14 @@ The Video class is for video assets, i.e. assets that consist of moving pictures
   "tiff:imageLength": 2160,
   "tiff:imageWidth": 3840,
   "xdm:aspectRatio": 1.77777777778,
-  "xdm:extent": 10920000,
-  "xdm:videoFrameRate": "f48s1"
+  "xdm:extent": 11700000,
+  "xdm:videoFrameRate": "NTSC"
 }
 ```
 
 ```json
 {
-  "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ac",
+  "repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ad",
   "xmp:createDate": "2017-09-26T15:52:25+00:00",
   "repo:createdDate": "2017-09-26T15:52:25+00:00",
   "xdm:repositoryCreatedBy": "lars",
@@ -56,8 +56,8 @@ The Video class is for video assets, i.e. assets that consist of moving pictures
   "tiff:imageLength": 2160,
   "tiff:imageWidth": 3840,
   "xdm:aspectRatio": 1.77777777778,
-  "xdm:extent": 11700000,
-  "xdm:videoFrameRate": "NTSC"
+  "xdm:extent": 10920000,
+  "xdm:videoFrameRate": "f48s1"
 }
 ```
 

diff --git a/docs/reference/common/descriptors/itemselector.schema.json b/docs/reference/common/descriptors/itemselector.schema.json
@@ -84,10 +84,10 @@
             "xdm:index": 0
         },
         {
-            "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
+            "xdm:type": "https://ns.adobe.com/experience/mcid"
         },
         {
-            "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
@@ -30,13 +30,13 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.
 
 ```json
 {
-  "xdm:schema": "https://ns.adobe.com/xdm/context/identity"
+  "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
@@ -64,6 +64,33 @@
                 "@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",
+            "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:id": "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/updated",
             "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset",
@@ -92,7 +119,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",
@@ -116,34 +143,7 @@
             }
         },
         {
-            "@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:id": "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/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",

diff --git a/docs/reference/common/eventenvelope.schema.md b/docs/reference/common/eventenvelope.schema.md
@@ -45,6 +45,36 @@ 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:id": "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/updated",
@@ -77,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/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",
@@ -104,37 +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/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:id": "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/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",

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,6 +19,7 @@ Page information for paginated resource list operations.
   "orderBy": "id",
   "start": "123",
   "next": "789",
+  "type": "image/jpeg",
   "count": 100
 }
 ```
@@ -28,7 +29,6 @@ Page information for paginated resource list operations.
   "orderBy": "id",
   "start": "123",
   "next": "789",
-  "type": "image/jpeg",
   "count": 100
 }
 ```