Skip to content

Commit

Permalink
[ci skip] updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@trieloff
trieloff committed Aug 17, 2018
1 parent 582de66 commit b721c58
Show file tree
Hide file tree
Showing 24 changed files with 866 additions and 871 deletions.
312 changes: 156 additions & 156 deletions STABILIZING.md
View file

Large diffs are not rendered by default.

166 changes: 83 additions & 83 deletions docs/reference/README.md
View file

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions docs/reference/assets/video.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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",
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: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",
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
View file
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: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",
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: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",
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
4 changes: 2 additions & 2 deletions docs/reference/common/descriptors/itemselector.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@
"meta:status": "experimental",
"examples": [
{
"xdm:index": 0
"xdm:id": "https://example.com/objects/12345"
},
{
"xdm:type": "https://ns.adobe.com/experience/mcid"
},
{
"xdm:id": "https://example.com/objects/12345"
"xdm:index": 0
},
{
"xdm:schema": "https://ns.adobe.com/xdm/context/identity"
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/common/descriptors/itemselector.schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.

```json
{
"xdm:index": 0
"xdm:id": "https://example.com/objects/12345"
}
```

Expand All @@ -30,7 +30,7 @@ Matching may be done based on array index, `@id`, `@type`, or schema URI.

```json
{
"xdm:id": "https://example.com/objects/12345"
"xdm:index": 0
}
```

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/common/eventenvelope.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,11 @@
"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\""
}
},
{
Expand All @@ -84,11 +88,7 @@
"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\""
"@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185"
}
},
{
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/common/eventenvelope.schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
"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\""
}
}
```
Expand All @@ -66,11 +70,7 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream
"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\""
"@id": "https://cc-api-storage-stage.adobe.io/id/urn:aaid:sc:us:4123ba4c-93a8-4c5d-b979-ffbbe4318185"
}
}
```
Expand Down
30 changes: 15 additions & 15 deletions docs/reference/common/extensible.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -257,21 +257,6 @@
],
"meta:status": "stabilizing",
"examples": [
{
"https://ns.example.com/asset_name": "custom_asset_1",
"repo:id": "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"
},
{
"repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab",
"xdm:createDate": "2017-09-26T15:52:25+00:00",
Expand Down Expand Up @@ -330,6 +315,21 @@
"repo:size": 1632418,
"xdm:path": "here",
"repo:etag": "15"
},
{
"https://ns.example.com/asset_name": "custom_asset_1",
"repo:id": "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"
}
]
}
36 changes: 18 additions & 18 deletions docs/reference/common/extensible.schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,24 +25,6 @@ Replace `#/definitions/…` with the correct path to the `definitions` object in

## Extensibility base schema Examples

```json
{
"https://ns.example.com/asset_name": "custom_asset_1",
"repo:id": "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
{
"repo:id": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab",
Expand Down Expand Up @@ -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:id": "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"
}
```

2 changes: 1 addition & 1 deletion docs/reference/common/page.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/common/page.schema.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ Page information for paginated resource list operations.
"orderBy": "id",
"start": "123",
"next": "789",
"type": "image/jpeg",
"count": 100
}
```
Expand All @@ -29,6 +28,7 @@ Page information for paginated resource list operations.
"orderBy": "id",
"start": "123",
"next": "789",
"type": "image/jpeg",
"count": 100
}
```
Expand Down
Loading

0 comments on commit b721c58

Please sign in to comment.