From bb62321992c1747d97517b051ad600a79175bfba Mon Sep 17 00:00:00 2001 From: cdegroot Date: Fri, 9 Mar 2018 15:02:29 -0500 Subject: [PATCH 1/2] Corrected spelling Improved guidance on how to run the local validation Moved the AEM package creation to a lower optional section because it is not as important as basic validation. --- CONTRIBUTING.md | 25 +++++++++---------- README.md | 66 +++++++++++++++++++++++++------------------------ 2 files changed, 45 insertions(+), 46 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5c4ee113..166f96c09 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ The Experience Data Model (XDM) project is developed as an Open Standard driven ## Public GitHub Ground Rules We are in the process of increasing the visibility of XDM to partners and to invite them to contribute and give feedback. -For this purpose, we will move the XDM repository to [https://github.com/adobe/xdm](https://github.com/adobe/xdm). +For this purpose, we have moved the XDM repository to [https://github.com/adobe/xdm](https://github.com/adobe/xdm). For Adobe employees, following ground rules apply: * Like everyone, follow the [Code of Conduct](CODE_OF_CONDUCT.md) @@ -46,12 +46,12 @@ You can include the Creative Commons Attribution 4.0 International (CC BY 4.0) l ## How to Contribute -1. Go to the [list of open issues](https://git.corp.adobe.com/AdobeCloudPlatform/xdm/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and pick an issue you want to work on. If you don't see the appropriate issue, [create a new issue in GitHub](https://git.corp.adobe.com/AdobeCloudPlatform/xdm/issues/new) -2. If you haven't done so yet, [fork the XDM repository into your private GitHub organization](https://git.corp.adobe.com/AdobeCloudPlatform/xdm/fork). If your fork exists, merge the latest updates from `AdobeCloudPlatform/xdm` into `yourname/xdm`, so that you don't start from an outdated code tree -3. In `yourname/xdm` create a new branch from `master`. Your branch name should either refer the issue number like `bug-42` or `feature-23` or have a descriptive name like `fix-layer-group-references` +1. Go to the [list of open issues](https://github.com/adobe/xdm/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) and pick an issue you want to work on. If you don't see the appropriate issue, [create a new issue in GitHub](https://github.com/adobe/xdm/issues/new) +2. If you haven't done so yet, [fork the XDM repository into your private GitHub organization](https://github.com/adobe/xdm/fork). If your fork exists, merge the latest updates from `adobe/xdm` into `yourname/xdm`, so that you don't start from an outdated code tree +3. In `yourname/xdm` create a new branch from `master`. Your branch name should refer the issue number like `bug-42` or `feature-23` where one exists and have a descriptive name like `fix-layer-group-references` 4. Make add edits that apply to the given feature or bug against this new branch. Commit and push in frequent intervals -5. If you are working on the branch for more than a day, make sure to occasionally (at least once per day) to merge the latest updates from `AdobeCloudPlatform/xdm#master` into your branch, so that you won't get surprised when it's time to merge the pull request. Resolve any conflicts to make life easier for the XDM editors -6. Once you are done, create a pull request from your branch against `AdobeCloudPlatform/xdm#master`. +5. If you are working on the branch for more than a day, make sure to occasionally (at least once per day) to merge the latest updates from `adobe/xdm#master` into your branch, so that you won't get surprised when it's time to merge the pull request. Resolve any conflicts to make life easier for the XDM editors +6. Once you are done, create a pull request from your branch against `adobe/xdm#master`. Every pull request should specify: @@ -61,15 +61,12 @@ Every pull request should specify: For every update to the schema, make sure -* `npm test` validates all example files -* There are `schemas/*/*.example.*.json` files for each newly created schema +* `npm test` validates all example files, see [README.md](README.md) +* There are `schemas/*/*.example.*.json` files for each newly created or changed schema Furthermore, a pull request that modifies the schema must also include accompanying documentation. Pull requests with missing documentation will be rejected. -Each commit message that is not part of a pull request: - -* Should contain the issue ID like `#42` -* Can contain the tag `[trivial]` for trivial changes that don't relate to an issue +All changes to the adobe/xdm repository now require an associated pull request. ## Design Guidelines @@ -85,7 +82,7 @@ The target consumers of the data model are developers building applications usin Our goal is to establish a universal standard for the experience business. As such, this standard's lifetime will be comparable to standards like PDF (24 years old), EXIF (22 years old), or HTML (24 years old). -The design decisions made today will impact future developers, who will have only limited understanding, patience, or sympathy for constraints dictated by current Adobe implementations. While future requirements cannot be predicted in detail, it is important to accomodate requirements and industry trends. +The design decisions made today will impact future developers, who will have only limited understanding, patience, or sympathy for constraints dictated by current Adobe implementations. While future requirements cannot be predicted in detail, it is important to accommodate requirements and industry trends. ### Design for Clarity @@ -101,7 +98,7 @@ XDM is not an isolated standard, but incorporates and builds on standards. Whene ### Design for Compatibility -Interoperability with [Microsoft's Common Data Model (CDM)](https://docs.microsoft.com/en-us/common-data-service/entity-reference/common-data-model)is a top priority. This means that definitions that are present in CDM should be used or extended, where appropriate, by XDM. XDM should not attempt to duplicate definitions that are present in CDM. +Interoperability with [Microsoft's Common Data Model (CDM)](https://github.com/Microsoft/CDM)is a top priority. This means that definitions that are present in CDM should be used or extended, where appropriate, by XDM. XDM should not attempt to duplicate definitions that are present in CDM. Where appropriate, we can 'lead' CDM, extend it to meet other requirements. Another good source of data model elements is [schema.org](http://schema.org). diff --git a/README.md b/README.md index 5a57b0431..53df93690 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![CircleCI](https://circleci.com/gh/adobe/xdm.svg?style=svg)](https://circleci.com/gh/adobe/xdm) The [Experience Data Model](https://www.adobe.io/open/standards/xdm) (XDM) is the language of digital experiences. -XDM is a publicly documented specification, driven by Adobe to improve the interoperability, expressivness, and power of digital experiences. +XDM is a publicly documented specification, driven by Adobe to improve the interoperability, expressiveness, and power of digital experiences. This repository contains the source code for the formal specification of the XDM model, using the JSON Schema language. ## Read the XDM Spec @@ -49,9 +49,40 @@ You need: 1. Node.js and `npm` 2. `curl` -### AEM Package Generation +### Validation of local changes prior to creating any Pull Requests to adobe/xdm -When all dependencies are installed, simply run +This project contains a minimal validation script that depends on [NPM](https://www.npmjs.com). You can use it to validate the JSON example files against the JSON Schema files after making changes to either. + +From the root directory of the local repository run: + +```bash +$ npm install +$ npm test + +> xdm-models@0.0.1 test /Users/lars/Code/models +> sh validate.sh + +Validating schemas/common/eventenvelope.example.1.json against schemas/common/eventenvelope.schema.json +schemas/common/eventenvelope.example.1.json valid +Validating schemas/common/eventenvelope.example.2.json against schemas/common/eventenvelope.schema.json +schemas/common/eventenvelope.example.2.json valid +Validating schemas/common/eventenvelope.example.3.json against schemas/common/eventenvelope.schema.json +schemas/common/eventenvelope.example.3.json valid +Validating schemas/common/eventenvelope.example.4.json against schemas/common/eventenvelope.schema.json +schemas/common/eventenvelope.example.4.json valid +Validating schemas/common/eventenvelope.example.5.json against schemas/common/eventenvelope.schema.json +schemas/common/eventenvelope.example.5.json valid +``` + +If you see warnings or error messages (or an non-zero exit code), fix them before making a pull request. + +## Naming Conventions + +* see the [Contributor's guide](CONTRIBUTING.md) + +### AEM Package Generation (optional) + +With all dependencies installed, run the following commands from the root directory of the local repository: ```bash $ npm install @@ -93,35 +124,6 @@ This will generate documentation, create an AEM package, install it on (stage) a The `package.json` script will fetch a released version of the AEM Markdown Importer JAR using curl. -### Validation - -This project contains a minimal validation script that depends on [NPM](https://www.npmjs.com). You can use it to validate the JSON example files against the JSON Schema files after making changes to either. - -```bash -$ npm install -$ npm test - -> xdm-models@0.0.1 test /Users/lars/Code/models -> sh validate.sh - -Validating schemas/common/eventenvelope.example.1.json against schemas/common/eventenvelope.schema.json -schemas/common/eventenvelope.example.1.json valid -Validating schemas/common/eventenvelope.example.2.json against schemas/common/eventenvelope.schema.json -schemas/common/eventenvelope.example.2.json valid -Validating schemas/common/eventenvelope.example.3.json against schemas/common/eventenvelope.schema.json -schemas/common/eventenvelope.example.3.json valid -Validating schemas/common/eventenvelope.example.4.json against schemas/common/eventenvelope.schema.json -schemas/common/eventenvelope.example.4.json valid -Validating schemas/common/eventenvelope.example.5.json against schemas/common/eventenvelope.schema.json -schemas/common/eventenvelope.example.5.json valid -``` - -If you see warnings or error messages (or an non-zero exit code), fix them before making a pull request. - -## Naming Conventions - -* see the [Contributor's guide](CONTRIBUTING.md) - ## Links ### Specifications From 2b7a2b1ca9b7827828e0fee2ab4c613751b84ffa Mon Sep 17 00:00:00 2001 From: CircleCI Date: Mon, 19 Mar 2018 22:55:55 +0000 Subject: [PATCH 2/2] [ci skip] updating documentation --- docs/reference/README.md | 38 ++++----- .../common/eventenvelope.schema.json | 36 ++++---- docs/reference/common/eventenvelope.schema.md | 36 ++++---- docs/reference/common/extensible.schema.json | 28 +++---- docs/reference/common/extensible.schema.md | 34 ++++---- .../content/page-component.schema.json | 8 +- .../content/page-component.schema.md | 14 ++-- .../reference/context/person-name.schema.json | 10 +-- docs/reference/context/person-name.schema.md | 12 +-- docs/reference/external/hal/hal.schema.json | 80 +++++++++--------- docs/reference/external/hal/hal.schema.md | 82 +++++++++---------- .../external/repo/directory.schema.json | 12 +-- .../external/repo/directory.schema.md | 12 +-- 13 files changed, 201 insertions(+), 201 deletions(-) diff --git a/docs/reference/README.md b/docs/reference/README.md index ad9a81b60..df6743b65 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -30,6 +30,19 @@ * [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` +## /common/ + +* [Address](./common/address.schema.md) – `https://ns.adobe.com/xdm/common/address` +* [Audit Trail](./common/auditable.schema.md) – `https://ns.adobe.com/xdm/common/auditable` +* [EventEnvelope](./common/eventenvelope.schema.md) – `https://ns.adobe.com/xdm/common/eventenvelope` +* [Extensibility base schema](./common/extensible.schema.md) – `https://ns.adobe.com/xdm/common/extensible` +* [Geo](./common/geo.schema.md) – `https://ns.adobe.com/xdm/common/geo` +* [Identity Provider](./common/identity-provider.schema.md) – `https://ns.adobe.com/xdm/common/identity-provider` +* [Organization](./common/organization.schema.md) – `https://ns.adobe.com/xdm/common/organization` +* [Page](./common/page.schema.md) – `https://ns.adobe.com/xdm/common/page` +* [Principal](./common/principal.schema.md) – `https://ns.adobe.com/xdm/common/principal` +* [Customer Managed Environment](./common/selfservice.schema.md) – `https://ns.adobe.com/xdm/selfservice` + ## /channels/ * [ADM](./channels/adm.schema.md) – `https://ns.adobe.com/xdm/channels/adm` @@ -53,19 +66,6 @@ * [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` -* [Audit Trail](./common/auditable.schema.md) – `https://ns.adobe.com/xdm/common/auditable` -* [EventEnvelope](./common/eventenvelope.schema.md) – `https://ns.adobe.com/xdm/common/eventenvelope` -* [Extensibility base schema](./common/extensible.schema.md) – `https://ns.adobe.com/xdm/common/extensible` -* [Geo](./common/geo.schema.md) – `https://ns.adobe.com/xdm/common/geo` -* [Identity Provider](./common/identity-provider.schema.md) – `https://ns.adobe.com/xdm/common/identity-provider` -* [Organization](./common/organization.schema.md) – `https://ns.adobe.com/xdm/common/organization` -* [Page](./common/page.schema.md) – `https://ns.adobe.com/xdm/common/page` -* [Principal](./common/principal.schema.md) – `https://ns.adobe.com/xdm/common/principal` -* [Customer Managed Environment](./common/selfservice.schema.md) – `https://ns.adobe.com/xdm/selfservice` - ## /context/ * [Browser Details](./context/browserdetails.schema.md) – `https://ns.adobe.com/xdm/context/browserdetails` @@ -86,8 +86,8 @@ * [Place](./context/place.schema.md) – `https://ns.adobe.com/xdm/context/place` * [Profile](./context/profile.schema.md) – `https://ns.adobe.com/xdm/context/profile` * [Push Notification Token](./context/pushnotificationtoken.schema.md) – `https://ns.adobe.com/xdm/context/pushnotificationtoken` -* [Subscription](./context/subscription.schema.md) – `https://ns.adobe.com/xdm/context/subscription` * [Search](./context/search.schema.md) – `https://ns.adobe.com/xdm/context/search` +* [Subscription](./context/subscription.schema.md) – `https://ns.adobe.com/xdm/context/subscription` * [Web Link](./context/weblink.schema.md) – `https://ns.adobe.com/xdm/context/weblink` ## /data/ @@ -149,17 +149,17 @@ * [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/hal/ - -* [HAL Link](./external/hal/hal-link.schema.md) – `https://ns.adobe.com/xdm/external/hal/link` -* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource` - ## /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` +* [HAL Resource](./external/hal/hal.schema.md) – `https://ns.adobe.com/xdm/external/hal/resource` + ## /external/repo/ * [Access Control Entry](./external/repo/accesscontrolentry.schema.md) – `https://ns.adobe.com/xdm/external/repo/accesscontrolentry` diff --git a/docs/reference/common/eventenvelope.schema.json b/docs/reference/common/eventenvelope.schema.json index d76baa088..68452b809 100644 --- a/docs/reference/common/eventenvelope.schema.json +++ b/docs/reference/common/eventenvelope.schema.json @@ -92,8 +92,8 @@ } }, { - "@type": "http://ns.adobe.com/xdm/event/updated", - "xdm:objectType": "http://ns.adobe.com/xdm/asset", + "@type": "http://ns.adobe.com/xdm/event/published", + "xdm:objectType": "http://ns.adobe.com/xdm/page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "activitystreams:to": { @@ -102,24 +102,21 @@ }, "activitystreams:generator": { "@type": "http://ns.adobe.com/xdm/aem/instance", - "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com" + "@id": "AEM-Sites-08B3E5CE5822FC520A494229@AdobeOrg1373843566" }, "activitystreams:actor": { "@type": "http://ns.adobe.com/xdm/aem/user", "@id": "admin" }, "activitystreams:object": { - "@type": "http://ns.adobe.com/xdm/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\"" + "@type": "http://ns.adobe.com/xdm/page", + "@id": "http://adobesummit.adobesandbox.com:4502/content/geometrixx/en/vintage.html", + "dc:title": "Vintage Collection", + "xdm:path": "/content/geometrixx/en/vintage.html" } }, { - "@type": "http://ns.adobe.com/xdm/event/published", + "@type": "http://ns.adobe.com/xdm/event/unpublished", "xdm:objectType": "http://ns.adobe.com/xdm/page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", @@ -143,8 +140,8 @@ } }, { - "@type": "http://ns.adobe.com/xdm/event/unpublished", - "xdm:objectType": "http://ns.adobe.com/xdm/page", + "@type": "http://ns.adobe.com/xdm/event/updated", + "xdm:objectType": "http://ns.adobe.com/xdm/asset", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "activitystreams:to": { @@ -153,17 +150,20 @@ }, "activitystreams:generator": { "@type": "http://ns.adobe.com/xdm/aem/instance", - "@id": "AEM-Sites-08B3E5CE5822FC520A494229@AdobeOrg1373843566" + "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com" }, "activitystreams:actor": { "@type": "http://ns.adobe.com/xdm/aem/user", "@id": "admin" }, "activitystreams:object": { - "@type": "http://ns.adobe.com/xdm/page", - "@id": "http://adobesummit.adobesandbox.com:4502/content/geometrixx/en/vintage.html", - "dc:title": "Vintage Collection", - "xdm:path": "/content/geometrixx/en/vintage.html" + "@type": "http://ns.adobe.com/xdm/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\"" } } ] diff --git a/docs/reference/common/eventenvelope.schema.md b/docs/reference/common/eventenvelope.schema.md index 652d1432d..e9b0eedd6 100644 --- a/docs/reference/common/eventenvelope.schema.md +++ b/docs/reference/common/eventenvelope.schema.md @@ -77,8 +77,8 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream ```json { - "@type": "http://ns.adobe.com/xdm/event/updated", - "xdm:objectType": "http://ns.adobe.com/xdm/asset", + "@type": "http://ns.adobe.com/xdm/event/published", + "xdm:objectType": "http://ns.adobe.com/xdm/page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "activitystreams:to": { @@ -87,27 +87,24 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream }, "activitystreams:generator": { "@type": "http://ns.adobe.com/xdm/aem/instance", - "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com" + "@id": "AEM-Sites-08B3E5CE5822FC520A494229@AdobeOrg1373843566" }, "activitystreams:actor": { "@type": "http://ns.adobe.com/xdm/aem/user", "@id": "admin" }, "activitystreams:object": { - "@type": "http://ns.adobe.com/xdm/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\"" + "@type": "http://ns.adobe.com/xdm/page", + "@id": "http://adobesummit.adobesandbox.com:4502/content/geometrixx/en/vintage.html", + "dc:title": "Vintage Collection", + "xdm:path": "/content/geometrixx/en/vintage.html" } } ``` ```json { - "@type": "http://ns.adobe.com/xdm/event/published", + "@type": "http://ns.adobe.com/xdm/event/unpublished", "xdm:objectType": "http://ns.adobe.com/xdm/page", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", @@ -134,8 +131,8 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream ```json { - "@type": "http://ns.adobe.com/xdm/event/unpublished", - "xdm:objectType": "http://ns.adobe.com/xdm/page", + "@type": "http://ns.adobe.com/xdm/event/updated", + "xdm:objectType": "http://ns.adobe.com/xdm/asset", "activitystreams:published": "2016-07-16T19:20:30+01:00", "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "activitystreams:to": { @@ -144,17 +141,20 @@ An `EventEnvelope` is a type of `Activity` (in the sense of [W3C Activity Stream }, "activitystreams:generator": { "@type": "http://ns.adobe.com/xdm/aem/instance", - "@id": "AEM-Sites-08B3E5CE5822FC520A494229@AdobeOrg1373843566" + "@id": "AEM-08B3E5CE5822FC520A494229@AdobeOrg_francois.corp.adobe.com" }, "activitystreams:actor": { "@type": "http://ns.adobe.com/xdm/aem/user", "@id": "admin" }, "activitystreams:object": { - "@type": "http://ns.adobe.com/xdm/page", - "@id": "http://adobesummit.adobesandbox.com:4502/content/geometrixx/en/vintage.html", - "dc:title": "Vintage Collection", - "xdm:path": "/content/geometrixx/en/vintage.html" + "@type": "http://ns.adobe.com/xdm/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\"" } } ``` diff --git a/docs/reference/common/extensible.schema.json b/docs/reference/common/extensible.schema.json index 3ed3dc0cc..885fdb58d 100644 --- a/docs/reference/common/extensible.schema.json +++ b/docs/reference/common/extensible.schema.json @@ -257,20 +257,6 @@ ], "meta:status": "experimental", "examples": [ - { - "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:repositoryLastModifiedBy": "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" - }, { "https://ns.example.com/asset_name": "custom_asset_1", "repo:assetID": "urn:aaid:a:b:01234578-0123-ABCD-abcd-0123456789ab", @@ -331,6 +317,20 @@ "repo:size": 1632418, "xdm:path": "here", "repo:etag": "15" + }, + { + "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:repositoryLastModifiedBy": "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" } ] } \ No newline at end of file diff --git a/docs/reference/common/extensible.schema.md b/docs/reference/common/extensible.schema.md index 319d256c4..d58c172f2 100644 --- a/docs/reference/common/extensible.schema.md +++ b/docs/reference/common/extensible.schema.md @@ -25,23 +25,6 @@ Replace `#/definitions/…` with the correct path to the `definitions` object in ## Extensibility base schema Examples -```json -{ - "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:repositoryLastModifiedBy": "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 { "https://ns.example.com/asset_name": "custom_asset_1", @@ -109,3 +92,20 @@ Replace `#/definitions/…` with the correct path to the `definitions` object in } ``` +```json +{ + "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:repositoryLastModifiedBy": "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/content/page-component.schema.json b/docs/reference/content/page-component.schema.json index b3ad4b9a5..ed3429d51 100644 --- a/docs/reference/content/page-component.schema.json +++ b/docs/reference/content/page-component.schema.json @@ -32,6 +32,10 @@ ], "meta:status": "experimental", "examples": [ + { + "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", + "dc:title": "Protect Your Eyes" + }, { "@type": "https://francois.corp.adobe.com:4502/apps/foundation/image", "image": { @@ -39,10 +43,6 @@ "repo:assetID": "urn:aaid:aem:4123ba4c-93a8-4c5d-b979-1234e4318185", "@id": "https://francois.corp.adobe.com:4502/content/dam/Glasses-small.jpg" } - }, - { - "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", - "dc:title": "Protect Your Eyes" } ] } \ No newline at end of file diff --git a/docs/reference/content/page-component.schema.md b/docs/reference/content/page-component.schema.md index b4f3e2f9c..419df54b9 100644 --- a/docs/reference/content/page-component.schema.md +++ b/docs/reference/content/page-component.schema.md @@ -21,6 +21,13 @@ The type determines how the component will be displayed, rendered, and authored. ## Page Component Examples +```json +{ + "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", + "dc:title": "Protect Your Eyes" +} +``` + ```json { "@type": "https://francois.corp.adobe.com:4502/apps/foundation/image", @@ -32,13 +39,6 @@ The type determines how the component will be displayed, rendered, and authored. } ``` -```json -{ - "@type": "https://francois.corp.adobe.com:4502/apps/foundation/title", - "dc:title": "Protect Your Eyes" -} -``` - # Page Component Properties diff --git a/docs/reference/context/person-name.schema.json b/docs/reference/context/person-name.schema.json index f46e9993c..2c5f6f5ed 100644 --- a/docs/reference/context/person-name.schema.json +++ b/docs/reference/context/person-name.schema.json @@ -48,16 +48,16 @@ ], "meta:status": "experimental", "examples": [ - { - "xdm:givenName": "John", - "xdm:middleName": "S", - "xdm:surname": "Doe" - }, { "xdm:givenName": "三", "xdm:surname": "张", "xdm:name": "张三" }, + { + "xdm:givenName": "John", + "xdm:middleName": "S", + "xdm:surname": "Doe" + }, { "xdm:givenName": "فلانة", "xdm:surname": "الفلانية", diff --git a/docs/reference/context/person-name.schema.md b/docs/reference/context/person-name.schema.md index 43a1dba41..bd3b92d6d 100644 --- a/docs/reference/context/person-name.schema.md +++ b/docs/reference/context/person-name.schema.md @@ -15,17 +15,17 @@ Full name of a person ```json { - "xdm:givenName": "John", - "xdm:middleName": "S", - "xdm:surname": "Doe" + "xdm:givenName": "三", + "xdm:surname": "张", + "xdm:name": "张三" } ``` ```json { - "xdm:givenName": "三", - "xdm:surname": "张", - "xdm:name": "张三" + "xdm:givenName": "John", + "xdm:middleName": "S", + "xdm:surname": "Doe" } ``` diff --git a/docs/reference/external/hal/hal.schema.json b/docs/reference/external/hal/hal.schema.json index 4447ee469..325140cda 100644 --- a/docs/reference/external/hal/hal.schema.json +++ b/docs/reference/external/hal/hal.schema.json @@ -280,6 +280,46 @@ ], "meta:status": "experimental", "examples": [ + { + "_links": { + "self": { + "href": "/orders/523" + }, + "warehouses": [ + { + "href": "/warehouse/56" + }, + { + "href": "/warehouse/56" + }, + { + "href": "/warehouse/56" + } + ], + "invoice": { + "href": "/invoices/873" + } + }, + "currency": "USD", + "status": "shipped", + "total": 10.2 + }, + { + "_links": { + "self": { + "href": "/orders/523" + }, + "warehouse": { + "href": "/warehouse/56" + }, + "invoice": { + "href": "/invoices/873" + } + }, + "currency": "USD", + "status": "shipped", + "total": 10.2 + }, { "_links": { "self": { @@ -324,46 +364,6 @@ "currency": "USD", "status": "shipped", "total": 10.2 - }, - { - "_links": { - "self": { - "href": "/orders/523" - }, - "warehouses": [ - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - } - ], - "invoice": { - "href": "/invoices/873" - } - }, - "currency": "USD", - "status": "shipped", - "total": 10.2 - }, - { - "_links": { - "self": { - "href": "/orders/523" - }, - "warehouse": { - "href": "/warehouse/56" - }, - "invoice": { - "href": "/invoices/873" - } - }, - "currency": "USD", - "status": "shipped", - "total": 10.2 } ] } \ No newline at end of file diff --git a/docs/reference/external/hal/hal.schema.md b/docs/reference/external/hal/hal.schema.md index 9fa47c367..e05ebc55f 100644 --- a/docs/reference/external/hal/hal.schema.md +++ b/docs/reference/external/hal/hal.schema.md @@ -26,42 +26,21 @@ This external schema definition allows adding HAL expressions into an existing s "self": { "href": "/orders/523" }, - "replacing": [ + "warehouses": [ { - "href": "/orders/521" + "href": "/warehouse/56" }, { - "href": "/orders/520" + "href": "/warehouse/56" + }, + { + "href": "/warehouse/56" } ], "invoice": { "href": "/invoices/873" } }, - "_embedded": { - "replacing": [ - { - "_links": { - "self": { - "href": "/orders/521" - } - }, - "currency": "USD", - "status": "open", - "total": 10.2 - }, - { - "_links": { - "self": { - "href": "/orders/521" - } - }, - "currency": "EUR", - "status": "open", - "total": 10.2 - } - ] - }, "currency": "USD", "status": "shipped", "total": 10.2 @@ -74,17 +53,9 @@ This external schema definition allows adding HAL expressions into an existing s "self": { "href": "/orders/523" }, - "warehouses": [ - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - }, - { - "href": "/warehouse/56" - } - ], + "warehouse": { + "href": "/warehouse/56" + }, "invoice": { "href": "/invoices/873" } @@ -101,13 +72,42 @@ This external schema definition allows adding HAL expressions into an existing s "self": { "href": "/orders/523" }, - "warehouse": { - "href": "/warehouse/56" - }, + "replacing": [ + { + "href": "/orders/521" + }, + { + "href": "/orders/520" + } + ], "invoice": { "href": "/invoices/873" } }, + "_embedded": { + "replacing": [ + { + "_links": { + "self": { + "href": "/orders/521" + } + }, + "currency": "USD", + "status": "open", + "total": 10.2 + }, + { + "_links": { + "self": { + "href": "/orders/521" + } + }, + "currency": "EUR", + "status": "open", + "total": 10.2 + } + ] + }, "currency": "USD", "status": "shipped", "total": 10.2 diff --git a/docs/reference/external/repo/directory.schema.json b/docs/reference/external/repo/directory.schema.json index 30816b753..a7360b6fc 100644 --- a/docs/reference/external/repo/directory.schema.json +++ b/docs/reference/external/repo/directory.schema.json @@ -77,12 +77,6 @@ "templated": true } }, - "_page": { - "orderBy": "id", - "start": "123", - "next": "789", - "count": 100 - }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/", @@ -102,6 +96,12 @@ "templated": true } }, + "_page": { + "orderBy": "id", + "start": "123", + "next": "789", + "count": 100 + }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/", diff --git a/docs/reference/external/repo/directory.schema.md b/docs/reference/external/repo/directory.schema.md index d53ea01a1..0a3792736 100644 --- a/docs/reference/external/repo/directory.schema.md +++ b/docs/reference/external/repo/directory.schema.md @@ -32,12 +32,6 @@ A directory in Adobe Cloud Platform. "templated": true } }, - "_page": { - "orderBy": "id", - "start": "123", - "next": "789", - "count": 100 - }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/", @@ -60,6 +54,12 @@ A directory in Adobe Cloud Platform. "templated": true } }, + "_page": { + "orderBy": "id", + "start": "123", + "next": "789", + "count": 100 + }, "repo:createdDate": "2017-09-26T15:52:25+00:00", "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00", "repo:path": "/",