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 7, 2018
1 parent f79deb5 commit 749de0b
Show file tree
Hide file tree
Showing 20 changed files with 541 additions and 168 deletions.
12 changes: 7 additions & 5 deletions STABILIZING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Stabilization Candidates

_Generated on **Mon May 07 2018 22:05:16 GMT+0000 (UTC)**_
_Generated on **Mon May 07 2018 23:38:10 GMT+0000 (UTC)**_


### Unknown Status, needs immediate attention

|Schema|Status|Status Modified Date|Last Non-trivial Change|Raw Commit Log Since Status Change|
|------|------|--------------------|-----------------------|----------------------------------|
|[schemas/common/descriptors/itemselector](schemas/common/descriptors/itemselector.schema.json)|undefined|0|0|[](https://github.com/adobe/xdm/commit/ "Merge pull request #288 from adobe/platform-pr-schema-descriptors-basic")|
|[schemas/common/descriptors/schemadescriptor](schemas/common/descriptors/schemadescriptor.schema.json)|undefined|0|0|[](https://github.com/adobe/xdm/commit/ "Merge pull request #288 from adobe/platform-pr-schema-descriptors-basic")|


### Experimental Status
Expand Down Expand Up @@ -58,7 +60,7 @@ _Generated on **Mon May 07 2018 22:05:16 GMT+0000 (UTC)**_
|[schemas/common/identity-provider](schemas/common/identity-provider.schema.json)|experimental|**56**|**56**|[9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
|[schemas/common/page](schemas/common/page.schema.json)|experimental|**56**|**56**|[9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
|[schemas/common/principal](schemas/common/principal.schema.json)|experimental|**56**|**56**|[9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
|[schemas/common/selfservice](schemas/common/selfservice.schema.json)|experimental|**56**|**41**|[4d36de1](https://github.com/adobe/xdm/commit/4d36de106f4882f363e678ce46a71de32d5e1729 "Update 'xdm/selfservice' to 'xdm/common/selfservice'") [9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
|[schemas/common/selfservice](schemas/common/selfservice.schema.json)|experimental|**56**|**42**|[4d36de1](https://github.com/adobe/xdm/commit/4d36de106f4882f363e678ce46a71de32d5e1729 "Update 'xdm/selfservice' to 'xdm/common/selfservice'") [9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
|[schemas/content/component-container](schemas/content/component-container.schema.json)|experimental|**56**|**56**|[9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
|[schemas/content/componentized-page](schemas/content/componentized-page.schema.json)|experimental|**56**|**56**|[9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
|[schemas/content/content](schemas/content/content.schema.json)|experimental|**56**|**56**|[9943569](https://github.com/adobe/xdm/commit/9943569c72d108fc9daa712baa865d3a667e20b1 "Add updated schemas from lint") [db1e50b](https://github.com/adobe/xdm/commit/db1e50b0f2b520433afb2644900ddab3794511b0 "Add convenience script for mass-updating schemas")|
Expand Down Expand Up @@ -148,12 +150,12 @@ _Generated on **Mon May 07 2018 22:05:16 GMT+0000 (UTC)**_
|[schemas/context/browserdetails](schemas/context/browserdetails.schema.json)|stabilizing|**31**|**31**|[f8d9f8b](https://github.com/adobe/xdm/commit/f8d9f8bd41176d7ca388b1d2f97d38de40cfff6b "Update browserdetails.schema.json")|
|[schemas/context/commerce](schemas/context/commerce.schema.json)|stabilizing|**31**|**31**|[a424944](https://github.com/adobe/xdm/commit/a4249449cf8268d2dd357d462181e12e08dff25d "Update commerce.schema.json")|
|[schemas/context/device](schemas/context/device.schema.json)|stabilizing|**31**|18|[7ac8281](https://github.com/adobe/xdm/commit/7ac8281cc6f7ceae8a29bfe98e7b14b60091e422 "Merge branch 'master' into campaign-extensions-experienceEvent") [a7400fd](https://github.com/adobe/xdm/commit/a7400fd6a8732da1b275718f0acfa930e1e27342 "[trivial] fixes suggested in review. Iteration #4.") [6c98f3c](https://github.com/adobe/xdm/commit/6c98f3c6eb6148d0ca0f6930873047025a7272df "Update device.schema.json") [ac9024e](https://github.com/adobe/xdm/commit/ac9024eecd7741a624115f1089b457a818ac9e5c "Fix Issue #206 Adding Campaign's extension of Experience Events.")|
|[schemas/context/emailaddress](schemas/context/emailaddress.schema.json)|stabilizing|**31**|24|[6ad49e7](https://github.com/adobe/xdm/commit/6ad49e781d68809943e832e6c960490ca48847a3 "Update emailaddress.schema.json") [cfcfd58](https://github.com/adobe/xdm/commit/cfcfd589f0fadf7ad62580d273e279a016b52918 "Update emailaddress.schema.json")|
|[schemas/context/emailaddress](schemas/context/emailaddress.schema.json)|stabilizing|**31**|25|[6ad49e7](https://github.com/adobe/xdm/commit/6ad49e781d68809943e832e6c960490ca48847a3 "Update emailaddress.schema.json") [cfcfd58](https://github.com/adobe/xdm/commit/cfcfd589f0fadf7ad62580d273e279a016b52918 "Update emailaddress.schema.json")|
|[schemas/context/enduserids](schemas/context/enduserids.schema.json)|stabilizing|**31**|27|[cd0c125](https://github.com/adobe/xdm/commit/cd0c125870abb52075755837d9fd2ba38c4291f9 "Merge branch 'master' into platform-pr-stabilizing-09") [c231497](https://github.com/adobe/xdm/commit/c23149762f50b30683200aa961446133d8acee48 "Update enduserids.schema.json") [11d47c5](https://github.com/adobe/xdm/commit/11d47c500fe9903e29e1878719aea79a3163d658 "Update enduserids.schema.json")|
|[schemas/context/environment](schemas/context/environment.schema.json)|stabilizing|**31**|28|[9da39d2](https://github.com/adobe/xdm/commit/9da39d2de8cdf95d6cfb240aad0187a4e9db40dc "Merge branch 'master' into platform-pr-stabilizing-09") [7270577](https://github.com/adobe/xdm/commit/7270577990ed846a0354bb062c886cdaba80cf21 "[trivial] typo") [d47644d](https://github.com/adobe/xdm/commit/d47644dde8a38c5c4fcb8ea5739aac3d37794908 "Update environment.schema.json")|
|[schemas/context/experienceevent](schemas/context/experienceevent.schema.json)|stabilizing|24|24|[cf7779a](https://github.com/adobe/xdm/commit/cf7779ab93002d44b56d90231d667552931f0b4e "Update experienceevent.schema.json")|
|[schemas/context/experienceevent](schemas/context/experienceevent.schema.json)|stabilizing|25|25|[cf7779a](https://github.com/adobe/xdm/commit/cf7779ab93002d44b56d90231d667552931f0b4e "Update experienceevent.schema.json")|
|[schemas/context/marketing](schemas/context/marketing.schema.json)|stabilizing|**31**|**31**|[266fca9](https://github.com/adobe/xdm/commit/266fca90001ac9a4505c5c5888e8ee67c8be45f1 "Update marketing.schema.json")|
|[schemas/context/phonenumber](schemas/context/phonenumber.schema.json)|stabilizing|**31**|24|[d763dde](https://github.com/adobe/xdm/commit/d763dde9dc6bc27e4cf4224b057b809d66927425 "Update phonenumber.schema.json") [acb4818](https://github.com/adobe/xdm/commit/acb4818e53f908d5133f32d471e3b28f1dd177a1 "Update phonenumber.schema.json")|
|[schemas/context/phonenumber](schemas/context/phonenumber.schema.json)|stabilizing|**31**|25|[d763dde](https://github.com/adobe/xdm/commit/d763dde9dc6bc27e4cf4224b057b809d66927425 "Update phonenumber.schema.json") [acb4818](https://github.com/adobe/xdm/commit/acb4818e53f908d5133f32d471e3b28f1dd177a1 "Update phonenumber.schema.json")|
|[schemas/context/pushnotificationtoken](schemas/context/pushnotificationtoken.schema.json)|stabilizing|**31**|**31**|[a594370](https://github.com/adobe/xdm/commit/a5943702e3b32427dcdd0bf3d0ac7dec0aa46cd9 "Update pushnotificationtoken.schema.json")|
|[schemas/data/measure](schemas/data/measure.schema.json)|stabilizing|**31**|**31**|[3d5ce83](https://github.com/adobe/xdm/commit/3d5ce83ae130e083fe721590fa6187aabff5171e "Update measure.schema.json")|

Expand Down
71 changes: 38 additions & 33 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,6 @@
* [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)
* [Audit Trail](./common/auditable.schema.md)`https://ns.adobe.com/xdm/common/auditable` (Experimental)
* [Customer Managed Environment](./common/selfservice.schema.md)`https://ns.adobe.com/xdm/common/selfservice` (Experimental)
* [EventEnvelope](./common/eventenvelope.schema.md)`https://ns.adobe.com/xdm/common/eventenvelope` (Experimental)
* [Extensibility base schema](./common/extensible.schema.md)`https://ns.adobe.com/xdm/common/extensible` (Stabilizing)
* [Geo](./common/geo.schema.md)`https://ns.adobe.com/xdm/common/geo` (Experimental)
* [Identity Provider](./common/identity-provider.schema.md)`https://ns.adobe.com/xdm/common/identity-provider` (Experimental)
* [Organization](./common/organization.schema.md)`https://ns.adobe.com/xdm/common/organization` (Stabilizing)
* [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)

## /channels/

* [ADM](./channels/adm.schema.md)`https://ns.adobe.com/xdm/channels/adm` (Experimental)
Expand All @@ -66,6 +43,29 @@
* [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)

## /common/

* [Address](./common/address.schema.md)`https://ns.adobe.com/xdm/common/address` (Stabilizing)
* [Audit Trail](./common/auditable.schema.md)`https://ns.adobe.com/xdm/common/auditable` (Experimental)
* [Customer Managed Environment](./common/selfservice.schema.md)`https://ns.adobe.com/xdm/common/selfservice` (Experimental)
* [EventEnvelope](./common/eventenvelope.schema.md)`https://ns.adobe.com/xdm/common/eventenvelope` (Experimental)
* [Extensibility base schema](./common/extensible.schema.md)`https://ns.adobe.com/xdm/common/extensible` (Stabilizing)
* [Geo](./common/geo.schema.md)`https://ns.adobe.com/xdm/common/geo` (Experimental)
* [Identity Provider](./common/identity-provider.schema.md)`https://ns.adobe.com/xdm/common/identity-provider` (Experimental)
* [Organization](./common/organization.schema.md)`https://ns.adobe.com/xdm/common/organization` (Stabilizing)
* [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)

## /context/

* [Browser Details](./context/browserdetails.schema.md)`https://ns.adobe.com/xdm/context/browserdetails` (Stabilizing)
Expand Down Expand Up @@ -132,6 +132,11 @@
* [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)
* [Schema Descriptor](./common/descriptors/schemadescriptor.schema.md)`https://ns.adobe.com/xdm/common/desciptors/schemadescriptor` (Unknown)

## /common/event/

* [Created Event](./common/event/created.schema.md)`https://ns.adobe.com/xdm/common/event/created` (Experimental)
Expand All @@ -142,6 +147,16 @@
* [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)

## /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)
Expand All @@ -167,13 +182,3 @@
* [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)

92 changes: 92 additions & 0 deletions docs/reference/common/descriptors/itemselector.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
{
"meta:license": [
"Copyright 2018 Adobe Systems Incorporated. All rights reserved.",
"This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
"you may not use this file except in compliance with the License. You may obtain a copy",
"of the License at https://creativecommons.org/licenses/by/4.0/"
],
"$id": "https://ns.adobe.com/xdm/common/descriptors/itemselector",
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Item Selector",
"meta:extensible": false,
"meta:abstract": false,
"type": "object",
"description": "Describes how to select or match to a specific item from an array of values described by an XDM schema.\n\nMatching may be done based on array index, `@id`, `@type`, or schema URI.\n",
"definitions": {
"selector": {
"oneOf": [
{
"properties": {
"xdm:index": {
"title": "Index",
"type": "integer",
"description": "When present, indicates the item at this array index should be selected.",
"minimum": 0
}
},
"required": [
"xdm:index"
]
},
{
"properties": {
"xdm:id": {
"title": "ID",
"type": "string",
"format": "uri",
"description": "When present, indicates the item with this @id value should be selected."
}
},
"required": [
"xdm:id"
]
},
{
"properties": {
"xdm:type": {
"title": "Type",
"type": "string",
"format": "uri",
"description": "When present, indicates the item with this @type value should be selected."
}
},
"required": [
"xdm:type"
]
},
{
"properties": {
"xdm:schema": {
"title": "Schema",
"type": "string",
"format": "uri",
"description": "When present, indicates the item which conforms to this schema URI should be selected."
}
},
"required": [
"xdm:schema"
]
}
]
}
},
"allOf": [
{
"$ref": "#/definitions/selector"
}
],
"examples": [
{
"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"
}
]
}
Loading

0 comments on commit 749de0b

Please sign in to comment.