Skip to content

Commit

Permalink
[ci skip] updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
trieloff committed May 15, 2018
1 parent 45e4abf commit 0aad1e1
Show file tree
Hide file tree
Showing 24 changed files with 909 additions and 386 deletions.
281 changes: 141 additions & 140 deletions STABILIZING.md

Large diffs are not rendered by default.

103 changes: 52 additions & 51 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,32 @@



## /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` (Experimental)
* [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 Media](./assets/rectangular.schema.md)`https://ns.adobe.com/xdm/assets/rectangular` (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)
* [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)
Expand Down Expand Up @@ -40,32 +66,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)

## /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)

## /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` (Experimental)
* [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 Media](./assets/rectangular.schema.md)`https://ns.adobe.com/xdm/assets/rectangular` (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)
* [Video](./assets/video.schema.md)`https://ns.adobe.com/xdm/assets/video` (Experimental)

## /data/

* [Data Source](./data/datasource.schema.md)`https://ns.adobe.com/xdm/data/datasource` (Experimental)
Expand Down Expand Up @@ -109,6 +109,7 @@
* [ExperienceEvent](./context/experienceevent.schema.md)`https://ns.adobe.com/xdm/context/experienceevent` (Stabilizing)
* [Identity](./context/identity.schema.md)`https://ns.adobe.com/xdm/context/identity` (Experimental)
* [Implementation Details](./context/implementationdetails.schema.md)`https://ns.adobe.com/xdm/context/implementationdetails` (Experimental)
* [MRC Viewability](./context/adviewability.schema.md)`https://ns.adobe.com/xdm/context/adviewability` (Experimental)
* [Marketing](./context/marketing.schema.md)`https://ns.adobe.com/xdm/context/marketing` (Stabilizing)
* [Namespace](./context/namespace.schema.md)`https://ns.adobe.com/xdm/context/namespace` (Experimental)
* [OptInOut](./context/optinout.schema.md)`https://ns.adobe.com/xdm/context/optinout` (Experimental)
Expand All @@ -126,6 +127,12 @@
* [Web Page View](./context/webpageview.schema.md)`https://ns.adobe.com/xdm/context/webpageview` (Experimental)
* [Web Referrer](./context/webreferrer.schema.md)`https://ns.adobe.com/xdm/context/webreferrer` (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)

## /common/descriptors/

* [Item Selector](./common/descriptors/itemselector.schema.md)`https://ns.adobe.com/xdm/common/descriptors/itemselector` (Unknown)
Expand All @@ -141,11 +148,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)

## /content/repository-policies/
## /external/hal/

* [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)
* [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/repo/

* [Access Control Entry](./external/repo/accesscontrolentry.schema.md)`https://ns.adobe.com/xdm/external/repo/accesscontrolentry` (Experimental)
* [Access Control Policy](./external/repo/accesscontrolpolicy.schema.md)`https://ns.adobe.com/xdm/external/repo/accesscontrolpolicy` (Experimental)
* [Asset](./external/repo/asset.schema.md)`http://ns.adobe.com/adobecloud/core/1.0/asset` (Experimental)
* [Common Properties](./external/repo/common.schema.md)`http://ns.adobe.com/adobecloud/core/1.0` (Experimental)
* [Directory](./external/repo/directory.schema.md)`http://ns.adobe.com/adobecloud/core/1.0/directory` (Experimental)
* [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/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/

Expand All @@ -161,24 +183,3 @@
* [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/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/repo/

* [Access Control Entry](./external/repo/accesscontrolentry.schema.md)`https://ns.adobe.com/xdm/external/repo/accesscontrolentry` (Experimental)
* [Access Control Policy](./external/repo/accesscontrolpolicy.schema.md)`https://ns.adobe.com/xdm/external/repo/accesscontrolpolicy` (Experimental)
* [Asset](./external/repo/asset.schema.md)`http://ns.adobe.com/adobecloud/core/1.0/asset` (Experimental)
* [Common Properties](./external/repo/common.schema.md)`http://ns.adobe.com/adobecloud/core/1.0` (Experimental)
* [Directory](./external/repo/directory.schema.md)`http://ns.adobe.com/adobecloud/core/1.0/directory` (Experimental)
* [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)

12 changes: 6 additions & 6 deletions docs/reference/assets/video.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@
"meta:status": "experimental",
"examples": [
{
"repo:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ad",
"repo:assetID": "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",
Expand All @@ -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:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ac",
"repo:assetID": "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",
Expand All @@ -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"
}
]
}
12 changes: 6 additions & 6 deletions docs/reference/assets/video.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The Video class is for video assets, i.e. assets that consist of moving pictures

```json
{
"repo:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ad",
"repo:assetID": "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",
Expand All @@ -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:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ac",
"repo:assetID": "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",
Expand All @@ -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"
}
```

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/common/descriptors/itemselector.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@
"xdm:id": "https://example.com/objects/12345"
},
{
"xdm:type": "https://ns.adobe.com/experience/mcid"
"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"
"xdm:index": 0
}
]
}
6 changes: 3 additions & 3 deletions docs/reference/common/descriptors/itemselector.schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.

```json
{
"xdm:type": "https://ns.adobe.com/experience/mcid"
"xdm:schema": "https://ns.adobe.com/xdm/context/identity"
}
```

```json
{
"xdm:index": 0
"xdm:type": "https://ns.adobe.com/experience/mcid"
}
```

```json
{
"xdm:schema": "https://ns.adobe.com/xdm/context/identity"
"xdm:index": 0
}
```

44 changes: 22 additions & 22 deletions docs/reference/common/eventenvelope.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,34 +69,30 @@
}
},
{
"@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"
}
},
{
"@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",
Expand All @@ -120,30 +116,34 @@
}
},
{
"@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\""
}
},
{
"@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",
Expand Down
Loading

0 comments on commit 0aad1e1

Please sign in to comment.