fix docs

adobe · Nov 26, 2018 · 6e5e00f · 6e5e00f
2 parents 7e3757e + 5fe4c99
commit 6e5e00f
Show file tree

Hide file tree

Showing 38 changed files with 910 additions and 575 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
diff --git a/docs/reference/.DS_Store b/docs/reference/.DS_Store
diff --git 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,32 +43,6 @@
 * [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)
 
-## /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)
-
 ## /common/
 
 * [Address](./common/address.schema.md) – `https://ns.adobe.com/xdm/common/address` (Stabilizing)
@@ -68,6 +58,16 @@
 * [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)
 
+## /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)
@@ -197,11 +197,11 @@
 * [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/
+## /common/descriptors/
 
-* [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)
+* [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)
 
 ## /common/event/
 
@@ -213,6 +213,12 @@
 * [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)
@@ -232,12 +238,6 @@
 * [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/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/iptc/
 
 * [Creator](./external/iptc/creator.schema.md) – `http://www.iptc.org/creator` (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/.DS_Store b/docs/reference/common/.DS_Store
diff --git a/docs/reference/common/descriptors/itemselector.schema.json b/docs/reference/common/descriptors/itemselector.schema.json
@@ -78,13 +78,13 @@
     "meta:status": "experimental",
     "examples": [
         {
-            "xdm:id": "https://example.com/objects/12345"
+            "xdm:type": "https://ns.adobe.com/experience/mcid"
         },
         {
             "xdm:index": 0
         },
         {
-            "xdm:type": "https://ns.adobe.com/experience/mcid"
+            "xdm:id": "https://example.com/objects/12345"
         },
         {
             "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
@@ -18,7 +18,7 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.
 
 ```json
 {
-  "xdm:id": "https://example.com/objects/12345"
+  "xdm:type": "https://ns.adobe.com/experience/mcid"
 }
 ```
 
@@ -30,7 +30,7 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.
 
 ```json
 {
-  "xdm:type": "https://ns.adobe.com/experience/mcid"
+  "xdm:id": "https://example.com/objects/12345"
 }
 ```
 

diff --git a/docs/reference/common/eventenvelope.schema.json b/docs/reference/common/eventenvelope.schema.json
@@ -61,61 +61,61 @@
             "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"
+                "@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",
+            "@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:id": "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: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"
             }
         },
         {
-            "@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: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\""
+                "repo:id": "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\""
             }
         },
         {
-Original file line number
+Diff line change
@@ Expand Up @@
     ```json
     {
-      "xdm:id": "https://example.com/objects/12345"
+      "xdm:type": "https://ns.adobe.com/experience/mcid"
     }
     ```
@@ Expand All @@
     ```json
     {
-      "xdm:type": "https://ns.adobe.com/experience/mcid"
+      "xdm:id": "https://example.com/objects/12345"
     }
     ```
@@ Expand Down @@