From 3d94db36d2d109f6fe3ba278f9d398c6b960d308 Mon Sep 17 00:00:00 2001 From: Lars Trieloff Date: Tue, 18 Dec 2018 14:18:57 +0000 Subject: [PATCH] Updated prettier version comes with new formatting rules --- CHANGELOG.md | 200 ++++----- CONTRIBUTING.md | 106 ++--- README.md | 72 ++-- RELEASING.md | 40 +- docs/data_types.md | 6 +- docs/descriptors.md | 3 +- docs/introduction.md | 26 +- docs/status.md | 8 +- .../adcloudremarketingprofile.example.1.json | 12 +- .../adcloudremarketingprofile.schema.json | 6 +- .../adcloud/advertisement.schema.json | 12 +- .../experience/adcloud/campaign.schema.json | 24 +- .../adcloud/experienceevent.schema.json | 3 +- .../adcloud/inventory.example.1.json | 3 +- .../experience/adcloud/inventory.schema.json | 18 +- .../adcloud/partnerdata.schema.json | 6 +- .../experience/adcloud/segment.example.1.json | 3 +- .../experience/adcloud/segment.schema.json | 9 +- .../syncedremarketingaudience.schema.json | 9 +- .../analytics/experienceevent.schema.json | 264 ++++-------- .../experience/campaign/address.schema.json | 3 +- .../experienceevent.example.click.json | 6 +- .../experienceevent.example.open-push.json | 3 +- .../campaign/experienceevent.schema.json | 165 +++----- .../campaign/journeyaifatigue.schema.json | 3 +- .../campaign/journeyaiscores.schema.json | 6 +- .../campaign/mutationevent.schema.json | 42 +- .../notificationsubscription.schema.json | 18 +- ...notificationsubscriptiontarget.schema.json | 9 +- ...ificationunsubscriptiondetails.schema.json | 15 +- .../experience/campaign/profile.schema.json | 12 +- .../experience/experienceevent.schema.json | 3 +- .../experience/implementations.schema.json | 9 +- .../capping-constraint.schema.json | 9 +- .../eligibility-rule.example.1.json | 3 +- .../eligibility-rule.schema.json | 24 +- .../fallback-offer.schema.json | 6 +- .../offer-management/model-usage.schema.json | 12 +- .../offer-activity.schema.json | 18 +- .../offer-management/offer-filter.schema.json | 15 +- .../offer-placement.schema.json | 27 +- .../offer-representation.example.1.json | 27 +- .../offer-representation.example.2.json | 6 +- .../offer-representation.example.3.json | 6 +- .../offer-representation.schema.json | 45 +- .../offer-management/offer.example.1.json | 3 +- .../offer-management/offer.schema.json | 27 +- .../personalized-offer.example.1.json | 3 +- .../personalized-offer.schema.json | 21 +- .../primary-key.descriptors.json | 30 +- .../offer-management/rank.schema.json | 3 +- .../relationship.descriptors.json | 57 +-- .../selection-constraint.schema.json | 15 +- .../offer-management/tag.schema.json | 9 +- .../profile/experienceevent.schema.json | 6 +- .../experience/target/activity.schema.json | 12 +- .../target/experienceevent.example.1.json | 9 +- .../target/experienceevent.schema.json | 6 +- meta.schema.json | 27 +- package.json | 21 +- .../descriptors/itemselector.schema.json | 15 +- .../relationshipdescriptor.description.md | 8 +- .../relationshipdescriptor.schema.json | 15 +- .../descriptors/schemadescriptor.schema.json | 18 +- schemas/common/event/created.example.1.json | 3 +- schemas/common/event/created.schema.json | 3 +- schemas/common/event/deleted.example.1.json | 3 +- schemas/common/event/deleted.schema.json | 3 +- schemas/common/event/emitted.example.1.json | 12 +- schemas/common/event/emitted.schema.json | 3 +- schemas/common/event/published.example.1.json | 3 +- schemas/common/event/published.schema.json | 3 +- schemas/common/event/rejected.example.1.json | 9 +- .../common/event/unpublished.example.1.json | 3 +- schemas/common/event/unpublished.schema.json | 3 +- schemas/common/event/updated.example.1.json | 3 +- schemas/common/event/updated.schema.json | 3 +- .../encryption.schema.json | 6 +- .../repository-policies/quota.schema.json | 12 +- .../versioning.schema.json | 6 +- .../activity.example.1.json | 9 +- .../activity-streams-2/activity.schema.json | 21 +- .../collection-page.schema.json | 18 +- .../activity-streams-2/collection.schema.json | 24 +- .../activity-streams-2/context.schema.json | 9 +- .../activity-streams-2/document.schema.json | 3 +- .../activity-streams-2/id.schema.json | 3 +- .../activity-streams-2/image.schema.json | 3 +- .../activity-streams-2/link.schema.json | 36 +- .../activity-streams-2/object.schema.json | 96 ++--- .../rdf-langstring.example.1.json | 3 +- .../rdf-langstring.schema.json | 9 +- .../activity-streams-2/type.schema.json | 3 +- schemas/external/hal/hal-link.schema.json | 39 +- schemas/external/hal/hal.schema.json | 390 ++++++------------ schemas/external/iptc/creator.schema.json | 3 +- schemas/external/iptc/episode.schema.json | 3 +- schemas/external/iptc/rating.schema.json | 6 +- schemas/external/iptc/season.schema.json | 3 +- schemas/external/iptc/series.schema.json | 3 +- .../repo/accesscontrolentry.schema.json | 24 +- .../repo/accesscontrolpolicy.schema.json | 3 +- schemas/external/repo/asset.schema.json | 21 +- schemas/external/repo/common.schema.json | 9 +- schemas/external/repo/directory.schema.json | 9 +- .../external/repo/sub-directory.schema.json | 3 +- schemas/external/schema/geocircle.schema.json | 6 +- .../schema/geocoordinates.schema.json | 9 +- schemas/external/schema/geoshape.schema.json | 18 +- 109 files changed, 908 insertions(+), 1583 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0d99eada6..cd95347d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,13 +6,13 @@ Fixed Issues -* Add Human Friendly Delivery Template Name in ExperienceEvents - * PR #559 Add templateName to experienceevent campaign extension. +- Add Human Friendly Delivery Template Name in ExperienceEvents + - PR #559 Add templateName to experienceevent campaign extension. Merged Pull Requests -* #523 Unify representation of end-user identity between ExperienceEvent and Profile -* #552 Added dcx JSON-LD prefix definition & dcx:type property to the meta schema +- #523 Unify representation of end-user identity between ExperienceEvent and Profile +- #552 Added dcx JSON-LD prefix definition & dcx:type property to the meta schema ## Release 0.9.7 @@ -20,18 +20,18 @@ Merged Pull Requests Fixed Issues -* Implement a communications subscription Campaign extension - * PR #458 Implement a communications subscription Campaign extension -* Add domain and ISP to environment - * PR #537 Add domain and ISP -* Advertising break should not be required - * PR #539 Remove the requirement for offset in advertising break -* Add xdm:localTimezoneOffset next to xdm:localTime under placecontext - * PR #554 Added xdm:localTimezoneOffset to context/placecontext #544 +- Implement a communications subscription Campaign extension + - PR #458 Implement a communications subscription Campaign extension +- Add domain and ISP to environment + - PR #537 Add domain and ISP +- Advertising break should not be required + - PR #539 Remove the requirement for offset in advertising break +- Add xdm:localTimezoneOffset next to xdm:localTime under placecontext + - PR #554 Added xdm:localTimezoneOffset to context/placecontext #544 Merged Pull Requests -* #532 Add producer event source to message/event on pipeline +- #532 Add producer event source to message/event on pipeline ## Release 0.9.6 @@ -39,28 +39,28 @@ Merged Pull Requests Fixed Issues -* XDM schema definition for AdCloud Search surfer profiles in AdCloud extension - * PR #477 XDM schema definition for AdCloud Search surfer profiles -* Fix lint checks against extensions - * PR #485 Fix lint checks against extensions -* Define Logical Data Types for XDM - * PR #495 First draft of data type description -* Add the Supplemental Data Identifier field to the Adobe Target extension - * PR #509 Add the Supplemental Data Identifier field to the Adobe Target extension -* Define a Map Data Type for XDM - * PR #511 Define "map" XDM type -* XDM requires many ID's under experience event schema to be length > 20 ... - * PR #524 Removing minLength constraint on measure ids +- XDM schema definition for AdCloud Search surfer profiles in AdCloud extension + - PR #477 XDM schema definition for AdCloud Search surfer profiles +- Fix lint checks against extensions + - PR #485 Fix lint checks against extensions +- Define Logical Data Types for XDM + - PR #495 First draft of data type description +- Add the Supplemental Data Identifier field to the Adobe Target extension + - PR #509 Add the Supplemental Data Identifier field to the Adobe Target extension +- Define a Map Data Type for XDM + - PR #511 Define "map" XDM type +- XDM requires many ID's under experience event schema to be length > 20 ... + - PR #524 Removing minLength constraint on measure ids Merged Pull Requests -* #467 Fixed typo in transactionID -* #492 Journey AI Fatigue and Score schemas -* #504 Correct profile stitching -* #505 Added "eventID" depreciated "businessReason" in Campaign ExperienceEvent extension. -* #506 Updating titles so that they no longer collide -* #513 PR 504 - Updates to make changes additive -* #515 improve name for email fatigue scores in experience event +- #467 Fixed typo in transactionID +- #492 Journey AI Fatigue and Score schemas +- #504 Correct profile stitching +- #505 Added "eventID" depreciated "businessReason" in Campaign ExperienceEvent extension. +- #506 Updating titles so that they no longer collide +- #513 PR 504 - Updates to make changes additive +- #515 improve name for email fatigue scores in experience event ## Release 0.9.5 @@ -68,18 +68,18 @@ Merged Pull Requests Fixed Issues -* Change ID format from "uri" to "uri-reference" - * PR #488 Change @id's format from "uri" to "uri-reference" if exists -* Combine individual Birthday fields to a single field of format: 'date-time' - * PR #498 Create distinct fields for different cases of birth date -* Fix lint checks against extensions - * PR #485 fix linting issues in extensions folder +- Change ID format from "uri" to "uri-reference" + - PR #488 Change @id's format from "uri" to "uri-reference" if exists +- Combine individual Birthday fields to a single field of format: 'date-time' + - PR #498 Create distinct fields for different cases of birth date +- Fix lint checks against extensions + - PR #485 fix linting issues in extensions folder Merged Pull Requests -* #472 Add Journey context and delivery attributes in experience event -* #479 Fix Segment Identity title conflict -* #501 Campaign extension schema format/structure change for 0.9.9.5 platform release +- #472 Add Journey context and delivery attributes in experience event +- #479 Fix Segment Identity title conflict +- #501 Campaign extension schema format/structure change for 0.9.9.5 platform release ## Release 0.9.4 @@ -87,17 +87,17 @@ Merged Pull Requests Fixed Issues -* Need representation for stitched profiles and segment membership in ExperienceEvent - * PR #444 profile stitch +- Need representation for stitched profiles and segment membership in ExperienceEvent + - PR #444 profile stitch Merged Pull Requests -* #411 Payload value types -* #445 Change repo:assetID to repo:id -* #456 Adding Target Activities elements -* #459 Added Authenticated State property to `\context\identity.schema.json` -* #474 Minor refactor of segment membership schemas to be more tool friendly -* #475 Make experience schemas xed convertable for 0.9.9.4 release +- #411 Payload value types +- #445 Change repo:assetID to repo:id +- #456 Adding Target Activities elements +- #459 Added Authenticated State property to `\context\identity.schema.json` +- #474 Minor refactor of segment membership schemas to be more tool friendly +- #475 Make experience schemas xed convertable for 0.9.9.4 release ## Release 0.9.3 @@ -105,72 +105,72 @@ Merged Pull Requests Fixed Issues -* #364 Video Analytics additions for ExperienceEvent - * PR #417 Added Timed Media schemas to `Experience Event` based schemas PR -* #409 Fix campaign extension bugs - * PR #410 Issue409-Fix campaign extension bugs -* #413 WebPageDetails.server shouldn't be constrained to a hostname - * PR #414 Removed hostname format constraint from context/webpagedetails.xdm:server -* #419 Change Identity schema identifier to unstructured string from URI - * PR #420 Change `Identity` Schema `@id` property renamed to `xdm:id` -* #425 Added datasourceID to the ExperienceCloud Extension for Experience Event. - * PR #426 add dataset id as part of event +- #364 Video Analytics additions for ExperienceEvent + - PR #417 Added Timed Media schemas to `Experience Event` based schemas PR +- #409 Fix campaign extension bugs + - PR #410 Issue409-Fix campaign extension bugs +- #413 WebPageDetails.server shouldn't be constrained to a hostname + - PR #414 Removed hostname format constraint from context/webpagedetails.xdm:server +- #419 Change Identity schema identifier to unstructured string from URI + - PR #420 Change `Identity` Schema `@id` property renamed to `xdm:id` +- #425 Added datasourceID to the ExperienceCloud Extension for Experience Event. + - PR #426 add dataset id as part of event Merged Pull Requests -* #391 πŸ“ Clarify CLA section of contribution guidelines. -* #416 Remove definition of xmp:numberOfPixels -* #423 Add post office box to align with Microsoft CDM -* #431 Create RELEASING.md file -* #436 Update Changelog preparing for V0.9.3 release -* #437 Fixing RELEASING.md +- #391 πŸ“ Clarify CLA section of contribution guidelines. +- #416 Remove definition of xmp:numberOfPixels +- #423 Add post office box to align with Microsoft CDM +- #431 Create RELEASING.md file +- #436 Update Changelog preparing for V0.9.3 release +- #437 Fixing RELEASING.md ## Release 0.9.2 [Released on June 15, 2018](https://github.com/adobe/xdm/releases/tag/v0.9.2) -* `xdm:dataSource` in `ExperienceEvent` is no longer required #363 -* Changed and added new concepts `Organizational Unit` and `Geographical Unit`. Existing links with the `Profile` schema updated. In `Profile`, `xdm:orgUnitID` is now `xdm:orgUnit`, and a simple reference to the `Organizational Unit` schema. #323 -* Added Phone Number and Email Address to EndUserIDs. #381 -* Changed Adobe Analytics Extension - Alter analytics custom lists to allow keys #376 -* Added `"meta:extends": true` to the schemas that can be extended in `context` #332 -* Changed extension `extensions/adobe/experience/implementations.schema.json` properties to include the name `implementation` #403 -* Added Reporting Events to Experience Event in the Campaign Extension #307 -* Improved the representation of Extensibility to `context\*` schemas #332 -* Changed a circular reference introduces in the Campaign Extension to Experience Event #377 / #378 -* Added Segment Membership and related schemas for `context\profile.schema.json` #380 -* Added searchEngineID field to search schema to Experience Event #394 -* Added the created/modified dates from auditable for `context\profile.schema.json`, address and person schemas #393 -* Adding relationship descriptor #388 +- `xdm:dataSource` in `ExperienceEvent` is no longer required #363 +- Changed and added new concepts `Organizational Unit` and `Geographical Unit`. Existing links with the `Profile` schema updated. In `Profile`, `xdm:orgUnitID` is now `xdm:orgUnit`, and a simple reference to the `Organizational Unit` schema. #323 +- Added Phone Number and Email Address to EndUserIDs. #381 +- Changed Adobe Analytics Extension - Alter analytics custom lists to allow keys #376 +- Added `"meta:extends": true` to the schemas that can be extended in `context` #332 +- Changed extension `extensions/adobe/experience/implementations.schema.json` properties to include the name `implementation` #403 +- Added Reporting Events to Experience Event in the Campaign Extension #307 +- Improved the representation of Extensibility to `context\*` schemas #332 +- Changed a circular reference introduces in the Campaign Extension to Experience Event #377 / #378 +- Added Segment Membership and related schemas for `context\profile.schema.json` #380 +- Added searchEngineID field to search schema to Experience Event #394 +- Added the created/modified dates from auditable for `context\profile.schema.json`, address and person schemas #393 +- Adding relationship descriptor #388 ## Release 0.9.1 [Released on May 23, 2018](https://github.com/adobe/xdm/releases/tag/v0.9.1) -* Introduced Point of Interest details and metrics. #285 -* Renamed all `Metric` schemas to `Metric Definition` #254 -* Moved web metrics used in ExperienceEvent `metrics` to the webinteraction and webpageview contexts #316 -* Renamed web metrics to `xdm:*` compressed type property names #316 -* Moved `commerce` metrics used in ExperienceEvent `metrics` to the `commerce` context #317 -* Renamed `commerce` metrics to `xdm:*` compressed type property names #317 -* `abandons` metric field name change to `cartAbandons` . #317 -* The `commerce` schema is now extensible to allow for additional dimensions and metrics. #317 -* Removed the required constraint from `schemas/external/schema/geo*.schema.json` #315 -* Moved `direct-marketing` metrics used in ExperienceEvent `metrics` to a new `xdm:directMarketing` contexts #331 -* Introduced advertising context to ExperienceEvent #280 -* Introduced advertising and viewability metrics under the advertising context #280 -* Moved impressions and clicks metrics under advertising context #280 -* Added `xdm:primary` flag to `schemas/context/identity.schema.json` #335 -* Corrected naming of EndUserIDs by making them consistent (aaid and acid) `schemas/external/schema/geo*.schema.json` #333 -* Renamed `webPageView` to `webPageDetails` e.g `context/webpagedetail.schema.json` #336 -* Added application and mobile context via `context\application.schema.json` #318 -* Fixed issue where `context\experienceevent` `xdm:application` referred to the 'application.schema.json' in `channels` #318 -* `xdm:application` in `context\experienceevent` `@id` renamed to `xdm:id` #318 -* Changed `xdm:channel` in `ExperienceEvent` to be a reference to `Channel` #289 -* Changed `xdm:pageDepth` data type from number to integer in `context\search.schema.json` #346 +- Introduced Point of Interest details and metrics. #285 +- Renamed all `Metric` schemas to `Metric Definition` #254 +- Moved web metrics used in ExperienceEvent `metrics` to the webinteraction and webpageview contexts #316 +- Renamed web metrics to `xdm:*` compressed type property names #316 +- Moved `commerce` metrics used in ExperienceEvent `metrics` to the `commerce` context #317 +- Renamed `commerce` metrics to `xdm:*` compressed type property names #317 +- `abandons` metric field name change to `cartAbandons` . #317 +- The `commerce` schema is now extensible to allow for additional dimensions and metrics. #317 +- Removed the required constraint from `schemas/external/schema/geo*.schema.json` #315 +- Moved `direct-marketing` metrics used in ExperienceEvent `metrics` to a new `xdm:directMarketing` contexts #331 +- Introduced advertising context to ExperienceEvent #280 +- Introduced advertising and viewability metrics under the advertising context #280 +- Moved impressions and clicks metrics under advertising context #280 +- Added `xdm:primary` flag to `schemas/context/identity.schema.json` #335 +- Corrected naming of EndUserIDs by making them consistent (aaid and acid) `schemas/external/schema/geo*.schema.json` #333 +- Renamed `webPageView` to `webPageDetails` e.g `context/webpagedetail.schema.json` #336 +- Added application and mobile context via `context\application.schema.json` #318 +- Fixed issue where `context\experienceevent` `xdm:application` referred to the 'application.schema.json' in `channels` #318 +- `xdm:application` in `context\experienceevent` `@id` renamed to `xdm:id` #318 +- Changed `xdm:channel` in `ExperienceEvent` to be a reference to `Channel` #289 +- Changed `xdm:pageDepth` data type from number to integer in `context\search.schema.json` #346 ## Release 0.9.0 [Released on April 13, 2018](https://github.com/adobe/xdm/releases/tag/v0.9) -* Release 0.9 is preview release which updates the `ExperienceEvent` schema to 'stabilizing' status, along with many of the schemas it depends on. This release is intended to get early feedback from implementers and the community before a 1.0 release. +- Release 0.9 is preview release which updates the `ExperienceEvent` schema to 'stabilizing' status, along with many of the schemas it depends on. This release is intended to get early feedback from implementers and the community before a 1.0 release. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf018b875..77eb55e1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,10 +8,10 @@ We are in the process of increasing the visibility of XDM to partners and to inv 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) -* Like everyone, follow these [Contributing](CONTRIBUTING.md) guides -* Like always, don't share credentials, API keys, or other secrets in issues or in code -* Focus on standardizing the category, not your specific product +- Like everyone, follow the [Code of Conduct](CODE_OF_CONDUCT.md) +- Like everyone, follow these [Contributing](CONTRIBUTING.md) guides +- Like always, don't share credentials, API keys, or other secrets in issues or in code +- Focus on standardizing the category, not your specific product ## Things to Keep in Mind @@ -60,14 +60,14 @@ You can include the Creative Commons Attribution 4.0 International (CC BY 4.0) l Every pull request should specify: -* What the change intends to do -* If there are breaking changes (in case there are, list them in [CHANGELOG.md](CHANGELOG.md), too) -* Link to the Github issue in the format `#42` +- What the change intends to do +- If there are breaking changes (in case there are, list them in [CHANGELOG.md](CHANGELOG.md), too) +- Link to the Github issue in the format `#42` For every update to the schema, make sure -* `npm test` validates all example files, see [README.md](README.md) -* There are `schemas/*/*.example.*.json` files for each newly created or changed 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. @@ -77,11 +77,11 @@ All changes to the adobe/xdm repository now require an associated pull request. The target consumers of the data model are developers building applications using services from Adobe, our partners, and their customers. These design guidelines help: -* **Longevity**: consuming applications rarely need to be changed. -* **Clarity**: concepts are self-explanatory. -* **Continuity**: existing knowledge can be re-applied. -* **Compatibility**: implementations can easily cross between products. -* **Consumability**: systems based on the data model are easy to build, understand, and use. +- **Longevity**: consuming applications rarely need to be changed. +- **Clarity**: concepts are self-explanatory. +- **Continuity**: existing knowledge can be re-applied. +- **Compatibility**: implementations can easily cross between products. +- **Consumability**: systems based on the data model are easy to build, understand, and use. ### Design for Longevity @@ -114,10 +114,10 @@ While there will be almost certainly multiple implementations of parts of XDM ac Additional aspects of standard design that aid with consumability are: -* principle of least astonishment: don't surprise the consumer -* avoid unnecessary complexity: don't introduce indirections that are not needed -* the principle of minimal verbosity: make keep things as short as possible, but not shorter -* avoid unnecessary polymorphism that is hard to consume, e.g. offering both singular and array notations, or introducing type variants that don't provide a common discriminator property. +- principle of least astonishment: don't surprise the consumer +- avoid unnecessary complexity: don't introduce indirections that are not needed +- the principle of minimal verbosity: make keep things as short as possible, but not shorter +- avoid unnecessary polymorphism that is hard to consume, e.g. offering both singular and array notations, or introducing type variants that don't provide a common discriminator property. ### Design for the Cloud @@ -133,34 +133,34 @@ Avoid non-semantic limits – don’t put current resource limits in the data mo ## Coding Styleguides -* file names for schema files should be lower case and end with `.schema.json` -* include an `"$id"` with a value like `"https://ns.adobe.com/xdm/assets/image"` in the schema (but leave out the `.schema.json`) -* when referencing schemas, use the absolute `$id`, don't use relative references like `../content/content.schema.json` -* don't nest schemas too deeply. Break inline type definitions into separate `*.schema.json` files if they have properties with object types themselves. -* don't make schemas too fine-grained, only create schemas for `object`s not for simple types like patterned strings -* ensure that there is a `meta:license` at the top of the schema -* use JSON Schema `draft-6` -* provide a `description` and `title` for each schema and each property -* have the `title` at the top of the schema, so that it can be found without scrolling -* make sure you have an example for every schema -* all properties must have a specific type, while JSON-Schema does allow variability in types in cases like enumerations, concrete types are required in XDM -* restrict the values of `string` properties as much as appropriate for the domain. `minLength`, `maxLength`, `pattern`, and `format` all can help with that. -* don't restrict values of `string` properties beyond the constraints of the domain, e.g. don't set a `maxLength` of 255, just because your current database uses a `VARCHAR(255)` default -* run `npm test` before you make a pull request -* convention is that property names are in camelCase, when they appear in JSON -* Acronyms and abbreviations in camelCase like ID, API, JSON are also capitalized in camelCase, such as `documentID` -* When combining two acronyms, use lowercase for the first and uppercase for the second, such as `dmaID` -* don't invent your own `ID` attributes, use the `@id` convention -* don't invent your own `type` attributes, use the `@type` convention -* when using `enum` in JSON schema, document all values using `meta:enum` -* when working with "soft enums" or "open enumerations", use `meta:enum` to document all known values +- file names for schema files should be lower case and end with `.schema.json` +- include an `"$id"` with a value like `"https://ns.adobe.com/xdm/assets/image"` in the schema (but leave out the `.schema.json`) +- when referencing schemas, use the absolute `$id`, don't use relative references like `../content/content.schema.json` +- don't nest schemas too deeply. Break inline type definitions into separate `*.schema.json` files if they have properties with object types themselves. +- don't make schemas too fine-grained, only create schemas for `object`s not for simple types like patterned strings +- ensure that there is a `meta:license` at the top of the schema +- use JSON Schema `draft-6` +- provide a `description` and `title` for each schema and each property +- have the `title` at the top of the schema, so that it can be found without scrolling +- make sure you have an example for every schema +- all properties must have a specific type, while JSON-Schema does allow variability in types in cases like enumerations, concrete types are required in XDM +- restrict the values of `string` properties as much as appropriate for the domain. `minLength`, `maxLength`, `pattern`, and `format` all can help with that. +- don't restrict values of `string` properties beyond the constraints of the domain, e.g. don't set a `maxLength` of 255, just because your current database uses a `VARCHAR(255)` default +- run `npm test` before you make a pull request +- convention is that property names are in camelCase, when they appear in JSON +- Acronyms and abbreviations in camelCase like ID, API, JSON are also capitalized in camelCase, such as `documentID` +- When combining two acronyms, use lowercase for the first and uppercase for the second, such as `dmaID` +- don't invent your own `ID` attributes, use the `@id` convention +- don't invent your own `type` attributes, use the `@type` convention +- when using `enum` in JSON schema, document all values using `meta:enum` +- when working with "soft enums" or "open enumerations", use `meta:enum` to document all known values Run `npm run lint` before committing. The `lint` command is able to fix some easy styling issues, including: -* intent: 2 spaces -* line breaks -* spaces around delimiters -* breaks long lines where possible +- intent: 2 spaces +- line breaks +- spaces around delimiters +- breaks long lines where possible `npm lint` uses [Prettier](https://prettier.io), which offers integrations for consistent formatting for many editors and IDEs. @@ -377,19 +377,19 @@ Namespaces _should not_ be used to organize or group concepts within a grammar. Each schema should contains the enum property `meta:status` that designates it's stability. The value should be one of the following enumerations: -* `stable` : No open issues and has been in `stabilizing` for 1 month without major changes -* `stabilizing` : No further major changes are expected -* `experimental` : Major changes can be expected -* `deprecated` : Schema is no longer maintained, supported or is superceded by another schema/set of schemas +- `stable` : No open issues and has been in `stabilizing` for 1 month without major changes +- `stabilizing` : No further major changes are expected +- `experimental` : Major changes can be expected +- `deprecated` : Schema is no longer maintained, supported or is superceded by another schema/set of schemas ### Other Schema Extensions XDM is using a couple of custom keywords that are not part of the JSON Schema standard. These include: -* `meta:extensible`: see above, to describe schemas that allow custom properties -* `meta:auditable`: for schemas that have created and last modified dates -* `meta:descriptors`: to annotate schemas with additional metadata (see Schema Descriptors above) -* `meta:enum`: for known values in enums, strings, and as property keys (see below) +- `meta:extensible`: see above, to describe schemas that allow custom properties +- `meta:auditable`: for schemas that have created and last modified dates +- `meta:descriptors`: to annotate schemas with additional metadata (see Schema Descriptors above) +- `meta:enum`: for known values in enums, strings, and as property keys (see below) ##### Soft and Hard Enumerations @@ -409,8 +409,8 @@ For all writing, please follow the [Adobe I/O style guide](https://www.adobe.io/ The XDM project differentiates between major and minor contributions. -* Minor contributions: contributions that do not change the meaning of the standard, such as corrections to typos, word order or formatting. Contributions to the project's `README.md` or `CONTRIBUTING.md` are also minor contributions. -* Major contributions: all other contributions. +- Minor contributions: contributions that do not change the meaning of the standard, such as corrections to typos, word order or formatting. Contributions to the project's `README.md` or `CONTRIBUTING.md` are also minor contributions. +- Major contributions: all other contributions. ### Minor Contributions diff --git a/README.md b/README.md index d88f3aed7..67b4c0f1a 100644 --- a/README.md +++ b/README.md @@ -14,35 +14,35 @@ You can find more about our versioning in [docs/introduction.md](docs/introducti ## Read the XDM Spec -* [Chapter 1: Introduction](docs/introduction.md) -* [Chapter 2: Related Standards](docs/standards.md) -* [Chapter 3: Terminology](docs/terminology.md) -* [Chapter 4: Extending XDM](docs/extensions.md) -* [Appendix A: Reference](docs/reference/README.md) – this contains all the schemas defined by XDM +- [Chapter 1: Introduction](docs/introduction.md) +- [Chapter 2: Related Standards](docs/standards.md) +- [Chapter 3: Terminology](docs/terminology.md) +- [Chapter 4: Extending XDM](docs/extensions.md) +- [Appendix A: Reference](docs/reference/README.md) – this contains all the schemas defined by XDM ## Project Layout The project is laid out in the following way: -* `docs`: Markdown files that contain front-matter, introduction, and non-normative parts of XDM -* `schemas`: JSON schema files constituting the normative part of XDM - * `*.schema.json` is the schema file, e.g. `event-envelope.schema.json` – we pick the `.json` file extension for easy syntax highlighting in editors - * `*.example.*.json` is an example file that will be validated against the `*.schema.json` file, and if successful, merged into the `*.schema.json` file as an `"example"` field at the root of the schema before it is converted into Markdown or published - * `*.invalid.*.json` is an invalid example file that will be validated against the `*.schema.json` file. If the `invalid` file validates (false positive), the schema is too lax and the overall build will fail. `invalid` files will not be merged into documentation. - * `*.description.md` is a description file that will be merged into the `"description"` field at the root of the schema, allowing the authoring of longer descriptions. The merge happens before publishing the schema file or creating a joint Markdown file - * `schemas/assets` – for schemas related to the asset core concept, including image, video, document - * `schemas/audiences` – for schemas describing audiences, segments, and groups of consumers - * `schemas/campaigns` – for schemas describing orchestrated experience campaign - * `schemas/content` – for schemas related to content, including visual, audible, and virtual reality content - * `schemas/context` – for schemas related to the context of a digital experience, including profile, person, environment - * `schemas/data` – for schemas describing collected data, metric, etc. - * `schemas/external/*` – for JSON Schema representation of externally defined standards - * `schemas/channels` – for schemas describing experience channels and locations therein - * `schemas/common` – for basic concepts like extensibility that are not covered in `external` schemas -* `*.ttl`: legacy schema files in Turtle Syntax that have not yet been converted into JSON Schema -* `package.json`: a build file for `npm` that allows the generation of Markdown from the JSON Schema source files and (later) the generation of an AEM package to be deployed on the Adobe I/O Website -* `README.md`: this file -* `CONTRIBUTING.md`: guidelines for contributors, covering process, conventions and design guidelines +- `docs`: Markdown files that contain front-matter, introduction, and non-normative parts of XDM +- `schemas`: JSON schema files constituting the normative part of XDM + - `*.schema.json` is the schema file, e.g. `event-envelope.schema.json` – we pick the `.json` file extension for easy syntax highlighting in editors + - `*.example.*.json` is an example file that will be validated against the `*.schema.json` file, and if successful, merged into the `*.schema.json` file as an `"example"` field at the root of the schema before it is converted into Markdown or published + - `*.invalid.*.json` is an invalid example file that will be validated against the `*.schema.json` file. If the `invalid` file validates (false positive), the schema is too lax and the overall build will fail. `invalid` files will not be merged into documentation. + - `*.description.md` is a description file that will be merged into the `"description"` field at the root of the schema, allowing the authoring of longer descriptions. The merge happens before publishing the schema file or creating a joint Markdown file + - `schemas/assets` – for schemas related to the asset core concept, including image, video, document + - `schemas/audiences` – for schemas describing audiences, segments, and groups of consumers + - `schemas/campaigns` – for schemas describing orchestrated experience campaign + - `schemas/content` – for schemas related to content, including visual, audible, and virtual reality content + - `schemas/context` – for schemas related to the context of a digital experience, including profile, person, environment + - `schemas/data` – for schemas describing collected data, metric, etc. + - `schemas/external/*` – for JSON Schema representation of externally defined standards + - `schemas/channels` – for schemas describing experience channels and locations therein + - `schemas/common` – for basic concepts like extensibility that are not covered in `external` schemas +- `*.ttl`: legacy schema files in Turtle Syntax that have not yet been converted into JSON Schema +- `package.json`: a build file for `npm` that allows the generation of Markdown from the JSON Schema source files and (later) the generation of an AEM package to be deployed on the Adobe I/O Website +- `README.md`: this file +- `CONTRIBUTING.md`: guidelines for contributors, covering process, conventions and design guidelines ## Tooling @@ -77,7 +77,7 @@ If you see warnings or error messages (or an non-zero exit code), fix them befor ## Naming Conventions -* see the [Contributor's guide](CONTRIBUTING.md) +- see the [Contributor's guide](CONTRIBUTING.md) ### AEM Package Generation (optional) @@ -127,16 +127,16 @@ The `package.json` script will fetch a released version of the AEM Markdown Impo ### Specifications -* [JSON Schema](http://json-schema.org/) -* [JSON-LD 1.0](https://www.w3.org/TR/json-ld/) -* [XMP SPECIFICATION PART 1 DATA MODEL, SERIALIZATION, AND CORE PROPERTIES](http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/xmp/pdfs/XMP%20SDK%20Release%20cc-2014-12/XMPSpecificationPart1.pdf) +- [JSON Schema](http://json-schema.org/) +- [JSON-LD 1.0](https://www.w3.org/TR/json-ld/) +- [XMP SPECIFICATION PART 1 DATA MODEL, SERIALIZATION, AND CORE PROPERTIES](http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/xmp/pdfs/XMP%20SDK%20Release%20cc-2014-12/XMPSpecificationPart1.pdf) ### Vocabularies/Ontologies -* [schema.org](http://schema.org) -* [Dublin Core](http://dublincore.org/) -* [OWL](http://www.w3.org/TR/2009/REC-owl2-overview-20091027/) -* [SKOS Core](http://www.w3.org/TR/2009/REC-skos-reference-20090818/) +- [schema.org](http://schema.org) +- [Dublin Core](http://dublincore.org/) +- [OWL](http://www.w3.org/TR/2009/REC-owl2-overview-20091027/) +- [SKOS Core](http://www.w3.org/TR/2009/REC-skos-reference-20090818/) ## License/Copyright @@ -145,8 +145,8 @@ This work is licensed under a [Creative Commons Attribution 4.0 International (C ### You are free to: -* Share β€” copy and redistribute the material in any medium or format -* Adapt β€” remix, transform, and build upon the material for any purpose, even commercially. +- Share β€” copy and redistribute the material in any medium or format +- Adapt β€” remix, transform, and build upon the material for any purpose, even commercially. This license is acceptable for Free Cultural Works. @@ -154,5 +154,5 @@ The licensor cannot revoke these freedoms as long as you follow the license term ### Under the following terms: -* Attribution β€” You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. -* No additional restrictions β€” You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. +- Attribution β€” You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. +- No additional restrictions β€” You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. diff --git a/RELEASING.md b/RELEASING.md index 6bb441e7d..b879340be 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -15,24 +15,24 @@ The next planned release is indicated at the bottom of the [changelog](CHANGELOG ### Steps to execute a release: -* Clone and update the `master` branch of the `adobe/xdm` repository in your local workspace -* Make sure there are no pending changes (`git status`) and all pull requests scheduled for the release are merged -* Test the schemas and fix any issues indicated: +- Clone and update the `master` branch of the `adobe/xdm` repository in your local workspace +- Make sure there are no pending changes (`git status`) and all pull requests scheduled for the release are merged +- Test the schemas and fix any issues indicated: ```sh $ npm test $ npm run lint ``` -* Define a version number to use, for example `0.9.3` -* Update the `version` property in [package.json](package.json) with the version number -* Update the current version in the [README.md](README.md) file with the version number -* Update the title in the [introduction](docs/introduction.md) with the version number -* Update the [changelog](CHANGELOG.md): - * Make sure all closed issues and merged pull requests since the last release are listed in chronological order - * Indicate the _planned release_ as _released_ with the updated actual release date and link to the release tag - * Add a new _planned release_ with expected release version and date at the top -* Update reference docs: +- Define a version number to use, for example `0.9.3` +- Update the `version` property in [package.json](package.json) with the version number +- Update the current version in the [README.md](README.md) file with the version number +- Update the title in the [introduction](docs/introduction.md) with the version number +- Update the [changelog](CHANGELOG.md): + - Make sure all closed issues and merged pull requests since the last release are listed in chronological order + - Indicate the _planned release_ as _released_ with the updated actual release date and link to the release tag + - Add a new _planned release_ with expected release version and date at the top +- Update reference docs: ```sh $ npm run clean @@ -40,11 +40,11 @@ $ npm run markdown $ git commit -m"Prepare for release $version" -a ``` -* Create the release following the instructions for [GitHub Release creation](https://help.github.com/articles/creating-releases/): - * Use the version number prefixed with (lowercase) `v`as the tag name, for example `v0.9.3` - * Make sure the `master` branch is chosen as the basis for the release - * Use the tag name from the first step for the _Release title_ as well - * Add a small comment to _Describe the release_ and copy the change log for the release from [changelog](CHANGELOG.md) - * Check the _This is a pre-release_ box - * Click _Publish Release_ -* Spread the word and party ! +- Create the release following the instructions for [GitHub Release creation](https://help.github.com/articles/creating-releases/): + - Use the version number prefixed with (lowercase) `v`as the tag name, for example `v0.9.3` + - Make sure the `master` branch is chosen as the basis for the release + - Use the tag name from the first step for the _Release title_ as well + - Add a small comment to _Describe the release_ and copy the change log for the release from [changelog](CHANGELOG.md) + - Check the _This is a pre-release_ box + - Click _Publish Release_ +- Spread the word and party ! diff --git a/docs/data_types.md b/docs/data_types.md index f848bd7bb..1c6552b16 100644 --- a/docs/data_types.md +++ b/docs/data_types.md @@ -43,9 +43,9 @@ One limitation of the equivalence of objects and maps in JSON and JSON Schema is In order to support "map-like" data efficiently in XDM, objects may be annotated with a `meta:xdmType` set to `map` to make it clear that an object should be managed as if the key set were unconstrained. XDM places the following restrictions on the use of this storage hint: -* Properties that carry the `map` type MUST be of type "object" -* Properties that carry the `map` type MUST NOT have properties defined (i.e. they define "empty" objects) -* Properties that carry the `map` type MUST include a single "additionalProperties" schema that describes the values that may be placed within the map +- Properties that carry the `map` type MUST be of type "object" +- Properties that carry the `map` type MUST NOT have properties defined (i.e. they define "empty" objects) +- Properties that carry the `map` type MUST include a single "additionalProperties" schema that describes the values that may be placed within the map ### Example Map in XDM diff --git a/docs/descriptors.md b/docs/descriptors.md index 0440b1ad0..ac669a351 100644 --- a/docs/descriptors.md +++ b/docs/descriptors.md @@ -140,8 +140,7 @@ Next, they define an extension to `SchemaDescriptor` containing the in-use flag: }, "allOf": [ { - "$ref": - "https://ns.adobe.com/xdm/common/schemadescriptor#/definitions/descriptor" + "$ref": "https://ns.adobe.com/xdm/common/schemadescriptor#/definitions/descriptor" }, { "$ref": "#/definitions/inusedescriptor" diff --git a/docs/introduction.md b/docs/introduction.md index adf7afd1b..d2c29f5a0 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -10,9 +10,9 @@ xdm:navOrder: 1 The goal of the Experience Data Model standard is to define a common language for digital experiences that spans multiple channels, software implementations and vendors. In particular, XDM aims to: -* Enable software that creates, manages, publishes and measures digital experiences to interoperate more easily -* Facilitate the creation of complex, engaging and intruiging digital experiences across channels -* Allow the creation of application programming interfaces (APIs) for experience creation, management, publication and measurement +- Enable software that creates, manages, publishes and measures digital experiences to interoperate more easily +- Facilitate the creation of complex, engaging and intruiging digital experiences across channels +- Allow the creation of application programming interfaces (APIs) for experience creation, management, publication and measurement ## Status @@ -26,10 +26,10 @@ As the nature of digital experiences evolves over time, so does the experience d Maintaining forward and backwards compatibility is an important goal of XDM. Therefore, XDM uses purely additive versioning, following the [best practices for versioning REST APIs](https://www.infoq.com/articles/roy-fielding-on-versioning), which means that any revision of the experience data model following the 1.0 release will not: -* introduce new mandatory properties -* rename existing properties -* remove previously defined properties -* remove or restrict previously supported property values +- introduce new mandatory properties +- rename existing properties +- remove previously defined properties +- remove or restrict previously supported property values As all XDM versions are mutually compatible, the version numbers indicated in the specification serve as a guide when models, properties, or values have been added to the specification. @@ -37,15 +37,15 @@ As all XDM versions are mutually compatible, the version numbers indicated in th XDM Versioning follows the practices laid out in the [Semantic Versioning 2.0.0 guideline](https://semver.org). This means, that XDM version numbers are in the form MAJOR.MINOR.PATCH, with increments happening when: -> * MAJOR version when you make incompatible API changes -> * MINOR version when you add functionality in a backwards-compatible manner -> * PATCH version when you make backwards-compatible bug fixes +> - MAJOR version when you make incompatible API changes +> - MINOR version when you add functionality in a backwards-compatible manner +> - PATCH version when you make backwards-compatible bug fixes Applied to XDM, this means: -* MAJOR version will not be increased once version 1.0.0 is reached -* MINOR version will be increased when new optional properties get added, the range of property values gets broadened -* PATCH version will be increased when names, titles and descriptions of properties get changed +- MAJOR version will not be increased once version 1.0.0 is reached +- MINOR version will be increased when new optional properties get added, the range of property values gets broadened +- PATCH version will be increased when names, titles and descriptions of properties get changed ### Versioning before 1.0.0 diff --git a/docs/status.md b/docs/status.md index 2d0f976b5..74dc018e6 100644 --- a/docs/status.md +++ b/docs/status.md @@ -5,7 +5,7 @@ In particular for XDM Versions prior to XDM 1.0.0, this can inform users and pro XDM defines following status values: -* Stable: the schema is considered stable and can be used in production without any risk. Additions to the schema are possible, but will not impact existing implementations. -* Stabilizing: No further major changes to the schema are expected, but may occur after review. Implementors should check the status of the schema regularly. -* Experimental: Major changes can be expected because the schema is still in active development. Implementors should proceed with caution. -* Deprecated: Schema is no longer maintained, supported or is superceded by another schema/set of schemas. Implementors should update their implementations. +- Stable: the schema is considered stable and can be used in production without any risk. Additions to the schema are possible, but will not impact existing implementations. +- Stabilizing: No further major changes to the schema are expected, but may occur after review. Implementors should check the status of the schema regularly. +- Experimental: Major changes can be expected because the schema is still in active development. Implementors should proceed with caution. +- Deprecated: Schema is no longer maintained, supported or is superceded by another schema/set of schemas. Implementors should update their implementations. diff --git a/extensions/adobe/experience/adcloud/adcloudremarketingprofile.example.1.json b/extensions/adobe/experience/adcloud/adcloudremarketingprofile.example.1.json index 80a8aca42..1330ffe6d 100644 --- a/extensions/adobe/experience/adcloud/adcloudremarketingprofile.example.1.json +++ b/extensions/adobe/experience/adcloud/adcloudremarketingprofile.example.1.json @@ -68,8 +68,7 @@ "xdm:segments": [ { "xdm:segmentID": { - "@id": - "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "@id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", "xdm:namespace": { "xdm:code": "AAM" } @@ -81,8 +80,7 @@ }, { "xdm:segmentID": { - "@id": - "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "@id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f", "xdm:namespace": { "xdm:code": "AAM" } @@ -95,8 +93,7 @@ ], "xdm:syncedRemarketingAudiences": [ { - "xdm:segmentID": - "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9", "xdm:segmentType": 3, "xdm:timestamp": "2018-08-07T08:06:34.672Z", "xdm:partnerDetails": [ @@ -112,8 +109,7 @@ ] }, { - "xdm:segmentID": - "https://data.adobe.io/entities/segmentidentity/53cba6b2-a23b-454a-8069-fc41308f1c0f", + "xdm:segmentID": "https://data.adobe.io/entities/segmentidentity/53cba6b2-a23b-454a-8069-fc41308f1c0f", "xdm:segmentType": 3, "xdm:timestamp": "2018-08-07T08:06:34.672Z", "xdm:partnerDetails": [ diff --git a/extensions/adobe/experience/adcloud/adcloudremarketingprofile.schema.json b/extensions/adobe/experience/adcloud/adcloudremarketingprofile.schema.json index f91684e4b..335e77512 100644 --- a/extensions/adobe/experience/adcloud/adcloudremarketingprofile.schema.json +++ b/extensions/adobe/experience/adcloud/adcloudremarketingprofile.schema.json @@ -18,11 +18,9 @@ "title": "Synchronized segments", "type": "array", "items": { - "$ref": - "https://ns.adobe.com/experience/adcloud/syncedremarketingaudience" + "$ref": "https://ns.adobe.com/experience/adcloud/syncedremarketingaudience" }, - "description": - "List of Search retargeting entities that have been synced with the adCloud partner to build audiences on the platform, e.g. RLSA for Google, WCA for Facebook" + "description": "List of Search retargeting entities that have been synced with the adCloud partner to build audiences on the platform, e.g. RLSA for Google, WCA for Facebook" } } } diff --git a/extensions/adobe/experience/adcloud/advertisement.schema.json b/extensions/adobe/experience/adcloud/advertisement.schema.json index 0cb5de8b6..73626a600 100644 --- a/extensions/adobe/experience/adcloud/advertisement.schema.json +++ b/extensions/adobe/experience/adcloud/advertisement.schema.json @@ -16,14 +16,12 @@ "xdm:adId": { "title": "Ad ID", "type": "string", - "description": - "Unique identifier for the ad this event is associated with. Not to be confused with Ad-ID standard." + "description": "Unique identifier for the ad this event is associated with. Not to be confused with Ad-ID standard." }, "xdm:runtime": { "title": "Runtime Type", "type": "string", - "description": - "The runtime of the ad unit itself, not the runtime of the browser or the operating system.", + "description": "The runtime of the ad unit itself, not the runtime of the browser or the operating system.", "meta:enum": { "unknown": "Unknown", "HTML5": "HTML5" @@ -42,8 +40,7 @@ "xdm:adUnitType": { "title": "Ad Unit Type", "type": "string", - "description": - "Unique identifier for the literal piece of code driving display of the ad in a browser/device.", + "description": "Unique identifier for the literal piece of code driving display of the ad in a browser/device.", "meta:enum": { "linearVideo": "Linear video", "interactiveVideo": "Interactive video", @@ -63,8 +60,7 @@ "xdm:promotedAssetId": { "title": "Promoted Asset ID", "type": "string", - "description": - "Unique identifier for the underlying asset being promoted in the ad which this event is associated with." + "description": "Unique identifier for the underlying asset being promoted in the ad which this event is associated with." } } } diff --git a/extensions/adobe/experience/adcloud/campaign.schema.json b/extensions/adobe/experience/adcloud/campaign.schema.json index d700dedc5..4788f337f 100644 --- a/extensions/adobe/experience/adcloud/campaign.schema.json +++ b/extensions/adobe/experience/adcloud/campaign.schema.json @@ -16,52 +16,44 @@ "xdm:accountId": { "title": "Account ID", "type": "string", - "description": - "Unique identifier for the account this event is associated with." + "description": "Unique identifier for the account this event is associated with." }, "xdm:campaignId": { "title": "Campaign ID", "type": "string", - "description": - "Unique identifier for the campaign which this event is associated with." + "description": "Unique identifier for the campaign which this event is associated with." }, "xdm:placementId": { "title": "Placement ID", "type": "string", - "description": - "Unique identifier for the placement which this event is associated with." + "description": "Unique identifier for the placement which this event is associated with." }, "xdm:packageId": { "title": "Package ID", "type": "string", - "description": - "Unique identifier for the package which this event is associated with." + "description": "Unique identifier for the package which this event is associated with." }, "xdm:advertiserId": { "title": "Advertiser ID", "type": "string", - "description": - "Unique identifier for the advertiser which this event is associated with." + "description": "Unique identifier for the advertiser which this event is associated with." }, "xdm:experimentId": { "title": "Experiment ID", "type": "string", - "description": - "Unique identifier for the experiment which this event is associated with." + "description": "Unique identifier for the experiment which this event is associated with." }, "xdm:sampleGroupId": { "title": "Sample Group ID", "type": "string", - "description": - "Unique identifier for the sample group which this event is associated with." + "description": "Unique identifier for the sample group which this event is associated with." }, "xdm:currency": { "title": "Account Currency", "type": "string", "examples": ["USD", "EUR"], "pattern": "^[A-Z]{3}$", - "description": - "The ISO 4217 billing currency code for the account this event is associated with." + "description": "The ISO 4217 billing currency code for the account this event is associated with." } } } diff --git a/extensions/adobe/experience/adcloud/experienceevent.schema.json b/extensions/adobe/experience/adcloud/experienceevent.schema.json index 3bc7139ae..3f5e7e216 100644 --- a/extensions/adobe/experience/adcloud/experienceevent.schema.json +++ b/extensions/adobe/experience/adcloud/experienceevent.schema.json @@ -39,8 +39,7 @@ }, "allOf": [ { - "$ref": - "https://ns.adobe.com/xdm/context/experienceevent#/definitions/experienceevent" + "$ref": "https://ns.adobe.com/xdm/context/experienceevent#/definitions/experienceevent" }, { "$ref": "#/definitions/experienceevent" diff --git a/extensions/adobe/experience/adcloud/inventory.example.1.json b/extensions/adobe/experience/adcloud/inventory.example.1.json index 21d7fc771..bf019e818 100644 --- a/extensions/adobe/experience/adcloud/inventory.example.1.json +++ b/extensions/adobe/experience/adcloud/inventory.example.1.json @@ -8,7 +8,6 @@ "xdm:segment": { "xdm:attributablePartnerId": "13", "xdm:attributableSegmentId": "123445", - "xdm:segments": - "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" + "xdm:segments": "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" } } diff --git a/extensions/adobe/experience/adcloud/inventory.schema.json b/extensions/adobe/experience/adcloud/inventory.schema.json index e48636085..959740f47 100644 --- a/extensions/adobe/experience/adcloud/inventory.schema.json +++ b/extensions/adobe/experience/adcloud/inventory.schema.json @@ -16,40 +16,34 @@ "xdm:sessionId": { "title": "Session ID", "type": "string", - "description": - "Session ID associated with experience event, used to stitch together independent events which occurred in the same session." + "description": "Session ID associated with experience event, used to stitch together independent events which occurred in the same session." }, "xdm:feedId": { "title": "Feed ID", "type": "string", - "description": - "Composite id of the publisher, ad exchange, and other features." + "description": "Composite id of the publisher, ad exchange, and other features." }, "xdm:sspPartnerCode": { "title": "SSP Partner Code", "type": "string", - "description": - "The partner (exchange) through which AdCloud receives the inventory opportunity." + "description": "The partner (exchange) through which AdCloud receives the inventory opportunity." }, "xdm:siteId": { "title": "Site ID", "type": "string", - "description": - "Identifier for the web site where ad impression was served." + "description": "Identifier for the web site where ad impression was served." }, "xdm:costCurrency": { "title": "Cost Currency", "type": "string", "examples": ["USD", "EUR"], "pattern": "^[A-Z]{3}$", - "description": - "The ISO 4217 currency code used to pay partner for in ad opportunity." + "description": "The ISO 4217 currency code used to pay partner for in ad opportunity." }, "xdm:inventorySourceId": { "title": "Inventory Source ID", "type": "string", - "description": - "The id of the AdCloud inventory source this opportunity was delivered on." + "description": "The id of the AdCloud inventory source this opportunity was delivered on." }, "xdm:segment": { "title": "Segmentation Details", diff --git a/extensions/adobe/experience/adcloud/partnerdata.schema.json b/extensions/adobe/experience/adcloud/partnerdata.schema.json index a0e4ef567..431f8a03d 100644 --- a/extensions/adobe/experience/adcloud/partnerdata.schema.json +++ b/extensions/adobe/experience/adcloud/partnerdata.schema.json @@ -16,14 +16,12 @@ "xdm:id": { "title": "Search/Marketing partner ID", "type": "string", - "description": - "Internal mapping of search/marketing platforms/partners to IDs for Adcloud Search." + "description": "Internal mapping of search/marketing platforms/partners to IDs for Adcloud Search." }, "xdm:data": { "title": "Search/Marketing partner data associated with a segment", "type": "string", - "description": - "Unique identifiers such conversion id (in case of Google) associated with the synced segment." + "description": "Unique identifiers such conversion id (in case of Google) associated with the synced segment." } } } diff --git a/extensions/adobe/experience/adcloud/segment.example.1.json b/extensions/adobe/experience/adcloud/segment.example.1.json index cede1a88b..c6b4d020a 100644 --- a/extensions/adobe/experience/adcloud/segment.example.1.json +++ b/extensions/adobe/experience/adcloud/segment.example.1.json @@ -1,6 +1,5 @@ { "xdm:attributablePartnerId": "13", "xdm:attributableSegmentId": "123445", - "xdm:segments": - "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" + "xdm:segments": "AbbKlvGfgVH7WK2TH6jd,5lmd4aQCvvrv1yIhjlLQ,9uGk1eYROeHVWiGAOR4p" } diff --git a/extensions/adobe/experience/adcloud/segment.schema.json b/extensions/adobe/experience/adcloud/segment.schema.json index 21e3e66ab..3d39bfd47 100644 --- a/extensions/adobe/experience/adcloud/segment.schema.json +++ b/extensions/adobe/experience/adcloud/segment.schema.json @@ -16,20 +16,17 @@ "xdm:attributablePartnerId": { "title": "Attributable Partner ID", "type": "string", - "description": - "The segment provider who owns the attributableSegmentId." + "description": "The segment provider who owns the attributableSegmentId." }, "xdm:attributableSegmentId": { "title": "Attributable Segment ID", "type": "string", - "description": - "The single segment accredit for user targeting among all the segments in the placement's targeting rule for the purposes of tracking costs and paying partners." + "description": "The single segment accredit for user targeting among all the segments in the placement's targeting rule for the purposes of tracking costs and paying partners." }, "xdm:segments": { "title": "Segments", "type": "string", - "description": - "The intersection of the user segments that both: a) the user belonged to, and b) the ad was targeting. NOT the full list of segments that the user belonged to at the time of the auction." + "description": "The intersection of the user segments that both: a) the user belonged to, and b) the ad was targeting. NOT the full list of segments that the user belonged to at the time of the auction." } } } diff --git a/extensions/adobe/experience/adcloud/syncedremarketingaudience.schema.json b/extensions/adobe/experience/adcloud/syncedremarketingaudience.schema.json index 92fde8417..5a23cc957 100644 --- a/extensions/adobe/experience/adcloud/syncedremarketingaudience.schema.json +++ b/extensions/adobe/experience/adcloud/syncedremarketingaudience.schema.json @@ -9,16 +9,14 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Synchronized Remarketing Audiences", "type": "object", - "description": - "Details about AdCloud Search segments used for retargeting surfers on a Search/Marketing platform.", + "description": "Details about AdCloud Search segments used for retargeting surfers on a Search/Marketing platform.", "definitions": { "syncedremarketingaudience": { "properties": { "xdm:segmentID": { "title": "Segment ID", "type": "string", - "description": - "Id for the segment that would be used to retarget the surfer." + "description": "Id for the segment that would be used to retarget the surfer." }, "xdm:type": { "title": "Segment/Audience type", @@ -29,8 +27,7 @@ "title": "Timestamp", "type": "string", "format": "date-time", - "description": - "The timestamp when the retargeting entity, e.g. aam-segment, was sycned to the marketing platform." + "description": "The timestamp when the retargeting entity, e.g. aam-segment, was sycned to the marketing platform." }, "xdm:partnerDetails": { "title": "Marketing Partner Details", diff --git a/extensions/adobe/experience/analytics/experienceevent.schema.json b/extensions/adobe/experience/analytics/experienceevent.schema.json index 29b11b32f..f887c28eb 100644 --- a/extensions/adobe/experience/analytics/experienceevent.schema.json +++ b/extensions/adobe/experience/analytics/experienceevent.schema.json @@ -26,28 +26,24 @@ "xdm:depth": { "title": "Session Depth", "type": "integer", - "description": - "Current session depth (eg page number) for the end-user." + "description": "Current session depth (eg page number) for the end-user." }, "xdm:timestamp": { "title": "Session Entry Timestamp", "type": "integer", - "description": - "The timestamp at the entry into this session. Milliseconds since midnight of January 1, 1970.", + "description": "The timestamp at the entry into this session. Milliseconds since midnight of January 1, 1970.", "minimum": 1, "maximum": 9223372036854770000 }, "xdm:search": { "title": "Session Entry Search", "$ref": "https://ns.adobe.com/xdm/context/search", - "description": - "The information related to web or mobile search at the entry of this session." + "description": "The information related to web or mobile search at the entry of this session." }, "xdm:web": { "title": "Session Entry Web", "$ref": "https://ns.adobe.com/xdm/context/webinfo", - "description": - "The information related to web page, link, and referrer at the entry of this session." + "description": "The information related to web page, link, and referrer at the entry of this session." } } }, @@ -58,16 +54,14 @@ "xdm:firstTimestamp": { "title": "End User First Timestamp", "type": "integer", - "description": - "The timestamp for the first ExperienceEvent for this end-user. Milliseconds since midnight of January 1, 1970.", + "description": "The timestamp for the first ExperienceEvent for this end-user. Milliseconds since midnight of January 1, 1970.", "minimum": 1, "maximum": 9223372036854770000 }, "xdm:firstWeb": { "title": "End User First Web Details", "$ref": "https://ns.adobe.com/xdm/context/webinfo", - "description": - "The information related to web page, link, and referrer from the first ExperienceEvent for this end-user." + "description": "The information related to web page, link, and referrer from the first ExperienceEvent for this end-user." } } }, @@ -1719,452 +1713,377 @@ "xdm:prop1": { "title": "prop1", "description": "Custom property variable1", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop2": { "title": "prop2", "description": "Custom property variable2", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop3": { "title": "prop3", "description": "Custom property variable3", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop4": { "title": "prop4", "description": "Custom property variable4", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop5": { "title": "prop5", "description": "Custom property variable5", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop6": { "title": "prop6", "description": "Custom property variable6", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop7": { "title": "prop7", "description": "Custom property variable7", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop8": { "title": "prop8", "description": "Custom property variable8", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop9": { "title": "prop9", "description": "Custom property variable9", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop10": { "title": "prop10", "description": "Custom property variable10", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop11": { "title": "prop11", "description": "Custom property variable11", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop12": { "title": "prop12", "description": "Custom property variable12", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop13": { "title": "prop13", "description": "Custom property variable13", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop14": { "title": "prop14", "description": "Custom property variable14", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop15": { "title": "prop15", "description": "Custom property variable15", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop16": { "title": "prop16", "description": "Custom property variable16", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop17": { "title": "prop17", "description": "Custom property variable17", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop18": { "title": "prop18", "description": "Custom property variable18", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop19": { "title": "prop19", "description": "Custom property variable19", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop20": { "title": "prop20", "description": "Custom property variable20", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop21": { "title": "prop21", "description": "Custom property variable21", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop22": { "title": "prop22", "description": "Custom property variable22", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop23": { "title": "prop23", "description": "Custom property variable23", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop24": { "title": "prop24", "description": "Custom property variable24", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop25": { "title": "prop25", "description": "Custom property variable25", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop26": { "title": "prop26", "description": "Custom property variable26", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop27": { "title": "prop27", "description": "Custom property variable27", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop28": { "title": "prop28", "description": "Custom property variable28", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop29": { "title": "prop29", "description": "Custom property variable29", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop30": { "title": "prop30", "description": "Custom property variable30", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop31": { "title": "prop31", "description": "Custom property variable31", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop32": { "title": "prop32", "description": "Custom property variable32", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop33": { "title": "prop33", "description": "Custom property variable33", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop34": { "title": "prop34", "description": "Custom property variable34", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop35": { "title": "prop35", "description": "Custom property variable35", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop36": { "title": "prop36", "description": "Custom property variable36", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop37": { "title": "prop37", "description": "Custom property variable37", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop38": { "title": "prop38", "description": "Custom property variable38", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop39": { "title": "prop39", "description": "Custom property variable39", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop40": { "title": "prop40", "description": "Custom property variable40", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop41": { "title": "prop41", "description": "Custom property variable41", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop42": { "title": "prop42", "description": "Custom property variable42", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop43": { "title": "prop43", "description": "Custom property variable43", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop44": { "title": "prop44", "description": "Custom property variable44", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop45": { "title": "prop45", "description": "Custom property variable45", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop46": { "title": "prop46", "description": "Custom property variable46", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop47": { "title": "prop47", "description": "Custom property variable47", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop48": { "title": "prop48", "description": "Custom property variable48", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop49": { "title": "prop49", "description": "Custom property variable49", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop50": { "title": "prop50", "description": "Custom property variable50", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop51": { "title": "prop51", "description": "Custom property variable51", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop52": { "title": "prop52", "description": "Custom property variable52", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop53": { "title": "prop53", "description": "Custom property variable53", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop54": { "title": "prop54", "description": "Custom property variable54", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop55": { "title": "prop55", "description": "Custom property variable55", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop56": { "title": "prop56", "description": "Custom property variable56", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop57": { "title": "prop57", "description": "Custom property variable57", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop58": { "title": "prop58", "description": "Custom property variable58", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop59": { "title": "prop59", "description": "Custom property variable59", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop60": { "title": "prop60", "description": "Custom property variable60", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop61": { "title": "prop61", "description": "Custom property variable61", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop62": { "title": "prop62", "description": "Custom property variable62", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop63": { "title": "prop63", "description": "Custom property variable63", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop64": { "title": "prop64", "description": "Custom property variable64", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop65": { "title": "prop65", "description": "Custom property variable65", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop66": { "title": "prop66", "description": "Custom property variable66", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop67": { "title": "prop67", "description": "Custom property variable67", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop68": { "title": "prop68", "description": "Custom property variable68", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop69": { "title": "prop69", "description": "Custom property variable69", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop70": { "title": "prop70", "description": "Custom property variable70", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop71": { "title": "prop71", "description": "Custom property variable71", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop72": { "title": "prop72", "description": "Custom property variable72", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop73": { "title": "prop73", "description": "Custom property variable73", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop74": { "title": "prop74", "description": "Custom property variable74", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:prop75": { "title": "prop75", "description": "Custom property variable75", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" } } }, @@ -2175,32 +2094,27 @@ "xdm:hier1": { "title": "hier1", "description": "Custom hierarchy variable 1.", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:hier2": { "title": "hier2", "description": "Custom hierarchy variable 2.", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:hier3": { "title": "hier3", "description": "Custom hierarchy variable 3.", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:hier4": { "title": "hier4", "description": "Custom hierarchy variable 4.", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" }, "xdm:hier5": { "title": "hier5", "description": "Custom hierarchy variable 5.", - "$ref": - "https://ns.adobe.com/experience/analytics/listdetails" + "$ref": "https://ns.adobe.com/experience/analytics/listdetails" } } }, @@ -7304,14 +7218,12 @@ "xdm:browserID": { "title": "Browser ID", "type": "integer", - "description": - "The Adobe Analytics Identifier for the browser used." + "description": "The Adobe Analytics Identifier for the browser used." }, "xdm:operatingSystemID": { "title": "Operating System ID", "type": "integer", - "description": - "The Adobe Analytics Identifier of the operating system used." + "description": "The Adobe Analytics Identifier of the operating system used." } } } diff --git a/extensions/adobe/experience/campaign/address.schema.json b/extensions/adobe/experience/campaign/address.schema.json index aba3f04bb..4980917d7 100644 --- a/extensions/adobe/experience/campaign/address.schema.json +++ b/extensions/adobe/experience/campaign/address.schema.json @@ -17,8 +17,7 @@ "https://ns.adobe.com/experience/campaign/addressErrorCount": { "title": "Address Error Count", "type": "integer", - "description": - "Number of consecutive errors when sending to this address." + "description": "Number of consecutive errors when sending to this address." }, "https://ns.adobe.com/experience/campaign/addressQuality": { "title": "Address Quality", diff --git a/extensions/adobe/experience/campaign/experienceevent.example.click.json b/extensions/adobe/experience/campaign/experienceevent.example.click.json index 6544d366d..ae9d8dc5c 100644 --- a/extensions/adobe/experience/campaign/experienceevent.example.click.json +++ b/extensions/adobe/experience/campaign/experienceevent.example.click.json @@ -74,8 +74,7 @@ }, "https://ns.adobe.com/experience/campaign/link": { "xdm:id": "98765", - "xdm:url": - "https://newsletters.adobe.com/newsletter/101/mastering-xdm.html", + "xdm:url": "https://newsletters.adobe.com/newsletter/101/mastering-xdm.html", "xdm:occurrence": 2, "xdm:category": "Promotional Links", "xdm:label": "XDM information" @@ -83,6 +82,5 @@ "https://ns.adobe.com/experience/campaign/orchestration": { "xdm:eventID": "store-entry-beacon-triggered" }, - "https://ns.adobe.com/experience/campaign/eventSource": - "pipelined-trackinglogd" + "https://ns.adobe.com/experience/campaign/eventSource": "pipelined-trackinglogd" } diff --git a/extensions/adobe/experience/campaign/experienceevent.example.open-push.json b/extensions/adobe/experience/campaign/experienceevent.example.open-push.json index 38212be62..adc66b151 100644 --- a/extensions/adobe/experience/campaign/experienceevent.example.open-push.json +++ b/extensions/adobe/experience/campaign/experienceevent.example.open-push.json @@ -76,6 +76,5 @@ "https://ns.adobe.com/experience/campaign/orchestration": { "xdm:eventID": "store-entry-beacon-triggered" }, - "https://ns.adobe.com/experience/campaign/eventSource": - "pipelined-trackinglogd" + "https://ns.adobe.com/experience/campaign/eventSource": "pipelined-trackinglogd" } diff --git a/extensions/adobe/experience/campaign/experienceevent.schema.json b/extensions/adobe/experience/campaign/experienceevent.schema.json index a771c24bb..137a29305 100755 --- a/extensions/adobe/experience/campaign/experienceevent.schema.json +++ b/extensions/adobe/experience/campaign/experienceevent.schema.json @@ -26,55 +26,47 @@ "xdm:profile": { "title": "Profile", "$ref": "https://ns.adobe.com/xdm/context/profile", - "description": - "The recipient of the message. This property is primarily used to link the message to a Profile using the `EndCustomerID` but it can also be used to freeze some properties of the profile at the time the message was sent." + "description": "The recipient of the message. This property is primarily used to link the message to a Profile using the `EndCustomerID` but it can also be used to freeze some properties of the profile at the time the message was sent." }, "xdm:variant": { "title": "Content Variant", "type": "string", - "description": - "A campaign activity can have multiple variants e.g. Multilingual (translated variants for the same content) or A/B testing (different content to test what works better) but a message delivered to a recipient always contains one of them.\n> IMPORTANT: In case of multilingual, the mirror page, the recipient can switch from one variant to another (ex: switch of the language)." + "description": "A campaign activity can have multiple variants e.g. Multilingual (translated variants for the same content) or A/B testing (different content to test what works better) but a message delivered to a recipient always contains one of them.\n> IMPORTANT: In case of multilingual, the mirror page, the recipient can switch from one variant to another (ex: switch of the language)." }, "xdm:seedMember": { "title": "Seed Member", "type": "boolean", "default": false, - "description": - "The recipient of this message is a member of a seed list for this campaign activity. Seed addresses are used to include recipients who do not match the defined target criteria. Seed members could be your marketing team or other stakeholders who are interested in tracking/measuring the quality of the campaign. SeedMembers get the actual message, at the same time with regular recipients, even when the seedMember does not qualify to be a regular recipient." + "description": "The recipient of this message is a member of a seed list for this campaign activity. Seed addresses are used to include recipients who do not match the defined target criteria. Seed members could be your marketing team or other stakeholders who are interested in tracking/measuring the quality of the campaign. SeedMembers get the actual message, at the same time with regular recipients, even when the seedMember does not qualify to be a regular recipient." }, "xdm:quarantine": { "title": "Quarantine", "type": "boolean", "default": false, - "description": - "Address moved to quarantine. The quarantine is set to `true` when the message failed to deliver in a way that indicates that no future messages will be deliverable either to this address." + "description": "Address moved to quarantine. The quarantine is set to `true` when the message failed to deliver in a way that indicates that no future messages will be deliverable either to this address." }, "xdm:proofMember": { "title": "Proof Member", "type": "boolean", - "description": - "The recipient of this message is a member of the proof group for this campaign activity. The proof is a special message that lets you test a delivery before sending to the main target. Proof recipients are responsible for approving both the form and content of the message. It is a pre-delivery target.", + "description": "The recipient of this message is a member of the proof group for this campaign activity. The proof is a special message that lets you test a delivery before sending to the main target. Proof recipients are responsible for approving both the form and content of the message. It is a pre-delivery target.", "default": false }, "xdm:controlGroupMember": { "title": "Control Group Member", "type": "boolean", - "description": - "The recipient of this message is a member of a control group for this campaign activity. A control group is a population which will not receive the delivery; it is used to track post-delivery behavior and campaign impact by making a comparison between the control group (or hold out group) with the behavior of target population, which has received the delivery.", + "description": "The recipient of this message is a member of a control group for this campaign activity. A control group is a population which will not receive the delivery; it is used to track post-delivery behavior and campaign impact by making a comparison between the control group (or hold out group) with the behavior of target population, which has received the delivery.", "default": false }, "xdm:testMember": { "title": "A/B Test Member", "type": "boolean", - "description": - "The recipient of this message is a member of a test group for this campaign activity. This is primarily used for identifying the initial population of an A/B Test. After sending different variants to the testMembers, the winner Variant is decided to be sent to the remaining population based on behavioural changes in testMembers.", + "description": "The recipient of this message is a member of a test group for this campaign activity. This is primarily used for identifying the initial population of an A/B Test. After sending different variants to the testMembers, the winner Variant is decided to be sent to the remaining population based on behavioural changes in testMembers.", "default": false }, "xdm:size": { "title": "Size (Bytes)", "type": "integer", - "description": - "Size in bytes of the message.\n* For email, the `size` reflects the all MIME envelope of the message, including the encoded attachments if any.\n* For SMS, the `size` reflects the number of bytes necessary to deliver the message.\nIf that number is over 160 the message will be delivered over more than one SMS.", + "description": "Size in bytes of the message.\n* For email, the `size` reflects the all MIME envelope of the message, including the encoded attachments if any.\n* For SMS, the `size` reflects the number of bytes necessary to deliver the message.\nIf that number is over 160 the message will be delivered over more than one SMS.", "minimum": 0, "maximum": 2147483647 }, @@ -83,47 +75,31 @@ "type": "string", "meta:enum": { "undefined": "Not defined", - "unknown_user": - "The address does not exist. There is no use sending deliveries to this address.", - "invalid_domain": - "The domain of the email address is incorrect or no longer exists.", - "unreachable": - "An error has occurred in the message delivery chain.These addresses can be removed from the quarantine list to make another attempt.", - "disabled": - "The user uses a messaging service which is accessible from the web. When the Internet Access Provider (IAP) detects a lengthy period of inactivity, it can close the user's account. Deliveries to the user's address will then be impossible.", - "mailbox_full": - "The recipient's mailbox contains too many messages. This address can be removed from the quarantine list to make another attempt.", - "not_connected": - "The recipient's mobile phone is switched off or not connected to the network when the message is sent.", - "refused": - "The address was rejected following the application of a security rule (e.g. by an anti-spam program)", - "error_ignored": - "The address is whitelisted and the message ignored.", + "unknown_user": "The address does not exist. There is no use sending deliveries to this address.", + "invalid_domain": "The domain of the email address is incorrect or no longer exists.", + "unreachable": "An error has occurred in the message delivery chain.These addresses can be removed from the quarantine list to make another attempt.", + "disabled": "The user uses a messaging service which is accessible from the web. When the Internet Access Provider (IAP) detects a lengthy period of inactivity, it can close the user's account. Deliveries to the user's address will then be impossible.", + "mailbox_full": "The recipient's mailbox contains too many messages. This address can be removed from the quarantine list to make another attempt.", + "not_connected": "The recipient's mobile phone is switched off or not connected to the network when the message is sent.", + "refused": "The address was rejected following the application of a security rule (e.g. by an anti-spam program)", + "error_ignored": "The address is whitelisted and the message ignored.", "address_undefined": "No address is given for the recipient.", - "blacklisted": - "The address was blacklisted at the time of sending.", - "quarantine": - "The address was in quarantine at the time of sending.", - "duplicate": - "The address of the recipient was already in this campaign activity.", - "typology_rule": - "The recipient was excluded by a 'SQL' type campaign typology rule.", - "business_ranking": - "The recipient was excluded by an 'arbitration' type campaign typology rule", + "blacklisted": "The address was blacklisted at the time of sending.", + "quarantine": "The address was in quarantine at the time of sending.", + "duplicate": "The address of the recipient was already in this campaign activity.", + "typology_rule": "The recipient was excluded by a 'SQL' type campaign typology rule.", + "business_ranking": "The recipient was excluded by an 'arbitration' type campaign typology rule", "cancelled": "Delivery cancelled", "quality": "The quality rating for this address is too low", "unchecked": "Unqualified address", "offer_missing": "Not eligible for the offers", - "over_delivery_limit": - "The campaign activity had more than allowed number of target profiles.", - "expired": - "The campaign activity exceeded the time duration to complete.", + "over_delivery_limit": "The campaign activity had more than allowed number of target profiles.", + "expired": "The campaign activity exceeded the time duration to complete.", "too_long": "Text too long", "untranslatable": "Character not supported by encoding", "control_group": "Control address" }, - "description": - "The reason why the message could/would not be delivered.", + "description": "The reason why the message could/would not be delivered.", "default": "undefined" }, "xdm:reasonMessage": { @@ -147,14 +123,12 @@ "xdm:externalID": { "title": "External ID", "type": "string", - "description": - "An ID generated by the parent activity invoking service to check later if the incoming experienceEvent was generated using this ID." + "description": "An ID generated by the parent activity invoking service to check later if the incoming experienceEvent was generated using this ID." } } }, "https://ns.adobe.com/experience/campaign/delivery": { - "title": - "The campaign activity originating a message to a recipient.", + "title": "The campaign activity originating a message to a recipient.", "type": "object", "properties": { "xdm:id": { @@ -165,14 +139,12 @@ "xdm:from": { "title": "From", "type": "string", - "description": - "Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format.\n\n * `email`: an email address.\n * `textMessage` or `phone`: a shortcode or phone number." + "description": "Address used as a from/sender/caller address. Depending on the communication channel, the `address` has a different format.\n\n * `email`: an email address.\n * `textMessage` or `phone`: a shortcode or phone number." }, "xdm:testEnabled": { "title": "Test Enabled", "type": "boolean", - "description": - "Specify whether campaign activity is of type A/B testing.", + "description": "Specify whether campaign activity is of type A/B testing.", "default": false }, "xdm:messageClass": { @@ -189,51 +161,43 @@ "xdm:templateName": { "title": "Delivery Template's Internal name", "type": "string", - "description": - "A human-friendly identifier of the the parent entity (in case of event_based or continuous message Class) of the campaign activity originating this message." + "description": "A human-friendly identifier of the the parent entity (in case of event_based or continuous message Class) of the campaign activity originating this message." }, "xdm:templateID": { "title": "Identifier of the Template", "type": "integer", - "description": - "The delivery template's ID used to initialize this delivery.\n\nThe type the template used in Adobe Campaign can be identified using the `messageClass`.\n\n* `messageClass` = `oneTime`: the template is standard delivery template.\n* `messageClass` = `continuous`: the template is a recurring delivery.\n* `messageClass` = `transactional`: the template is a transactionnal message template.\n" + "description": "The delivery template's ID used to initialize this delivery.\n\nThe type the template used in Adobe Campaign can be identified using the `messageClass`.\n\n* `messageClass` = `oneTime`: the template is standard delivery template.\n* `messageClass` = `continuous`: the template is a recurring delivery.\n* `messageClass` = `transactional`: the template is a transactionnal message template.\n" }, "xdm:deliveryLabel": { "title": "Delivery Label", "type": "string", - "description": - "A human-friendly name of the campaign activity which is originating this message." + "description": "A human-friendly name of the campaign activity which is originating this message." }, "xdm:deliveryName": { "title": "Delivery Internal name", "type": "string", - "description": - "A human-friendly identifier of the campaign activity which is originating this message." + "description": "A human-friendly identifier of the campaign activity which is originating this message." } } }, "https://ns.adobe.com/experience/campaign/marketingCampaign": { - "title": - "The campaign activity originating a message to a recipient.", + "title": "The campaign activity originating a message to a recipient.", "type": "object", "properties": { "xdm:id": { "title": "Campaign ID", "type": "integer", - "description": - "Identifier of the marketing campaign to which activity originating this message belongs to." + "description": "Identifier of the marketing campaign to which activity originating this message belongs to." }, "xdm:campaignName": { "title": "Campaign Internal name", "type": "string", - "description": - "A human-friendly identifier of the marketing campaign which is originating this message." + "description": "A human-friendly identifier of the marketing campaign which is originating this message." } } }, "https://ns.adobe.com/experience/campaign/link": { - "title": - "The campaign activity originating a message to a recipient.", + "title": "The campaign activity originating a message to a recipient.", "type": "object", "properties": { "xdm:id": { @@ -255,8 +219,7 @@ "xdm:occurrence": { "title": "Occurrence", "type": "integer", - "description": - "URL occurrence index in the content (first is 1). When the same URL is available several times in the same content, its is necessary to track which occurrence of the URL has been clicked on.", + "description": "URL occurrence index in the content (first is 1). When the same URL is available several times in the same content, its is necessary to track which occurrence of the URL has been clicked on.", "default": 1, "minimum": 1, "maximum": 32767 @@ -264,14 +227,12 @@ "xdm:label": { "title": "URL Label", "type": "string", - "description": - "The user-friendly label clicking on which the link opens." + "description": "The user-friendly label clicking on which the link opens." }, "xdm:category": { "title": "URL Category", "type": "string", - "description": - "The category of the link. It may be `subscription`, or a user-defined category." + "description": "The category of the link. It may be `subscription`, or a user-defined category." } } }, @@ -283,55 +244,40 @@ "meta:status": "deprecated", "title": "Business Reason", "type": "string", - "description": - "Business qualifier that identifies the event sent by the data source. It informs on the business reason for sending the event. It is unique per organization. This is used by Campaign orchestration to identify the event without inspecting its payload to determine which action should be triggered when the event is received. The value of this field is a contract between Campaign orchestration and the data source." + "description": "Business qualifier that identifies the event sent by the data source. It informs on the business reason for sending the event. It is unique per organization. This is used by Campaign orchestration to identify the event without inspecting its payload to determine which action should be triggered when the event is received. The value of this field is a contract between Campaign orchestration and the data source." }, "xdm:eventID": { "title": "Event ID", "type": "string", - "description": - "ID that identifies the event sent by the data source. This is used by Campaign orchestration to identify the event without inspecting its payload to determine which action should be triggered when the event is received. The value is automatically generated in Campaign at event creation time, it is globally unique across organizations." + "description": "ID that identifies the event sent by the data source. This is used by Campaign orchestration to identify the event without inspecting its payload to determine which action should be triggered when the event is received. The value is automatically generated in Campaign at event creation time, it is globally unique across organizations." }, "xdm:orchestrationDetails": { "title": "Orchestration Details", - "description": - "Set of attributes that are associated with every orchestration.", - "$ref": - "https://ns.adobe.com/experience/campaign/orchestration/orchestrationdetails" + "description": "Set of attributes that are associated with every orchestration.", + "$ref": "https://ns.adobe.com/experience/campaign/orchestration/orchestrationdetails" } } }, "https://ns.adobe.com/experience/campaign/containerID": { "title": "Container identifier", "type": "string", - "description": - "The identifier denoting the container with which campaign experience event is associated." + "description": "The identifier denoting the container with which campaign experience event is associated." }, "https://ns.adobe.com/experience/campaign/eventSource": { "title": "Event Source", "type": "string", "meta:enum": { - "replay-pipelined-mta": - "This event was generated via Replay Utility tool generated from Pipelined", - "replay-pipelined-inMail": - "This event was generated via Replay Utility tool generated from Pipelined", - "replay-pipelined-trackinglogd": - "This event was generated via Replay Utility tool generated from Pipelined", - "replay-pipelined-pipelined": - "This event was generated via Replay Utility tool generated from Pipelined", - "pipelined-mta": - "This event was generated via Pipelined generated from mta", - "pipelined-inMail": - "This event was generated via Pipelined generated from inMail", - "pipelined-trackinglogd": - "This event was generated via Pipelined generated from trackinglogd", - "pipelined-pipelined": - "This event was generated via Pipelined generated from Pipelined", - "replay": - "This event was generated via Replay Utility tool which did not have any event source" + "replay-pipelined-mta": "This event was generated via Replay Utility tool generated from Pipelined", + "replay-pipelined-inMail": "This event was generated via Replay Utility tool generated from Pipelined", + "replay-pipelined-trackinglogd": "This event was generated via Replay Utility tool generated from Pipelined", + "replay-pipelined-pipelined": "This event was generated via Replay Utility tool generated from Pipelined", + "pipelined-mta": "This event was generated via Pipelined generated from mta", + "pipelined-inMail": "This event was generated via Pipelined generated from inMail", + "pipelined-trackinglogd": "This event was generated via Pipelined generated from trackinglogd", + "pipelined-pipelined": "This event was generated via Pipelined generated from Pipelined", + "replay": "This event was generated via Replay Utility tool which did not have any event source" }, - "description": - "A human-friendly name of the campaign activity which is originating this message." + "description": "A human-friendly name of the campaign activity which is originating this message." } } }, @@ -339,8 +285,7 @@ "properties": { "https://ns.adobe.com/experience/campaign/mutation": { "title": "Mutated fields from the previous experienceEvent.", - "description": - "Information of the fields that have changed since the previous experienceevent to keep track of the state changes across events. For e.g. if when an email gets sent, an experienceEvent with metric `sends` will be sent. This may get bounced and an experienceEvent with metric `bounces` will be sent then. It may be important for a downstream application to know that the previous experienceEvent with metric `sends` is now to be invalidated. This field will contain the values from the previous experienceEvent that have a different value in the current experienceEvent.", + "description": "Information of the fields that have changed since the previous experienceevent to keep track of the state changes across events. For e.g. if when an email gets sent, an experienceEvent with metric `sends` will be sent. This may get bounced and an experienceEvent with metric `bounces` will be sent then. It may be important for a downstream application to know that the previous experienceEvent with metric `sends` is now to be invalidated. This field will contain the values from the previous experienceEvent that have a different value in the current experienceEvent.", "$ref": "https://ns.adobe.com/experience/campaign/mutationevent" } } diff --git a/extensions/adobe/experience/campaign/journeyaifatigue.schema.json b/extensions/adobe/experience/campaign/journeyaifatigue.schema.json index 1b7b6379d..1341b741e 100644 --- a/extensions/adobe/experience/campaign/journeyaifatigue.schema.json +++ b/extensions/adobe/experience/campaign/journeyaifatigue.schema.json @@ -22,8 +22,7 @@ }, "xdm:fatigueLevel": { "title": "Fatigue Level", - "description": - "Classification of profile into different buckets, based on fatigue score", + "description": "Classification of profile into different buckets, based on fatigue score", "type": "string", "enum": ["low", "medium", "high"], "meta:enum": { diff --git a/extensions/adobe/experience/campaign/journeyaiscores.schema.json b/extensions/adobe/experience/campaign/journeyaiscores.schema.json index 0e92bf515..18c498694 100644 --- a/extensions/adobe/experience/campaign/journeyaiscores.schema.json +++ b/extensions/adobe/experience/campaign/journeyaiscores.schema.json @@ -20,8 +20,7 @@ }, "xdm:openScores": { "title": "Open Scores by send hour for week", - "description": - "Probability/score to open a message, assuming we send a message at that hour", + "description": "Probability/score to open a message, assuming we send a message at that hour", "type": "array", "minItems": 168, "maxItems": 168, @@ -31,8 +30,7 @@ }, "xdm:clickScores": { "title": "Click Scores by send hour for week", - "description": - "Probability/score to click on a link in the message, assuming we send a message at that hour", + "description": "Probability/score to click on a link in the message, assuming we send a message at that hour", "type": "array", "minItems": 168, "maxItems": 168, diff --git a/extensions/adobe/experience/campaign/mutationevent.schema.json b/extensions/adobe/experience/campaign/mutationevent.schema.json index b319c2d01..cdc261adb 100644 --- a/extensions/adobe/experience/campaign/mutationevent.schema.json +++ b/extensions/adobe/experience/campaign/mutationevent.schema.json @@ -28,26 +28,22 @@ "title": "Timestamp", "type": "string", "format": "date-time", - "description": - "The time when the first event of the interaction occurred." + "description": "The time when the first event of the interaction occurred." }, "xdm:endUserIDs": { "title": "End User IDs", "$ref": "https://ns.adobe.com/xdm/context/enduserids", - "description": - "Condensed, normalized encapsulation of all end user identifiers.\n" + "description": "Condensed, normalized encapsulation of all end user identifiers.\n" }, "xdm:environment": { "title": "Environment", "$ref": "https://ns.adobe.com/xdm/context/environment", - "description": - "Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions." + "description": "Information about the surrounding situation the event observation occurred in, specifically detailing transitory information such as the network or software versions." }, "xdm:productListItems": { "title": "Product List Items", "type": "array", - "description": - "A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.", + "description": "A list of items representing a product selected by a customer with specific options and pricing that are for that usage context at a specific point of time and may differ from the product record.", "items": { "$ref": "https://ns.adobe.com/xdm/content/productlistitem" } @@ -55,20 +51,17 @@ "xdm:device": { "title": "Device", "$ref": "https://ns.adobe.com/xdm/context/device", - "description": - "An identified Device/Application or Device/Browser instance that is trackable across sessions, normally by cookies." + "description": "An identified Device/Application or Device/Browser instance that is trackable across sessions, normally by cookies." }, "xdm:commerce": { "title": "Commerce", "$ref": "https://ns.adobe.com/xdm/context/commerce", - "description": - "The commerce specific data related to this interaction." + "description": "The commerce specific data related to this interaction." }, "xdm:application": { "title": "Application", "$ref": "https://ns.adobe.com/xdm/context/application", - "description": - "The application related to the event observation. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login." + "description": "The application related to the event observation. It could be either the application targeted by the event like the send of a push notification or the application originating the event such as a click, or a login." }, "xdm:search": { "title": "Search", @@ -78,38 +71,32 @@ "xdm:web": { "title": "Web", "$ref": "https://ns.adobe.com/xdm/context/webinfo", - "description": - "The information related to web page and link of the ExperienceEvent." + "description": "The information related to web page and link of the ExperienceEvent." }, "xdm:directMarketing": { "title": "Direct Marketing", "$ref": "https://ns.adobe.com/xdm/context/direct-marketing", - "description": - "The events and properties related to direct/outbound marketing such as email, direct mail, texts and in-app notifications." + "description": "The events and properties related to direct/outbound marketing such as email, direct mail, texts and in-app notifications." }, "xdm:marketing": { "title": "Marketing", "$ref": "https://ns.adobe.com/xdm/context/marketing", - "description": - "The information related to marketing activities that are active with the touchpoint." + "description": "The information related to marketing activities that are active with the touchpoint." }, "xdm:placeContext": { "title": "Place Context", "$ref": "https://ns.adobe.com/xdm/context/placecontext", - "description": - "The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, working hours." + "description": "The transient circumstances related to the observation. Examples include locale specific information such as weather, local time, traffic, day of the week, workday vs. holiday, working hours." }, "xdm:channel": { "title": "Experience Channel", - "description": - "The experience channel related to this ExperienceEvent.", + "description": "The experience channel related to this ExperienceEvent.", "$ref": "https://ns.adobe.com/xdm/channels/channel" }, "xdm:advertising": { "title": "Advertising", "$ref": "https://ns.adobe.com/xdm/context/advertising", - "description": - "The information related to advertising activity related to the experience event" + "description": "The information related to advertising activity related to the experience event" } } } @@ -119,8 +106,7 @@ "$ref": "#/definitions/experienceevent" }, { - "$ref": - "https://ns.adobe.com/experience/campaign/experienceevent#/definitions/experienceevent" + "$ref": "https://ns.adobe.com/experience/campaign/experienceevent#/definitions/experienceevent" } ], "meta:status": "experimental" diff --git a/extensions/adobe/experience/campaign/notificationsubscription.schema.json b/extensions/adobe/experience/campaign/notificationsubscription.schema.json index 018c1d6c8..f30617eb9 100644 --- a/extensions/adobe/experience/campaign/notificationsubscription.schema.json +++ b/extensions/adobe/experience/campaign/notificationsubscription.schema.json @@ -10,16 +10,14 @@ "title": "Notification subscription", "type": "object", "meta:extensible": true, - "description": - "Adobe Campaign notification subscriptions allow endusers opt into topics that can be used for communication such as Marketing subscription lists.", + "description": "Adobe Campaign notification subscriptions allow endusers opt into topics that can be used for communication such as Marketing subscription lists.", "definitions": { "notificationSubscription": { "properties": { "xdm:topicID": { "title": "Topic Identifier", "type": "string", - "description": - "The topic that the enduser has subscribed to and opted into notifications for." + "description": "The topic that the enduser has subscribed to and opted into notifications for." }, "xdm:type": { "title": "Subscription type", @@ -30,21 +28,17 @@ "title": "Subscription Date", "type": "string", "format": "date-time", - "description": - "Date and time when the enduser has subscribed to a notification topic. An end user is subscribed if they have a Subscription Date and the `unsubscriptiondetails/unsubscriptionDate` is empty." + "description": "Date and time when the enduser has subscribed to a notification topic. An end user is subscribed if they have a Subscription Date and the `unsubscriptiondetails/unsubscriptionDate` is empty." }, "xdm:notificationTarget": { "title": "Target/destination for the notification", - "description": - "Target/destination for where to send/receive the notification.", - "$ref": - "https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget" + "description": "Target/destination for where to send/receive the notification.", + "$ref": "https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget" }, "xdm:unsubscriptionDetails": { "title": "Adobe Campaign Notification Unsubscription details", "description": "Adobe Campaign notification unsubscription details.", - "$ref": - "https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails" + "$ref": "https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails" } } }, diff --git a/extensions/adobe/experience/campaign/notificationsubscriptiontarget.schema.json b/extensions/adobe/experience/campaign/notificationsubscriptiontarget.schema.json index 34a071bf6..2acaa1732 100644 --- a/extensions/adobe/experience/campaign/notificationsubscriptiontarget.schema.json +++ b/extensions/adobe/experience/campaign/notificationsubscriptiontarget.schema.json @@ -5,14 +5,12 @@ "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/experience/campaign/notificationsubscriptiontarget", + "$id": "https://ns.adobe.com/experience/campaign/notificationsubscriptiontarget", "$schema": "http://json-schema.org/draft-06/schema#", "title": "Notification subscription target", "type": "object", "meta:extensible": true, - "description": - "Target/destination for where to send/receive the notification.", + "description": "Target/destination for where to send/receive the notification.", "definitions": { "notificationSubscriptionTarget": { "properties": { @@ -20,8 +18,7 @@ "title": "Address", "type": "string", "format": "email", - "description": - "The technical address, e.g 'name@domain.com' as commonly defined in RFC2822 and subsequent standards." + "description": "The technical address, e.g 'name@domain.com' as commonly defined in RFC2822 and subsequent standards." } } } diff --git a/extensions/adobe/experience/campaign/notificationunsubscriptiondetails.schema.json b/extensions/adobe/experience/campaign/notificationunsubscriptiondetails.schema.json index 37c298847..7db8a1094 100644 --- a/extensions/adobe/experience/campaign/notificationunsubscriptiondetails.schema.json +++ b/extensions/adobe/experience/campaign/notificationunsubscriptiondetails.schema.json @@ -5,14 +5,12 @@ "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/experience/campaign/notificationunsubscriptiondetails", + "$id": "https://ns.adobe.com/experience/campaign/notificationunsubscriptiondetails", "$schema": "http://json-schema.org/draft-06/schema#", "title": "Notification unsubscription details", "type": "object", "meta:extensible": true, - "description": - "Adobe Campaign notification unsubscriptions allow endusers opt out after opting into topics that can be used for communication such as Marketing subscription lists.", + "description": "Adobe Campaign notification unsubscriptions allow endusers opt out after opting into topics that can be used for communication such as Marketing subscription lists.", "definitions": { "notificationUnSubscriptionDetails": { "properties": { @@ -20,20 +18,17 @@ "title": "Unsubscription Date", "type": "string", "format": "date-time", - "description": - "Date and time when the enduser has unsubscribed from a notification topic. When the subscription is registered the xdm:unsubscriptionDate must be empty." + "description": "Date and time when the enduser has unsubscribed from a notification topic. When the subscription is registered the xdm:unsubscriptionDate must be empty." }, "xdm:remarkID": { "title": "Remark Identifier", "type": "string", - "description": - "The pre defined remark that the enduser identified when unbsubscribing." + "description": "The pre defined remark that the enduser identified when unbsubscribing." }, "xdm:remarkText": { "title": "Remark text", "type": "string", - "description": - "A customer comment/remark that the enduser provided when unbsubscribing." + "description": "A customer comment/remark that the enduser provided when unbsubscribing." } }, "required": ["xdm:unsubscriptionDate"] diff --git a/extensions/adobe/experience/campaign/profile.schema.json b/extensions/adobe/experience/campaign/profile.schema.json index 5147519f2..55c5b0cf2 100644 --- a/extensions/adobe/experience/campaign/profile.schema.json +++ b/extensions/adobe/experience/campaign/profile.schema.json @@ -21,21 +21,17 @@ "properties": { "xdm:emailScore": { "title": "Journey AI scores for Email Channel", - "$ref": - "https://ns.adobe.com/experience/campaign/journeyaiscores", - "description": - "Journey AI open, click and fatigue scores for email channel" + "$ref": "https://ns.adobe.com/experience/campaign/journeyaiscores", + "description": "Journey AI open, click and fatigue scores for email channel" } } }, "xdm:notificationSubscriptions": { "title": "Adobe Campaign Notification Subscriptions", "type": "array", - "description": - "Adobe Campaign notification subscriptions are used to communicate with endusers that have enrolled for specific notifications.", + "description": "Adobe Campaign notification subscriptions are used to communicate with endusers that have enrolled for specific notifications.", "items": { - "$ref": - "https://ns.adobe.com/experience/campaign/notificationsubscription" + "$ref": "https://ns.adobe.com/experience/campaign/notificationsubscription" } } } diff --git a/extensions/adobe/experience/experienceevent.schema.json b/extensions/adobe/experience/experienceevent.schema.json index c85e21c95..74ae1375c 100644 --- a/extensions/adobe/experience/experienceevent.schema.json +++ b/extensions/adobe/experience/experienceevent.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Adobe Cloud Platform - Data Services extension to ExperienceEvent", "type": "object", - "description": - "This ExperienceEvent XDM includes the core/standard ExperienceEvent as well as the Adobe solution ExperienceEvents.", + "description": "This ExperienceEvent XDM includes the core/standard ExperienceEvent as well as the Adobe solution ExperienceEvents.", "definitions": { "experienceevent": { "properties": { diff --git a/extensions/adobe/experience/implementations.schema.json b/extensions/adobe/experience/implementations.schema.json index 0d0f3d0d7..9e1a44444 100644 --- a/extensions/adobe/experience/implementations.schema.json +++ b/extensions/adobe/experience/implementations.schema.json @@ -7,12 +7,10 @@ ], "$id": "https://ns.adobe.com/experience/implementations", "$schema": "http://json-schema.org/draft-06/schema#", - "title": - "The Adobe Experience Cloud technical implementations details for data collection", + "title": "The Adobe Experience Cloud technical implementations details for data collection", "type": "object", "meta:extends": ["https://ns.adobe.com/xdm/context/experienceevent"], - "description": - "Details the type and version of client implementations for data collection interacting with Adobe Experience Cloud services. Used for debugging and usage analysis.", + "description": "Details the type and version of client implementations for data collection interacting with Adobe Experience Cloud services. Used for debugging and usage analysis.", "properties": { "https://ns.adobe.com/experience/analytics/implementation": { "title": "Client Implementation for Adobe Analytics", @@ -27,8 +25,7 @@ "https://ns.adobe.com/experience/idservice/implementation": { "title": "Client Implementation for Adobe Visitor Service", "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", - "description": - "Client details interacting with Adobe Experience Cloud ID Service." + "description": "Client details interacting with Adobe Experience Cloud ID Service." }, "https://ns.adobe.com/experience/adcloud/implementation": { "title": "Client Implementation for Adobe AdCloud", diff --git a/extensions/adobe/experience/offer-management/capping-constraint.schema.json b/extensions/adobe/experience/offer-management/capping-constraint.schema.json index a9cd72260..59358861e 100644 --- a/extensions/adobe/experience/offer-management/capping-constraint.schema.json +++ b/extensions/adobe/experience/offer-management/capping-constraint.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Capping Constraint", - "description": - "A capping constraint is a component in a personalized offer that defines the parameters for capping. Capping is the process of limiting how many times an offer can be proposed, for an individual profile as well as across all profiles.", + "description": "A capping constraint is a component in a personalized offer that defines the parameters for capping. Capping is the process of limiting how many times an offer can be proposed, for an individual profile as well as across all profiles.", "definitions": { "capping-constraint": { "type": "object", @@ -20,15 +19,13 @@ "xdm:globalCap": { "type": "integer", "title": "Global Cap", - "description": - "Global cap is a constraint on how many times an offer can be proposed in totality.", + "description": "Global cap is a constraint on how many times an offer can be proposed in totality.", "minimum": 1 }, "xdm:profileCap": { "type": "integer", "title": "Profile Cap", - "description": - "Profile cap is a constraint on how many times an offer can be proposed to a certain profile.", + "description": "Profile cap is a constraint on how many times an offer can be proposed to a certain profile.", "minimum": 1 } } diff --git a/extensions/adobe/experience/offer-management/eligibility-rule.example.1.json b/extensions/adobe/experience/offer-management/eligibility-rule.example.1.json index dfd08a745..464a0cc07 100644 --- a/extensions/adobe/experience/offer-management/eligibility-rule.example.1.json +++ b/extensions/adobe/experience/offer-management/eligibility-rule.example.1.json @@ -1,8 +1,7 @@ { "@id": "https://www.example.com/offers/eligibility-rule/rule-0001", "xdm:name": "Californians with one or more purchases of more than $1000", - "xdm:valueAsText": - "homeAddress.stateOrProvince = \"CA\" AND (some x FROM xEvent WHERE commerce.order.priceTotal > 1000 AND x.commerce.order.currencyCode = \"USD\")", + "xdm:valueAsText": "homeAddress.stateOrProvince = \"CA\" AND (some x FROM xEvent WHERE commerce.order.priceTotal > 1000 AND x.commerce.order.currencyCode = \"USD\")", "xdm:value": { "nodeType": "fnApply", "fnName": "and", diff --git a/extensions/adobe/experience/offer-management/eligibility-rule.schema.json b/extensions/adobe/experience/offer-management/eligibility-rule.schema.json index 62a64dfbd..bd7e2075a 100644 --- a/extensions/adobe/experience/offer-management/eligibility-rule.schema.json +++ b/extensions/adobe/experience/offer-management/eligibility-rule.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Eligibility Rule", - "description": - "An eligibility rule is a named reusable predicate used in the domain of audience segmentation and message personalization. The Profile Query Language forms the foundation of those predicates. The predicate operates not only over profile fields but also over contextual data objects provided at the time of decisioning.", + "description": "An eligibility rule is a named reusable predicate used in the domain of audience segmentation and message personalization. The Profile Query Language forms the foundation of those predicates. The predicate operates not only over profile fields but also over contextual data objects provided at the time of decisioning.", "definitions": { "eligibility-rule": { "properties": { @@ -20,36 +19,29 @@ "type": "string", "format": "uri-reference", "title": "ID", - "description": - "The unique identifier of the eligibility rule. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. The @id is used in link relationships. For example an offer's selection constraint object references an eligibility rule object." + "description": "The unique identifier of the eligibility rule. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object. The @id is used in link relationships. For example an offer's selection constraint object references an eligibility rule object." }, "xdm:name": { "type": "string", "title": "Name", - "description": - "Eligibility rule name that is used to locate this object in a search operation" + "description": "Eligibility rule name that is used to locate this object in a search operation" }, "xdm:valueAsText": { "type": "string", "title": "Expression over XDM instances in an alternate query syntax", - "description": - "Contains the expression over a collection of context XDM instances as a serialized string." + "description": "Contains the expression over a collection of context XDM instances as a serialized string." }, "xdm:value": { - "$ref": - "https://ns.adobe.com/experience/offer-management/filter-expression", + "$ref": "https://ns.adobe.com/experience/offer-management/filter-expression", "title": "Expression over XDM instances", - "description": - "Contains the expression tree over a collection of context XDM instances. When the expression evaluates to true the offer refering to this eligibility rule will be included in the decisioning otherwise included. Central context instances include the profile and the experience events associtaed with the profile." + "description": "Contains the expression tree over a collection of context XDM instances. When the expression evaluates to true the offer refering to this eligibility rule will be included in the decisioning otherwise included. Central context instances include the profile and the experience events associtaed with the profile." }, "xdm:modelUsage": { "title": "Used Properties", - "description": - "A list of \"model usage\" objects, one per model, that lists the fully qualified path to every used property from the model.", + "description": "A list of \"model usage\" objects, one per model, that lists the fully qualified path to every used property from the model.", "type": "array", "items": { - "$ref": - "https://ns.adobe.com/experience/offer-management/model-usage" + "$ref": "https://ns.adobe.com/experience/offer-management/model-usage" } } } diff --git a/extensions/adobe/experience/offer-management/fallback-offer.schema.json b/extensions/adobe/experience/offer-management/fallback-offer.schema.json index e13541037..177521998 100644 --- a/extensions/adobe/experience/offer-management/fallback-offer.schema.json +++ b/extensions/adobe/experience/offer-management/fallback-offer.schema.json @@ -12,14 +12,12 @@ "meta:extensible": true, "type": "object", "title": "Fallback Offer", - "description": - "Fallback offer is a default offer used when there is no personalization offer left that satisfies all constraints", + "description": "Fallback offer is a default offer used when there is no personalization offer left that satisfies all constraints", "definitions": { "fallback-offer": { "allOf": [ { - "$ref": - "https://ns.adobe.com/experience/offer-management/offer#/definitions/offer" + "$ref": "https://ns.adobe.com/experience/offer-management/offer#/definitions/offer" } ] } diff --git a/extensions/adobe/experience/offer-management/model-usage.schema.json b/extensions/adobe/experience/offer-management/model-usage.schema.json index 8b6503290..07c4a3969 100644 --- a/extensions/adobe/experience/offer-management/model-usage.schema.json +++ b/extensions/adobe/experience/offer-management/model-usage.schema.json @@ -11,27 +11,23 @@ "meta:extensible": true, "type": "object", "title": "Used XDM Models and Properties from those models", - "description": - "A key-value pair whose key is a reference to the model, i.e. the model's $id property. The value is an array of strings, each string representing a fully qualified path to an XDM field with dots used as the path delimiter.", + "description": "A key-value pair whose key is a reference to the model, i.e. the model's $id property. The value is an array of strings, each string representing a fully qualified path to an XDM field with dots used as the path delimiter.", "definitions": { "model-usage": { "type": "object", "title": "Model and Used Properties", - "description": - "A key-value pair whose key is reference to the model, i.e. the model's $id property. The value is an array of strings, each string representing a fully qualified path to an XDM field with dots used as the path delimiter.", + "description": "A key-value pair whose key is reference to the model, i.e. the model's $id property. The value is an array of strings, each string representing a fully qualified path to an XDM field with dots used as the path delimiter.", "properties": { "xdm:modelReference": { "type": "string", "format": "uri", - "description": - "Reference to the model, i.e. its schema $id property. " + "description": "Reference to the model, i.e. its schema $id property. " }, "xdm:modelPropertyPaths": { "type": "array", "items": { "type": "string", - "description": - "A fully qualified JSON path to an XDM field with dots used as the path delimiter" + "description": "A fully qualified JSON path to an XDM field with dots used as the path delimiter" } } } diff --git a/extensions/adobe/experience/offer-management/offer-activity.schema.json b/extensions/adobe/experience/offer-management/offer-activity.schema.json index 0fccc76a8..52296cc57 100644 --- a/extensions/adobe/experience/offer-management/offer-activity.schema.json +++ b/extensions/adobe/experience/offer-management/offer-activity.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Activity", - "description": - "An offer activity is used to control the decisioning process. It specifies the filter applied to the total inventory to narrow down offers by topic/category, the placement to narrow down the inventory to those offers that technically fit into the reserved space for the offer and specifies a fall back option should the combined constraints disqualify all available personalization options (offers).", + "description": "An offer activity is used to control the decisioning process. It specifies the filter applied to the total inventory to narrow down offers by topic/category, the placement to narrow down the inventory to those offers that technically fit into the reserved space for the offer and specifies a fall back option should the combined constraints disqualify all available personalization options (offers).", "definitions": { "offer-activity": { "properties": { @@ -20,14 +19,12 @@ "type": "string", "format": "uri-reference", "title": "ID", - "description": - "The unique identifier of the offer activity. This @id must be unique across for objects that are not semantically the same, otherwise it is interpreted as referring to the same object. " + "description": "The unique identifier of the offer activity. This @id must be unique across for objects that are not semantically the same, otherwise it is interpreted as referring to the same object. " }, "xdm:name": { "type": "string", "title": "Name", - "description": - "Activity name. The name is displayed in various user interfaces." + "description": "Activity name. The name is displayed in various user interfaces." }, "xdm:status": { "type": "string", @@ -57,22 +54,19 @@ "type": "string", "format": "uri", "title": "Offer Placement", - "description": - "The reference to an offer placement instance. Offer placements are used by offer activities to limit the offer selection to those offers that have a representation that complies with the offer placement restrictions. The value is the URI (@id) of the offer placement that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-placement" + "description": "The reference to an offer placement instance. Offer placements are used by offer activities to limit the offer selection to those offers that have a representation that complies with the offer placement restrictions. The value is the URI (@id) of the offer placement that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-placement" }, "xdm:filter": { "type": "string", "format": "uri", "title": "Offer Filter", - "description": - "The reference to a filter that is applied to the inventory when a decisioning is made the context of this activity. The value is the URI (@id) of the offer filter that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-filter" + "description": "The reference to a filter that is applied to the inventory when a decisioning is made the context of this activity. The value is the URI (@id) of the offer filter that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-filter" }, "xdm:fallback": { "type": "string", "format": "uri", "title": "Fallback Offer", - "description": - "The reference to a fallback offer that is used when decisioning in the context of this activity does not qualify any of the offers specified in the fallback offer. The value is the URI (@id) of the fallback offer that is referenced. See schema https://ns.adobe.com/experience/offer-management/fallback-offer" + "description": "The reference to a fallback offer that is used when decisioning in the context of this activity does not qualify any of the offers specified in the fallback offer. The value is the URI (@id) of the fallback offer that is referenced. See schema https://ns.adobe.com/experience/offer-management/fallback-offer" } } } diff --git a/extensions/adobe/experience/offer-management/offer-filter.schema.json b/extensions/adobe/experience/offer-management/offer-filter.schema.json index a2c04a960..61663ded4 100644 --- a/extensions/adobe/experience/offer-management/offer-filter.schema.json +++ b/extensions/adobe/experience/offer-management/offer-filter.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Offer Filter", - "description": - "Filters are used to specify criteria for offer selection by topic or theme. The most common filter mechanism is by the tags that are associated with an offer. In general the offer filter selects a subset of offers from the overall inventory, not based on the use case for the decisioning.", + "description": "Filters are used to specify criteria for offer selection by topic or theme. The most common filter mechanism is by the tags that are associated with an offer. In general the offer filter selects a subset of offers from the overall inventory, not based on the use case for the decisioning.", "definitions": { "offer-filter": { "properties": { @@ -20,8 +19,7 @@ "type": "string", "format": "uri-reference", "title": "ID", - "description": - "The unique identifier of the filter. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + "description": "The unique identifier of the filter. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." }, "xdm:name": { "type": "string", @@ -29,12 +27,9 @@ "description": "Filter name" }, "xdm:value": { - "$ref": - "https://ns.adobe.com/experience/offer-management/filter-expression", - "title": - "Expression taking offer XDM instances (list of trees) as input", - "description": - "Contains the condition that is used to select offers based on a combination of tags or, directly, using the @id of offers" + "$ref": "https://ns.adobe.com/experience/offer-management/filter-expression", + "title": "Expression taking offer XDM instances (list of trees) as input", + "description": "Contains the condition that is used to select offers based on a combination of tags or, directly, using the @id of offers" } } } diff --git a/extensions/adobe/experience/offer-management/offer-placement.schema.json b/extensions/adobe/experience/offer-management/offer-placement.schema.json index eb2cb31c1..7d0fe6260 100644 --- a/extensions/adobe/experience/offer-management/offer-placement.schema.json +++ b/extensions/adobe/experience/offer-management/offer-placement.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Placement", - "description": - "A placement describes a location or place in a personalized message. It is used to set technical constraints for content that the personalization decision supplies. The placement also represents a request to produce certain types of metrics when an experience event is produced where this placemement is involved. For instance the placement facilitates a personalized clickable image inside an email shown to an end user. The placement may for instance request from the assembled experience that the click on its image gets reported in an experience event with a metric `https://ns.adobe.com/xdm/data/metrics/web/linkclicks` and a reference to this placement. ", + "description": "A placement describes a location or place in a personalized message. It is used to set technical constraints for content that the personalization decision supplies. The placement also represents a request to produce certain types of metrics when an experience event is produced where this placemement is involved. For instance the placement facilitates a personalized clickable image inside an email shown to an end user. The placement may for instance request from the assembled experience that the click on its image gets reported in an experience event with a metric `https://ns.adobe.com/xdm/data/metrics/web/linkclicks` and a reference to this placement. ", "definitions": { "offer-placement": { "properties": { @@ -20,45 +19,37 @@ "type": "string", "format": "uri-reference", "title": "ID", - "description": - "The unique identifier of the placement. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + "description": "The unique identifier of the placement. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." }, "xdm:name": { "type": "string", "title": "Name", - "description": - "An assigned name for the placement to refer to it in human interactions" + "description": "An assigned name for the placement to refer to it in human interactions" }, "xdm:description": { "type": "string", "title": "Description", - "description": - "Placement description. It is used to convey human readable intentions on how dynamic content is used in the overall message delivery. That a certain space is a \"Banner\" in a web page is often conveyed via the description and not by a formal method." + "description": "Placement description. It is used to convey human readable intentions on how dynamic content is used in the overall message delivery. That a certain space is a \"Banner\" in a web page is often conveyed via the description and not by a formal method." }, "xdm:channel": { "type": "string", "format": "uri", "title": "Communication Channel", - "description": - "A reference to the channel entity. The channel indicates where the dynamic content is intended to be delivered. The channel constraint is used to convey not only where the offer will be used but also to determine the content editor or validator that is used for the experience. See 'https://ns.adobe.com/xdm/channels/channel'" + "description": "A reference to the channel entity. The channel indicates where the dynamic content is intended to be delivered. The channel constraint is used to convey not only where the offer will be used but also to determine the content editor or validator that is used for the experience. See 'https://ns.adobe.com/xdm/channels/channel'" }, "xdm:componentType": { - "$ref": - "https://ns.adobe.com/experience/offer-management/offer-representation#/definitions/content-component-type", + "$ref": "https://ns.adobe.com/experience/offer-management/offer-representation#/definitions/content-component-type", "title": "Content Type", - "description": - "A constraint for the content that can be shown in the place described by this placement. Component Types are: image, html or plain text" + "description": "A constraint for the content that can be shown in the place described by this placement. Component Types are: image, html or plain text" }, "xdm:contentTypes": { "type": "array", "items": { "type": "string", "title": "MIME Media Type", - "description": - "[Multipurpose Internet Mail Extensions (MIME)](https://tools.ietf.org/html/rfc2046)", + "description": "[Multipurpose Internet Mail Extensions (MIME)](https://tools.ietf.org/html/rfc2046)", "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?", - "description": - "A constraint for the media type of the components that is expected in that placement. There could be more than one media type possible for one component such as different image format." + "description": "A constraint for the media type of the components that is expected in that placement. There could be more than one media type possible for one component such as different image format." } } } diff --git a/extensions/adobe/experience/offer-management/offer-representation.example.1.json b/extensions/adobe/experience/offer-management/offer-representation.example.1.json index 8433b988b..10043fb11 100644 --- a/extensions/adobe/experience/offer-management/offer-representation.example.1.json +++ b/extensions/adobe/experience/offer-management/offer-representation.example.1.json @@ -1,8 +1,7 @@ { "xdm:components": [ { - "@type": - "https://ns.adobe.com/experience/offer-management/content-component-text", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", "dc:format": "text/template", "dc:language": [ "en", @@ -19,33 +18,25 @@ ], "repo:name": "expiration_message_en", "repo:id": "urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e", - "repo:resolveURL": - "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name=expiration_message_en", - "xdm:copyline": - "Dear Madam {{profile.person.lastName}}, the offer expires 12/6/2018" + "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name=expiration_message_en", + "xdm:copyline": "Dear Madam {{profile.person.lastName}}, the offer expires 12/6/2018" }, { - "@type": - "https://ns.adobe.com/experience/offer-management/content-component-text", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", "dc:format": "text/template", "dc:language": ["en-US"], "repo:name": "expiration_message_en-US", "repo:id": "urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e", - "repo:resolveURL": - "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name="expiration_message_en-US"", - "xdm:copyline": - "Dear Madam {{profile.person.lastName}}, the offer expires 6/12/2018" + "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name="expiration_message_en-US"", + "xdm:copyline": "Dear Madam {{profile.person.lastName}}, the offer expires 6/12/2018" }, { - "@type": - "https://ns.adobe.com/experience/offer-management/content-component-text", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", "dc:format": "text/template", "dc:language": ["es"], "repo:name": "expiration_message_es", - "repo:resolveURL": - "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name="expiration_message_es"", - "xdm:copyline": - "Estimada seΓ±ora {{profile.person.lastName}}: La oferta vence el 12/6/2018" + "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805efef0c9e"&resource="api:metadata/application"&name="expiration_message_es"", + "xdm:copyline": "Estimada seΓ±ora {{profile.person.lastName}}: La oferta vence el 12/6/2018" } ], "xdm:placement": "uri:xcore:placement-0001", diff --git a/extensions/adobe/experience/offer-management/offer-representation.example.2.json b/extensions/adobe/experience/offer-management/offer-representation.example.2.json index 115cf0b7f..8816c038a 100644 --- a/extensions/adobe/experience/offer-management/offer-representation.example.2.json +++ b/extensions/adobe/experience/offer-management/offer-representation.example.2.json @@ -1,14 +1,12 @@ { "xdm:components": [ { - "@type": - "https://ns.adobe.com/experience/offer-management/content-component-imagelink", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-imagelink", "dc:format": "image/png", "dc:language": ["en"], "repo:name": "holidayOffer.2018.png", "repo:id": "urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805eff8a69e", - "repo:resolveURL": - "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805eff8a69e"", + "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:VA7:6dc33479-13ca-4b19-b25d-c805eff8a69e"", "xdm:linkURL": "https://www.mycompany.com/product?trackId=12345" } ], diff --git a/extensions/adobe/experience/offer-management/offer-representation.example.3.json b/extensions/adobe/experience/offer-management/offer-representation.example.3.json index c2a7d51fd..dac128bc1 100644 --- a/extensions/adobe/experience/offer-management/offer-representation.example.3.json +++ b/extensions/adobe/experience/offer-management/offer-representation.example.3.json @@ -1,14 +1,12 @@ { "xdm:components": [ { - "@type": - "https://ns.adobe.com/experience/offer-management/content-component-html", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-html", "dc:format": "text/html", "dc:language": ["de"], "repo:name": "widget_quickbooking.html", "repo:id": "urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc", - "repo:resolveURL": - "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc"" + "repo:resolveURL": "https://platform-cs-stage.adobe.io/content/directory/resolve?asset_id="urn:aaid:sc:NLD2:0567c1d6-4fdc-4541-b736-f62934fcb5fc"" } ], "xdm:placement": "uri:xcore:placement-0001", diff --git a/extensions/adobe/experience/offer-management/offer-representation.schema.json b/extensions/adobe/experience/offer-management/offer-representation.schema.json index 78f35a8d4..acedeeb8b 100644 --- a/extensions/adobe/experience/offer-management/offer-representation.schema.json +++ b/extensions/adobe/experience/offer-management/offer-representation.schema.json @@ -6,8 +6,7 @@ "of the License at https://creativecommons.org/licenses/by/4.0/" ], "$schema": "http://json-schema.org/draft-06/schema#", - "$id": - "https://ns.adobe.com/experience/offer-management/offer-representation", + "$id": "https://ns.adobe.com/experience/offer-management/offer-representation", "meta:abstract": false, "meta:extensible": true, "type": "object", @@ -18,8 +17,7 @@ "properties": { "xdm:components": { "type": "array", - "description": - "The content components of the offer representation, including all their language variants. Specific components are found by 'dx:format', 'dc:subject' and 'dc:language' or a combination thereof. This metadata is used to locate or represent the content that is associated with an offer and integrate it according to the placement contract.", + "description": "The content components of the offer representation, including all their language variants. Specific components are found by 'dx:format', 'dc:subject' and 'dc:language' or a combination thereof. This metadata is used to locate or represent the content that is associated with an offer and integrate it according to the placement contract.", "items": { "$ref": "#/definitions/content-component" } @@ -28,15 +26,13 @@ "type": "string", "format": "uri", "title": "Channel", - "description": - "The channel constraint is used to convey not only where the offer will be used but determine the content editor or validator that is used for the offer's representation. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'" + "description": "The channel constraint is used to convey not only where the offer will be used but determine the content editor or validator that is used for the offer's representation. The value is a valid Channel URI. See 'https://ns.adobe.com/xdm/channels/channel'" }, "xdm:placement": { "type": "string", "format": "uri", "title": "Placement", - "description": - "Placement to comply with. The value is the URI (@id) of the offer placement that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-placement" + "description": "Placement to comply with. The value is the URI (@id) of the offer placement that is referenced. See schema https://ns.adobe.com/experience/offer-management/offer-placement" } } }, @@ -51,28 +47,23 @@ "https://ns.adobe.com/experience/offer-management/content-component-imagelink" ], "meta:enum": { - "https://ns.adobe.com/experience/offer-management/content-component-text": - "Text component", - "https://ns.adobe.com/experience/offer-management/content-component-html": - "HTML component", - "https://ns.adobe.com/experience/offer-management/content-component-imagelink": - "Image and click link component" + "https://ns.adobe.com/experience/offer-management/content-component-text": "Text component", + "https://ns.adobe.com/experience/offer-management/content-component-html": "HTML component", + "https://ns.adobe.com/experience/offer-management/content-component-imagelink": "Image and click link component" } }, "content-component": { "allOf": [ { "type": "object", - "description": - "Content components are the fragments associated with the a particular offer representation. Those fragments are used to compose the end-user experience. The content resource has optional HAL links to the file resource.", + "description": "Content components are the fragments associated with the a particular offer representation. Those fragments are used to compose the end-user experience. The content resource has optional HAL links to the file resource.", "meta:extends": [ "https://ns.adobe.com/xdm/external/hal/resource#/definitions/hal" ], "properties": { "@type": { "$ref": "#/definitions/content-component-type", - "description": - "Type of the component. Acts as processing hint for the client. When the experience is assembled the composer will look for the component(s) that have a specific type." + "description": "Type of the component. Acts as processing hint for the client. When the experience is assembled the composer will look for the component(s) that have a specific type." }, "dc:format": { "meta:usereditable": false, @@ -80,8 +71,7 @@ "title": "Format", "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?", "examples": ["application/vnd.adobe.photoshop"], - "description": - "The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats)." + "description": "The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats)." }, "dc:language": { "meta:usereditable": false, @@ -89,24 +79,20 @@ "title": "Language", "items": { "type": "string", - "pattern": - "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$" }, - "description": - "The language or languages of the resource.\nLanguages are specified in language code as defined in [IETF RFC 3066](https://www.ietf.org/rfc/rfc3066.txt), which is part of BCP 47, which is used elsewhere in XDM.", + "description": "The language or languages of the resource.\nLanguages are specified in language code as defined in [IETF RFC 3066](https://www.ietf.org/rfc/rfc3066.txt), which is part of BCP 47, which is used elsewhere in XDM.", "examples": ["\n", "pt-BR", "es-ES"] }, "repo:name": { "type": "string", - "description": - "Some hint about where to locate the repository that stores the external asset by the \"repo:id\"." + "description": "Some hint about where to locate the repository that stores the external asset by the \"repo:id\"." }, "repo:id": { "type": "string", "meta:immutable": true, "meta:usereditable": false, - "description": - "An optional unique identifier to reference the asset in a content repository. When Platform APIs are used to retrieve the representation the client can expect an addtional propery \"repo:resolveUrl\" to retrieve the asset.", + "description": "An optional unique identifier to reference the asset in a content repository. When Platform APIs are used to retrieve the representation the client can expect an addtional propery \"repo:resolveUrl\" to retrieve the asset.", "examples": [ "urn:aaid:sc:US:6dc33479-13ca-4b19-b25d-c805eff8a69e" ] @@ -116,8 +102,7 @@ "format": "uri", "meta:immutable": true, "meta:usereditable": false, - "description": - "An optional unique resource locator to read the asset in a content repository. This will make it easier to obtain the asset whithout the client understanding where the asset is manages and what APIs to call. This is similar to a HAL link but the semantic is simpler and more pursposeful.", + "description": "An optional unique resource locator to read the asset in a content repository. This will make it easier to obtain the asset whithout the client understanding where the asset is manages and what APIs to call. This is similar to a HAL link but the semantic is simpler and more pursposeful.", "examples": [ "https://plaftform.adobe.io/resolveByPath?path="/mycorp/content/projectx/fragment/prod/herobanners/banner14.html3"" ] diff --git a/extensions/adobe/experience/offer-management/offer.example.1.json b/extensions/adobe/experience/offer-management/offer.example.1.json index 68b2f6441..d30147214 100644 --- a/extensions/adobe/experience/offer-management/offer.example.1.json +++ b/extensions/adobe/experience/offer-management/offer.example.1.json @@ -7,8 +7,7 @@ "xdm:components": [ { "xdm:text": "You can always get what you want!", - "@type": - "https://ns.adobe.com/experience/offer-management/content-component-text", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", "dc:format": "text/template" } ], diff --git a/extensions/adobe/experience/offer-management/offer.schema.json b/extensions/adobe/experience/offer-management/offer.schema.json index e2e8a41df..89d5f5899 100644 --- a/extensions/adobe/experience/offer-management/offer.schema.json +++ b/extensions/adobe/experience/offer-management/offer.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Offer", - "description": - "This is the base concept for offers that are used for personalization and those that serve as fallback choices when none of offers for personalization qualify at within the given context.", + "description": "This is the base concept for offers that are used for personalization and those that serve as fallback choices when none of offers for personalization qualify at within the given context.", "definitions": { "offer": { "properties": { @@ -20,20 +19,17 @@ "type": "string", "format": "uri-reference", "title": "ID", - "description": - "The unique identifier of the offer. It must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + "description": "The unique identifier of the offer. It must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." }, "xdm:name": { "type": "string", "title": "Name", - "description": - "The offer's name. A human readable string to find one or more offers." + "description": "The offer's name. A human readable string to find one or more offers." }, "xdm:status": { "type": "string", "title": "Status", - "description": - "Offer Status allows user workflows to be conducted with offers. The status may affect where an offer is visible or considered relevant. Status changes are driven by the clients or services that use offers.", + "description": "Offer Status allows user workflows to be conducted with offers. The status may affect where an offer is visible or considered relevant. Status changes are driven by the clients or services that use offers.", "enum": ["draft", "pending", "rejected", "approved", "archived"], "meta:enum": { "draft": "Draft", @@ -46,24 +42,20 @@ "xdm:tags": { "type": "array", "title": "Tags", - "description": - "The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overal offer inventory to a topical sub set (category).", + "description": "The set of tags associated with this offer. The tags are used in offer filter expressions to constrain the overal offer inventory to a topical sub set (category).", "items": { "type": "string", "format": "uri", - "description": - "An identifier of a Tag object. The value is the @id of the Tag that is referenced. See Tag schema https://ns.adobe.com/experience/offer-management/tag" + "description": "An identifier of a Tag object. The value is the @id of the Tag that is referenced. See Tag schema https://ns.adobe.com/experience/offer-management/tag" } }, "xdm:representations": { "type": "array", "items": { - "$ref": - "https://ns.adobe.com/experience/offer-management/offer-representation" + "$ref": "https://ns.adobe.com/experience/offer-management/offer-representation" }, "title": "Representations", - "description": - "Offer representations for different content variants. A single offer can have multiple contents variants. An Offer Representation is the object that connects Offers to Content. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels (or a particular medium). " + "description": "Offer representations for different content variants. A single offer can have multiple contents variants. An Offer Representation is the object that connects Offers to Content. Content is information that is directed towards an audience for consumption in a (digital) experience. Content is delivered through channels (or a particular medium). " }, "xdm:customMetadata": { "type": "object", @@ -73,8 +65,7 @@ } }, "title": "Custom Properties", - "description": - "Custom metadata is a key-value map that allows the end-users to attach properties to individual offer instances. Any string can be used as a key name, the values are also strings." + "description": "Custom metadata is a key-value map that allows the end-users to attach properties to individual offer instances. Any string can be used as a key name, the values are also strings." } } } diff --git a/extensions/adobe/experience/offer-management/personalized-offer.example.1.json b/extensions/adobe/experience/offer-management/personalized-offer.example.1.json index d145e6990..5140fbfce 100644 --- a/extensions/adobe/experience/offer-management/personalized-offer.example.1.json +++ b/extensions/adobe/experience/offer-management/personalized-offer.example.1.json @@ -7,8 +7,7 @@ "xdm:components": [ { "xdm:text": "You can always get what you want!", - "@type": - "https://ns.adobe.com/experience/offer-management/content-component-text", + "@type": "https://ns.adobe.com/experience/offer-management/content-component-text", "dc:format": "text/template" } ], diff --git a/extensions/adobe/experience/offer-management/personalized-offer.schema.json b/extensions/adobe/experience/offer-management/personalized-offer.schema.json index f8b39ff02..5201aea58 100644 --- a/extensions/adobe/experience/offer-management/personalized-offer.schema.json +++ b/extensions/adobe/experience/offer-management/personalized-offer.schema.json @@ -12,8 +12,7 @@ "meta:extensible": true, "type": "object", "title": "Adobe Experience Cloud Personalized Offer", - "description": - "A personalized offer is the conceptual entity that is chosen during the decisioning process. The objective for decisioning is to take a large inventory of content items and apply numerous constraint rules to that inventory to first narrow it down and then rank the qualifying options. The outcome modifies the overall experience to accommodate specific individuals, sometimes tied to groups or segments of individuals.", + "description": "A personalized offer is the conceptual entity that is chosen during the decisioning process. The objective for decisioning is to take a large inventory of content items and apply numerous constraint rules to that inventory to first narrow it down and then rank the qualifying options. The outcome modifies the overall experience to accommodate specific individuals, sometimes tied to groups or segments of individuals.", "definitions": { "personalized-offer": { "allOf": [ @@ -22,28 +21,22 @@ "xdm:rank": { "$ref": "https://ns.adobe.com/experience/offer-management/rank", "title": "Rank", - "description": - "Offer Rank (priority). Defines what is considered the \"best offer\" given the context of the decision. Among all the Offers that have not been disqualified due other constraints, the ranking will decide top (or top N) offers to be proposed." + "description": "Offer Rank (priority). Defines what is considered the \"best offer\" given the context of the decision. Among all the Offers that have not been disqualified due other constraints, the ranking will decide top (or top N) offers to be proposed." }, "xdm:selectionConstraint": { - "$ref": - "https://ns.adobe.com/experience/offer-management/selection-constraint", + "$ref": "https://ns.adobe.com/experience/offer-management/selection-constraint", "title": "Selection Constraints", - "description": - "Selection constraints define all rules that decide if an offer disqualifies from the set of eligible offers at this moment, for this context and/or for this profile identity. For example, offers tyically have a start and end date before and after they are not eligible for consideration anymore" + "description": "Selection constraints define all rules that decide if an offer disqualifies from the set of eligible offers at this moment, for this context and/or for this profile identity. For example, offers tyically have a start and end date before and after they are not eligible for consideration anymore" }, "xdm:cappingConstraint": { - "$ref": - "https://ns.adobe.com/experience/offer-management/capping-constraint", + "$ref": "https://ns.adobe.com/experience/offer-management/capping-constraint", "title": "Capping Constaints", - "description": - "Capping constraint define additional rules based on prior offer proposition, either across all audiences or for a partcular profile identity." + "description": "Capping constraint define additional rules based on prior offer proposition, either across all audiences or for a partcular profile identity." } } }, { - "$ref": - "https://ns.adobe.com/experience/offer-management/offer#/definitions/offer" + "$ref": "https://ns.adobe.com/experience/offer-management/offer#/definitions/offer" } ] } diff --git a/extensions/adobe/experience/offer-management/primary-key.descriptors.json b/extensions/adobe/experience/offer-management/primary-key.descriptors.json index b08c5fb7d..bb1551e07 100644 --- a/extensions/adobe/experience/offer-management/primary-key.descriptors.json +++ b/extensions/adobe/experience/offer-management/primary-key.descriptors.json @@ -6,52 +6,42 @@ "of the License at https://creativecommons.org/licenses/by/4.0/" ], "title": "Primary key descriptors for the Offer Management Domain", - "description": - "Contains descriptors to define the properties holding the primary key (entity identifiers) in the Offer Management domain", + "description": "Contains descriptors to define the properties holding the primary key (entity identifiers) in the Offer Management domain", "meta:descriptors": [ { "@type": "xdm:primaryKey", - "@id": - "https://ns.adobe.com/experience/offer-management/eligibility-rule/id", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/eligibility-rule", + "@id": "https://ns.adobe.com/experience/offer-management/eligibility-rule/id", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/eligibility-rule", "xdm:sourceProperty": "@id" }, { "@type": "xdm:primaryKey", "@id": "https://ns.adobe.com/experience/offer-management/offer/id", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer", "xdm:sourceProperty": "@id" }, { "@type": "xdm:primaryKey", - "@id": - "https://ns.adobe.com/experience/offer-management/offer-activity/id", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer-activity", + "@id": "https://ns.adobe.com/experience/offer-management/offer-activity/id", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer-activity", "xdm:sourceProperty": "@id" }, { "@type": "xdm:primaryKey", "@id": "https://ns.adobe.com/experience/offer-management/offer-filter/id", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer-filter", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer-filter", "xdm:sourceProperty": "@id" }, { "@type": "xdm:primaryKey", - "@id": - "https://ns.adobe.com/experience/offer-management/offer-placement/id", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer-placement", + "@id": "https://ns.adobe.com/experience/offer-management/offer-placement/id", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer-placement", "xdm:sourceProperty": "@id" }, { "@type": "xdm:primaryKey", "@id": "https://ns.adobe.com/experience/offer-management/tag/id", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/tag", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/tag", "xdm:sourceProperty": "@id" } ] diff --git a/extensions/adobe/experience/offer-management/rank.schema.json b/extensions/adobe/experience/offer-management/rank.schema.json index e01706363..79eb5a631 100644 --- a/extensions/adobe/experience/offer-management/rank.schema.json +++ b/extensions/adobe/experience/offer-management/rank.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Offer Rank", - "description": - "Offer rank (priority) represents the default order in which one offer is selected over another in case there is no profile specific ranking order known. If after comparing the priority value two or more offers are still tied one is chosen at random and used in the offer proposition.", + "description": "Offer rank (priority) represents the default order in which one offer is selected over another in case there is no profile specific ranking order known. If after comparing the priority value two or more offers are still tied one is chosen at random and used in the offer proposition.", "definitions": { "rank": { "properties": { diff --git a/extensions/adobe/experience/offer-management/relationship.descriptors.json b/extensions/adobe/experience/offer-management/relationship.descriptors.json index 325ec736e..5d42f5ad2 100644 --- a/extensions/adobe/experience/offer-management/relationship.descriptors.json +++ b/extensions/adobe/experience/offer-management/relationship.descriptors.json @@ -6,73 +6,54 @@ "of the License at https://creativecommons.org/licenses/by/4.0/" ], "title": "Relationship descriptors for Offer Management Domain", - "description": - "Contains descriptors to define all the relationships between entities in the Offer Management domain", + "description": "Contains descriptors to define all the relationships between entities in the Offer Management domain", "meta:descriptors": [ { - "@id": - "https://ns.adobe.com/experience/offer-management/relationships/offer-activity/restricts-to-placement", + "@id": "https://ns.adobe.com/experience/offer-management/relationships/offer-activity/restricts-to-placement", "@type": "xdm:oneToMany", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer-activity", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer-activity", "xdm:sourceProperty": "xdm:placement", - "xdm:destinationSchema": - "https://ns.adobe.com/experience/offer-management/offer-representation", + "xdm:destinationSchema": "https://ns.adobe.com/experience/offer-management/offer-representation", "xdm:destinationProperty": "@id" }, { - "@id": - "https://ns.adobe.com/experience/offer-management/relationships/offer-activity/uses-filter", + "@id": "https://ns.adobe.com/experience/offer-management/relationships/offer-activity/uses-filter", "@type": "xdm:oneToMany", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer-activity", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer-activity", "xdm:sourceProperty": "xdm:filter", - "xdm:destinationSchema": - "https://ns.adobe.com/experience/offer-management/offer-filter", + "xdm:destinationSchema": "https://ns.adobe.com/experience/offer-management/offer-filter", "xdm:destinationProperty": "@id" }, { - "@id": - "https://ns.adobe.com/experience/offer-management/relationships/offer-activity/uses-fallback-offer", + "@id": "https://ns.adobe.com/experience/offer-management/relationships/offer-activity/uses-fallback-offer", "@type": "xdm:oneToMany", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer-activity", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer-activity", "xdm:sourceProperty": "xdm:fallback", - "xdm:destinationSchema": - "https://ns.adobe.com/experience/offer-management/fallback-offer", + "xdm:destinationSchema": "https://ns.adobe.com/experience/offer-management/fallback-offer", "xdm:destinationProperty": "@id" }, { - "@id": - "https://ns.adobe.com/experience/offer-management/relationships/offer/complies-with-placement", + "@id": "https://ns.adobe.com/experience/offer-management/relationships/offer/complies-with-placement", "@type": "xdm:manyToMany", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer", "xdm:sourceProperty": "xdm:representations[*].xdm:placement", - "xdm:destinationSchema": - "https://ns.adobe.com/experience/offer-management/offer-placement", + "xdm:destinationSchema": "https://ns.adobe.com/experience/offer-management/offer-placement", "xdm:destinationProperty": "@id" }, { - "@id": - "https://ns.adobe.com/experience/offer-management/relationships/offer/uses-tags", + "@id": "https://ns.adobe.com/experience/offer-management/relationships/offer/uses-tags", "@type": "xdm:manyToMany", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/offer", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/offer", "xdm:sourceProperty": "xdm:tags[*]", - "xdm:destinationSchema": - "https://ns.adobe.com/experience/offer-management/tag", + "xdm:destinationSchema": "https://ns.adobe.com/experience/offer-management/tag", "xdm:destinationProperty": "@id" }, { - "@id": - "https://ns.adobe.com/experience/offer-management/relationships/personalized-offer/uses-eligibility-rule", + "@id": "https://ns.adobe.com/experience/offer-management/relationships/personalized-offer/uses-eligibility-rule", "@type": "xdm:oneToMany", - "xdm:sourceSchema": - "https://ns.adobe.com/experience/offer-management/personalized-offer", + "xdm:sourceSchema": "https://ns.adobe.com/experience/offer-management/personalized-offer", "xdm:sourceProperty": "xdm:selectionConstraint.xdm:eligibilityRule", - "xdm:destinationSchema": - "https://ns.adobe.com/experience/offer-management/eligibility-rule", + "xdm:destinationSchema": "https://ns.adobe.com/experience/offer-management/eligibility-rule", "xdm:destinationProperty": "@id" } ] diff --git a/extensions/adobe/experience/offer-management/selection-constraint.schema.json b/extensions/adobe/experience/offer-management/selection-constraint.schema.json index fa7ecaa92..c853e1f0b 100644 --- a/extensions/adobe/experience/offer-management/selection-constraint.schema.json +++ b/extensions/adobe/experience/offer-management/selection-constraint.schema.json @@ -6,14 +6,12 @@ "of the License at https://creativecommons.org/licenses/by/4.0/" ], "$schema": "http://json-schema.org/draft-06/schema#", - "$id": - "https://ns.adobe.com/experience/offer-management/selection-constraint", + "$id": "https://ns.adobe.com/experience/offer-management/selection-constraint", "meta:abstract": false, "meta:extensible": true, "type": "object", "title": "Offer Selection Constraint", - "description": - "Offer Selection Constraint specify conditions that have to be met in order for an offer to be included in weighing the best offer. Those constraints can have many aspects, ranging from date constraints over rules applied to the user profile fields to rules checked against contextual data available at decision time.", + "description": "Offer Selection Constraint specify conditions that have to be met in order for an offer to be included in weighing the best offer. Those constraints can have many aspects, ranging from date constraints over rules applied to the user profile fields to rules checked against contextual data available at decision time.", "definitions": { "selection-constraint": { "properties": { @@ -21,22 +19,19 @@ "type": "string", "format": "date-time", "title": "Start Date", - "description": - "Offer start date. Offers that have not reached their start date are not yet considered eligible in the decisioning." + "description": "Offer start date. Offers that have not reached their start date are not yet considered eligible in the decisioning." }, "xdm:endDate": { "type": "string", "format": "date-time", "title": "End Date", - "description": - "Offer end date. Offers that have passed their end date are no longer considered eligible in the decisioning process." + "description": "Offer end date. Offers that have passed their end date are no longer considered eligible in the decisioning process." }, "xdm:eligibilityRule": { "type": "string", "format": "uri", "title": "Eligibility Rule", - "description": - "The reference to an eligibility rule that tests a condition using the profile and/or other contextual XDM instances. The value is the URI (@id) of the eligibility rule that is referenced. See schema https://ns.adobe.com/experience/offer-management/eligibility-rule" + "description": "The reference to an eligibility rule that tests a condition using the profile and/or other contextual XDM instances. The value is the URI (@id) of the eligibility rule that is referenced. See schema https://ns.adobe.com/experience/offer-management/eligibility-rule" } } } diff --git a/extensions/adobe/experience/offer-management/tag.schema.json b/extensions/adobe/experience/offer-management/tag.schema.json index d750f2c60..d97a5ad18 100644 --- a/extensions/adobe/experience/offer-management/tag.schema.json +++ b/extensions/adobe/experience/offer-management/tag.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "type": "object", "title": "Tag", - "description": - "A Tag is a keyword or term assigned to a piece of information. Tags in this domain are reusable, searchable and identifiable keywords, i.e. their identity gets attached to other objects not simply the string that is used for human consumption. Therefore the same tag could have multiple, human readable representations. Tags can also be classified or arranged in an order that conveys additional semantics. This semantics is, however, not specified in this domain.", + "description": "A Tag is a keyword or term assigned to a piece of information. Tags in this domain are reusable, searchable and identifiable keywords, i.e. their identity gets attached to other objects not simply the string that is used for human consumption. Therefore the same tag could have multiple, human readable representations. Tags can also be classified or arranged in an order that conveys additional semantics. This semantics is, however, not specified in this domain.", "definitions": { "tag": { "properties": { @@ -20,14 +19,12 @@ "type": "string", "format": "uri-reference", "title": "ID", - "description": - "The unique identifier of the Tag. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." + "description": "The unique identifier of the Tag. This identifier is assigned by clients or services that use the repository and is not generated by the repository itself. This @id must be unique within a repository container for objects that are not the same, otherwise it is interpreted as referring to the same object." }, "xdm:name": { "type": "string", "title": "Tag Name", - "description": - "The Tag's external human-readable representation to the clients." + "description": "The Tag's external human-readable representation to the clients." } } } diff --git a/extensions/adobe/experience/profile/experienceevent.schema.json b/extensions/adobe/experience/profile/experienceevent.schema.json index 92dc889d3..9c881de3d 100644 --- a/extensions/adobe/experience/profile/experienceevent.schema.json +++ b/extensions/adobe/experience/profile/experienceevent.schema.json @@ -10,16 +10,14 @@ "title": "Unified Profile Service extension to ExperienceEvent", "type": "object", "meta:extends": ["https://ns.adobe.com/xdm/context/experienceevent"], - "description": - "Adobe Experience Cloud - Profile Service extensions to Experience Event.", + "description": "Adobe Experience Cloud - Profile Service extensions to Experience Event.", "definitions": { "experienceevent": { "properties": { "https://ns.adobe.com/experience/profile/originDatasetID": { "title": "Origin Dataset ID", "type": "string", - "description": - "Identity of the Dataset that the Profile Service ingested the data from. Usage is reserved for the Profile Service." + "description": "Identity of the Dataset that the Profile Service ingested the data from. Usage is reserved for the Profile Service." } } } diff --git a/extensions/adobe/experience/target/activity.schema.json b/extensions/adobe/experience/target/activity.schema.json index f48282fd0..9e9fd1f22 100644 --- a/extensions/adobe/experience/target/activity.schema.json +++ b/extensions/adobe/experience/target/activity.schema.json @@ -9,22 +9,19 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Adobe Target Activity", "type": "object", - "description": - "An Adobe Target Activity compares two or more experiences against the success metrics that are specified for choosing the experience that is most likely to provide the optimal results", + "description": "An Adobe Target Activity compares two or more experiences against the success metrics that are specified for choosing the experience that is most likely to provide the optimal results", "definitions": { "activity": { "properties": { "xdm:activityID": { "title": "Activity Identifier", "type": "string", - "description": - "Unique identity of an Adobe Target Activity. This identifier can be used in activity APIs offered by Adobe Target." + "description": "Unique identity of an Adobe Target Activity. This identifier can be used in activity APIs offered by Adobe Target." }, "xdm:version": { "title": "Activity Version", "type": "string", - "description": - "Version of the activity that processed this given experience event." + "description": "Version of the activity that processed this given experience event." }, "https://ns.adobe.com/experience/target/activity/preview": { "$ref": "https://ns.adobe.com/experience/target/activity/preview" @@ -32,8 +29,7 @@ "xdm:activityEvents": { "type": "array", "items": { - "$ref": - "https://ns.adobe.com/experience/target/activity/activityevent" + "$ref": "https://ns.adobe.com/experience/target/activity/activityevent" } } }, diff --git a/extensions/adobe/experience/target/experienceevent.example.1.json b/extensions/adobe/experience/target/experienceevent.example.1.json index ab16d4e6c..90c807d41 100644 --- a/extensions/adobe/experience/target/experienceevent.example.1.json +++ b/extensions/adobe/experience/target/experienceevent.example.1.json @@ -1,11 +1,8 @@ { - "https://ns.adobe.com/experience/target/clientcode": - "773baa41-4afd-4c4e-9178-1547f58e07bd", + "https://ns.adobe.com/experience/target/clientcode": "773baa41-4afd-4c4e-9178-1547f58e07bd", "https://ns.adobe.com/experience/target/mboxname": "orderConfirmPage", "https://ns.adobe.com/experience/target/mboxversion": "v60", - "https://ns.adobe.com/experience/target/sessionid": - "94ef199f-85e6-4e33-9a58-0e4162486714", - "https://ns.adobe.com/experience/target/pagedetail/pageid": - "http://data.adobe.com/experience/target/pagedetail/pageid/b1ba48aa-291f-4f94-bc65-a260150648a1", + "https://ns.adobe.com/experience/target/sessionid": "94ef199f-85e6-4e33-9a58-0e4162486714", + "https://ns.adobe.com/experience/target/pagedetail/pageid": "http://data.adobe.com/experience/target/pagedetail/pageid/b1ba48aa-291f-4f94-bc65-a260150648a1", "https://ns.adobe.com/experience/target/pagedetail/pagescore": 100 } diff --git a/extensions/adobe/experience/target/experienceevent.schema.json b/extensions/adobe/experience/target/experienceevent.schema.json index 9ebe5603b..8dff891d7 100644 --- a/extensions/adobe/experience/target/experienceevent.schema.json +++ b/extensions/adobe/experience/target/experienceevent.schema.json @@ -48,8 +48,7 @@ "https://ns.adobe.com/experience/target/environmentID": { "title": "Environment Identifier", "type": "string", - "description": - "Identifier of the environment on which the event was processed." + "description": "Identifier of the environment on which the event was processed." }, "https://ns.adobe.com/experience/target/activities": { "title": "Activities", @@ -61,8 +60,7 @@ }, "https://ns.adobe.com/experience/target/supplementalDataID": { "title": "Supplemental Data Identifier", - "description": - "Identifier used to stitch Target events with Analytics events", + "description": "Identifier used to stitch Target events with Analytics events", "type": "string" } } diff --git a/meta.schema.json b/meta.schema.json index 4985abd08..027386c5a 100644 --- a/meta.schema.json +++ b/meta.schema.json @@ -40,8 +40,7 @@ "$id": { "type": "string", "format": "uri", - "pattern": - "(https://ns\\.adobe\\.com/xdm/[a-z0-9-/]*)|(http://schema\\.org/.*)|(http://ns.adobe.com/adobecloud/core/1.0.*)|(https://tools\\.ietf\\.org/html/draft-kelly-json-hal-08/.*)|(http://www.iptc\\.org/.*)" + "pattern": "(https://ns\\.adobe\\.com/xdm/[a-z0-9-/]*)|(http://schema\\.org/.*)|(http://ns.adobe.com/adobecloud/core/1.0.*)|(https://tools\\.ietf\\.org/html/draft-kelly-json-hal-08/.*)|(http://www.iptc\\.org/.*)" }, "meta:license": { "type": "array", @@ -52,32 +51,27 @@ }, { "type": "string", - "const": - "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license" + "const": "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license" }, { "type": "string", - "const": - "you may not use this file except in compliance with the License. You may obtain a copy" + "const": "you may not use this file except in compliance with the License. You may obtain a copy" }, { "type": "string", - "const": - "of the License at https://creativecommons.org/licenses/by/4.0/" + "const": "of the License at https://creativecommons.org/licenses/by/4.0/" } ] }, "meta:extensible": { "type": "boolean", "default": false, - "description": - "Set this `true` if the schema can be extended by other schemas." + "description": "Set this `true` if the schema can be extended by other schemas." }, "meta:auditable": { "type": "boolean", "default": false, - "description": - "Set this `true` if entities of this schema can have an audit record." + "description": "Set this `true` if entities of this schema can have an audit record." }, "meta:extends": { "oneOf": [ @@ -98,8 +92,7 @@ "type": "array", "items": { "type": "object", - "$ref": - "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor#/definitions/descriptor" + "$ref": "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor#/definitions/descriptor" } }, "meta:xdmType": { @@ -129,8 +122,7 @@ "dcx:typeRestriction": { "type": "string", "pattern": "^(\\w+|\\*)/([-.\\w.]+|\\*)\\+dcx$", - "description": - "The DCX format or group of formats this schema can be applied to in validation workflows." + "description": "The DCX format or group of formats this schema can be applied to in validation workflows." } }, "allOf": [ @@ -203,8 +195,7 @@ ], "meta:status": { "title": "Status", - "description": - "Indicates if the schema’s level of stability. Defined values are: stable, stabilizing, and experimental.", + "description": "Indicates if the schema’s level of stability. Defined values are: stable, stabilizing, and experimental.", "type": "string", "meta:enum": ["stable", "stabilizing", "experimental", "deprecated"] } diff --git a/package.json b/package.json index 18c70c554..67b61d19c 100644 --- a/package.json +++ b/package.json @@ -11,22 +11,15 @@ }, "scripts": { "clean": "rm -rf docs/reference", - "markdown": - "shx mkdir -p docs/reference && jsonschema2md -o docs/reference -d schemas --link-abstract abstract.md --link-extensible extensions.md --link-status status.md --link-id id.md --link-custom extensions.md --link-additional extensions.md", + "markdown": "shx mkdir -p docs/reference && jsonschema2md -o docs/reference -d schemas --link-abstract abstract.md --link-extensible extensions.md --link-status status.md --link-id id.md --link-custom extensions.md --link-additional extensions.md", "test": "mocha", - "lint": - "prettier --write *.json RELEASING.md CHANGELOG.md CONTRIBUTING.md README.md docs/*.md schemas/*/**/*.md schemas/*/**/*.json extensions/*/**/*.json extensions/*/*/**/*.json && git diff --exit-code", + "lint": "prettier --write *.json RELEASING.md CHANGELOG.md CONTRIBUTING.md README.md docs/*.md schemas/*/**/*.md schemas/*/**/*.json extensions/*/**/*.json extensions/*/*/**/*.json && git diff --exit-code", "lint-quick": "pretty-quick", - "package": - "npm run markdown && curl -o \"./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar\" -C - https://artifactory.corp.adobe.com/artifactory/maven-markdown-tools-release/io/adobe/udp/markdown-importer/0.0.4/markdown-importer-0.0.4-jar-with-dependencies.jar && java -jar ./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar markdown2aem.yaml", - "upload": - "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-stage.adobemsbasic.com/crx/packmgr/service.jsp", - "upload:prod": - "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-prod.adobemsbasic.com/crx/packmgr/service.jsp", - "activate": - "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-stage.adobemsbasic.com/etc/replication/treeactivation.html", - "activate:prod": - "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-prod.adobemsbasic.com/etc/replication/treeactivation.html", + "package": "npm run markdown && curl -o \"./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar\" -C - https://artifactory.corp.adobe.com/artifactory/maven-markdown-tools-release/io/adobe/udp/markdown-importer/0.0.4/markdown-importer-0.0.4-jar-with-dependencies.jar && java -jar ./node_modules/markdown-importer-0.0.4-jar-with-dependencies.jar markdown2aem.yaml", + "upload": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-stage.adobemsbasic.com/crx/packmgr/service.jsp", + "upload:prod": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F file=\"@xdm-docs.zip\" -F name=\"xdm-docs\" -F force=true -F install=true https://author-adobeio-prod.adobemsbasic.com/crx/packmgr/service.jsp", + "activate": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-stage.adobemsbasic.com/etc/replication/treeactivation.html", + "activate:prod": "curl -u \"$npm_package_config_aem_user:$npm_package_config_aem_password\" -F cmd=activate -F ignoredeactivated=true -F onlymodified=true -F path=/content/udp/en/open/standards/xdm/docs https://author-adobeio-prod.adobemsbasic.com/etc/replication/treeactivation.html", "stability-check": "node bin/show-stablization-candidates.js" }, "repository": { diff --git a/schemas/common/descriptors/itemselector.schema.json b/schemas/common/descriptors/itemselector.schema.json index ab9aefac4..2d0af3cee 100644 --- a/schemas/common/descriptors/itemselector.schema.json +++ b/schemas/common/descriptors/itemselector.schema.json @@ -11,8 +11,7 @@ "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. Matching may be done based on array index, @id, @type, or schema URI.", + "description": "Describes how to select or match to a specific item from an array of values described by an XDM schema. Matching may be done based on array index, @id, @type, or schema URI.", "definitions": { "selector": { "oneOf": [ @@ -21,8 +20,7 @@ "xdm:index": { "title": "Index", "type": "integer", - "description": - "When present, indicates the item at this array index should be selected.", + "description": "When present, indicates the item at this array index should be selected.", "minimum": 0 } }, @@ -34,8 +32,7 @@ "title": "ID", "type": "string", "format": "uri", - "description": - "When present, indicates the item with this @id value should be selected." + "description": "When present, indicates the item with this @id value should be selected." } }, "required": ["xdm:id"] @@ -46,8 +43,7 @@ "title": "Type", "type": "string", "format": "uri", - "description": - "When present, indicates the item with this @type value should be selected." + "description": "When present, indicates the item with this @type value should be selected." } }, "required": ["xdm:type"] @@ -58,8 +54,7 @@ "title": "Schema", "type": "string", "format": "uri", - "description": - "When present, indicates the item which conforms to this schema URI should be selected." + "description": "When present, indicates the item which conforms to this schema URI should be selected." } }, "required": ["xdm:schema"] diff --git a/schemas/common/descriptors/relationshipdescriptor.description.md b/schemas/common/descriptors/relationshipdescriptor.description.md index 0e44ddf33..668576b4b 100644 --- a/schemas/common/descriptors/relationshipdescriptor.description.md +++ b/schemas/common/descriptors/relationshipdescriptor.description.md @@ -6,10 +6,10 @@ While schema descriptors can be used to define metadata about a single schema, t The following relationship types are defined by XDM: -* `xdm:oneToOne`: describes a 1:1 relationship between a source schema and a destination schema -* `xdm:oneToMany`: describes a 1:m relationship between a source schema and a destination schema -* `xdm:manyToOne`: describes a m:1 relationship between a source schema and a destination schema -* `xdm:manyToMany`: describes an m:n relationship between a source schema and a destination schema +- `xdm:oneToOne`: describes a 1:1 relationship between a source schema and a destination schema +- `xdm:oneToMany`: describes a 1:m relationship between a source schema and a destination schema +- `xdm:manyToOne`: describes a m:1 relationship between a source schema and a destination schema +- `xdm:manyToMany`: describes an m:n relationship between a source schema and a destination schema ## Arrays and Denormalized Links diff --git a/schemas/common/descriptors/relationshipdescriptor.schema.json b/schemas/common/descriptors/relationshipdescriptor.schema.json index bf3c87f5d..06267743e 100644 --- a/schemas/common/descriptors/relationshipdescriptor.schema.json +++ b/schemas/common/descriptors/relationshipdescriptor.schema.json @@ -14,8 +14,7 @@ ], "meta:abstract": false, "type": "object", - "description": - "A descriptor that describes a relationship between two schemas, a 'source' and a 'destination'. This relationship may be directly between the schemas, or between specific properties of the schemas. Relationship descriptors may be used to describe foreign key relationships between schemas, defining a relational model or star schema.", + "description": "A descriptor that describes a relationship between two schemas, a 'source' and a 'destination'. This relationship may be directly between the schemas, or between specific properties of the schemas. Relationship descriptors may be used to describe foreign key relationships between schemas, defining a relational model or star schema.", "definitions": { "relationshipdescriptor": { "properties": { @@ -28,15 +27,12 @@ "xdm:destinationProperty": { "title": "Destination Property", "type": "string", - "description": - "When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema'" + "description": "When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema'" }, "xdm:destinationItem": { "title": "Destination Item", - "description": - "When present, the selector used to match a specific item in the array pointed to by destProperty", - "$ref": - "https://ns.adobe.com/xdm/common/descriptors/itemselector#/definitions/selector" + "description": "When present, the selector used to match a specific item in the array pointed to by destProperty", + "$ref": "https://ns.adobe.com/xdm/common/descriptors/itemselector#/definitions/selector" } }, "required": ["xdm:destinationSchema"] @@ -44,8 +40,7 @@ }, "allOf": [ { - "$ref": - "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor#/definitions/descriptor" + "$ref": "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor#/definitions/descriptor" }, { "$ref": "#/definitions/relationshipdescriptor" diff --git a/schemas/common/descriptors/schemadescriptor.schema.json b/schemas/common/descriptors/schemadescriptor.schema.json index 4dea5415d..788d3a476 100644 --- a/schemas/common/descriptors/schemadescriptor.schema.json +++ b/schemas/common/descriptors/schemadescriptor.schema.json @@ -11,8 +11,7 @@ "meta:extensible": true, "meta:abstract": false, "type": "object", - "description": - "A descriptor that contains metadata about an XDM schema, including an optional property and array item selector, used to address the descriptor to a specific property or item.", + "description": "A descriptor that contains metadata about an XDM schema, including an optional property and array item selector, used to address the descriptor to a specific property or item.", "definitions": { "descriptor": { "properties": { @@ -20,8 +19,7 @@ "title": "Identifier", "type": "string", "format": "uri-reference", - "description": - "The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'" + "description": "The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'" }, "@type": { "title": "Type", @@ -33,21 +31,17 @@ "title": "Source Schema", "type": "string", "format": "uri", - "description": - "The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'" + "description": "The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'" }, "xdm:sourceProperty": { "title": "Source Property", "type": "string", - "description": - "When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`." + "description": "When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`." }, "xdm:sourceItem": { "title": "Source Item", - "description": - "When present, the selector used to match a specific item in the array pointed to by `sourceProperty`", - "$ref": - "https://ns.adobe.com/xdm/common/descriptors/itemselector#/definitions/selector" + "description": "When present, the selector used to match a specific item in the array pointed to by `sourceProperty`", + "$ref": "https://ns.adobe.com/xdm/common/descriptors/itemselector#/definitions/selector" } } } diff --git a/schemas/common/event/created.example.1.json b/schemas/common/event/created.example.1.json index 5be646fb0..bbbe08080 100644 --- a/schemas/common/event/created.example.1.json +++ b/schemas/common/event/created.example.1.json @@ -1,6 +1,5 @@ { - "@id": - "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "@type": "https://ns.adobe.com/xdm/common/event/created", "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", "activitystreams:actor": { diff --git a/schemas/common/event/created.schema.json b/schemas/common/event/created.schema.json index f674ca2c8..bb3e76c55 100644 --- a/schemas/common/event/created.schema.json +++ b/schemas/common/event/created.schema.json @@ -10,8 +10,7 @@ "type": "object", "title": "Created Event", "meta:extends": "https://ns.adobe.com/xdm/common/eventenvelope", - "description": - "A `created event` follows semantics that are exactly equivalent to the semantics described by the [`create activity`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-create), except for one difference. The `create activity` can be used in imperative contexts, however, the `created event` can only be used in passive contexts.", + "description": "A `created event` follows semantics that are exactly equivalent to the semantics described by the [`create activity`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-create), except for one difference. The `create activity` can be used in imperative contexts, however, the `created event` can only be used in passive contexts.", "allOf": [ { "$ref": "https://ns.adobe.com/xdm/common/eventenvelope" diff --git a/schemas/common/event/deleted.example.1.json b/schemas/common/event/deleted.example.1.json index a2348d1ec..23acb1480 100644 --- a/schemas/common/event/deleted.example.1.json +++ b/schemas/common/event/deleted.example.1.json @@ -1,6 +1,5 @@ { - "@id": - "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "@type": "https://ns.adobe.com/xdm/common/event/deleted", "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", "activitystreams:actor": { diff --git a/schemas/common/event/deleted.schema.json b/schemas/common/event/deleted.schema.json index 64c590220..026dfad5c 100644 --- a/schemas/common/event/deleted.schema.json +++ b/schemas/common/event/deleted.schema.json @@ -10,8 +10,7 @@ "type": "object", "title": "Deleted Event", "meta:extends": "https://ns.adobe.com/xdm/common/eventenvelope", - "description": - "A `deleted event` follows semantics that are exactly equivalent to the semantics described by the [`delete activity`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-delete), except for one difference. The `delete activity` can be used in imperative contexts, however, the `deleted event` can only be used in passive contexts.", + "description": "A `deleted event` follows semantics that are exactly equivalent to the semantics described by the [`delete activity`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-delete), except for one difference. The `delete activity` can be used in imperative contexts, however, the `deleted event` can only be used in passive contexts.", "allOf": [ { "$ref": "https://ns.adobe.com/xdm/common/eventenvelope" diff --git a/schemas/common/event/emitted.example.1.json b/schemas/common/event/emitted.example.1.json index 3f6d6ac60..51e24c601 100644 --- a/schemas/common/event/emitted.example.1.json +++ b/schemas/common/event/emitted.example.1.json @@ -1,22 +1,18 @@ { - "@id": - "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "@type": "https://ns.adobe.com/xdm/common/event/emitted", - "xdm:objectType": - "https://osgi.org/javadoc/r4v42/org/osgi/service/event/Event.html#io/adobe/event/sample/sku", + "xdm:objectType": "https://osgi.org/javadoc/r4v42/org/osgi/service/event/Event.html#io/adobe/event/sample/sku", "activitystreams:published": "2016-07-16T19:20:30+01:00", "activitystreams:to": { "@type": "https://ns.adobe.com/adobecloudplatform/ims/organization", - "https://ns.adobe.com/adobecloudplatform/ims/organization#id": - "08B3E5CE5822FC520A494229@AdobeOrg" + "https://ns.adobe.com/adobecloudplatform/ims/organization#id": "08B3E5CE5822FC520A494229@AdobeOrg" }, "activitystreams:generator": { "@type": "https://ns.adobe.com/xdm/content/repository", "xdm:root": "http://francois.corp.adobe.com:4502/" }, "activitystreams:object": { - "@type": - "https://osgi.org/javadoc/r4v42/org/osgi/service/event/Event.html#io/adobe/event/sample/sku", + "@type": "https://osgi.org/javadoc/r4v42/org/osgi/service/event/Event.html#io/adobe/event/sample/sku", "topic": "io/adobe/event/sample/sku", "properties": { "type": "created", diff --git a/schemas/common/event/emitted.schema.json b/schemas/common/event/emitted.schema.json index 6c074f2bf..29616502c 100644 --- a/schemas/common/event/emitted.schema.json +++ b/schemas/common/event/emitted.schema.json @@ -10,8 +10,7 @@ "type": "object", "title": "Emitted Event", "meta:extends": "https://ns.adobe.com/xdm/common/eventenvelope", - "description": - "The `emitted event` represents the activity of emitting a message or some `object`. This event type provides the capability to conform custom activities to the XDM Event Envelope. A custom activity is one where the system transporting the event isn't aware of what is in the event. A custom activity typically tends to be configured by a system's end user. Take, for example, custom OSGI events in AEM. One concern does arise regarding the `emitted event`, which is, its generic nature that allows for almost every activity to be modeled as 'message emitted' activity. This, however, is a trap that publishers of the XDM Event Envelope must steer away from.", + "description": "The `emitted event` represents the activity of emitting a message or some `object`. This event type provides the capability to conform custom activities to the XDM Event Envelope. A custom activity is one where the system transporting the event isn't aware of what is in the event. A custom activity typically tends to be configured by a system's end user. Take, for example, custom OSGI events in AEM. One concern does arise regarding the `emitted event`, which is, its generic nature that allows for almost every activity to be modeled as 'message emitted' activity. This, however, is a trap that publishers of the XDM Event Envelope must steer away from.", "allOf": [ { "$ref": "https://ns.adobe.com/xdm/common/eventenvelope" diff --git a/schemas/common/event/published.example.1.json b/schemas/common/event/published.example.1.json index 3129ab57e..1c49a8fe4 100644 --- a/schemas/common/event/published.example.1.json +++ b/schemas/common/event/published.example.1.json @@ -1,6 +1,5 @@ { - "@id": - "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "@type": "https://ns.adobe.com/xdm/common/event/published", "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", "activitystreams:actor": { diff --git a/schemas/common/event/published.schema.json b/schemas/common/event/published.schema.json index e69b86645..90feade22 100644 --- a/schemas/common/event/published.schema.json +++ b/schemas/common/event/published.schema.json @@ -10,8 +10,7 @@ "type": "object", "title": "Published Event", "meta:extends": "https://ns.adobe.com/xdm/common/eventenvelope", - "description": - "The `published event` represents the activity of releasing an object for distribution. Some examples of the published activity are, publishing digital content on a website, publishing a book, publishing an article in a journal, publishing a memo on a notice board, etcetera. The [`object`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) field should specify the object that was released/published, whereas the [`target`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target) field, if present, should describe where the said object was published on. The `published event` can only be used in passive contexts. Example: the act of publishing an article in a journal would be represented by the `published` activity wherein, the article would be the `object` of publication and the journal would be the `target`.", + "description": "The `published event` represents the activity of releasing an object for distribution. Some examples of the published activity are, publishing digital content on a website, publishing a book, publishing an article in a journal, publishing a memo on a notice board, etcetera. The [`object`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) field should specify the object that was released/published, whereas the [`target`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target) field, if present, should describe where the said object was published on. The `published event` can only be used in passive contexts. Example: the act of publishing an article in a journal would be represented by the `published` activity wherein, the article would be the `object` of publication and the journal would be the `target`.", "allOf": [ { "$ref": "https://ns.adobe.com/xdm/common/eventenvelope" diff --git a/schemas/common/event/rejected.example.1.json b/schemas/common/event/rejected.example.1.json index 52decb0bb..6247f81c9 100644 --- a/schemas/common/event/rejected.example.1.json +++ b/schemas/common/event/rejected.example.1.json @@ -1,10 +1,8 @@ { - "@id": - "https://events.adobe.io/events/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/events/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "activitystreams:published": "2016-07-16T19:20:30+01:00", "activitystreams:to": { - "https://ns.adobe.com/adobecloudplatform/ims/user#id": - "C74F69D7594880280A495D09@AdobeID", + "https://ns.adobe.com/adobecloudplatform/ims/user#id": "C74F69D7594880280A495D09@AdobeID", "@type": "https://ns.adobe.com/adobecloudplatform/ims/user" }, "@type": "https://ns.adobe.com/xdm/common/event/rejected", @@ -15,8 +13,7 @@ }, "activitystreams:object": { "@type": "https://stock.adobe.com/content/json/2017-08-31", - "filename": - "2017-03-20T183243Z_131980992_RC110C7B3030_RTRMADP_0_BRAZIL-CORRUPTION-FOOD.JSON", + "filename": "2017-03-20T183243Z_131980992_RC110C7B3030_RTRMADP_0_BRAZIL-CORRUPTION-FOOD.JSON", "url": "http://s3.amazonaws.com/bucket/asset/file.jpg", "activitystreams:generator": { "name": "reuters" diff --git a/schemas/common/event/unpublished.example.1.json b/schemas/common/event/unpublished.example.1.json index aaeb6c384..522e9b1f5 100644 --- a/schemas/common/event/unpublished.example.1.json +++ b/schemas/common/event/unpublished.example.1.json @@ -1,6 +1,5 @@ { - "@id": - "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "@type": "https://ns.adobe.com/xdm/common/event/unpublished", "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", "activitystreams:actor": { diff --git a/schemas/common/event/unpublished.schema.json b/schemas/common/event/unpublished.schema.json index e7a0b8b81..92c07d5ea 100644 --- a/schemas/common/event/unpublished.schema.json +++ b/schemas/common/event/unpublished.schema.json @@ -10,8 +10,7 @@ "type": "object", "title": "Unpublished Event", "meta:extends": "https://ns.adobe.com/xdm/common/eventenvelope", - "description": - "The `unpublished event` represents the activity of making an object, which was previously published, unavailable for distribution. It can be thought of as the semantic opposite of the `published event`. Some examples of the unpublished activity are, taking down digital content from a website, taking down a previously published memo from the notice board, etcetera. The [`object`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) field should specify the object that was taken down/unpublished, whereas the [`target`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target) field, if present, should describe where the said object was taken down from. The `unpublished event` can only be used in passive contexts. Example: the act of taking down a previously published memo from the notice board would be represented by the `unpublished` activity wherein, the memo would be the `object` of the `unpublished event` and the notice board would be the `target`.", + "description": "The `unpublished event` represents the activity of making an object, which was previously published, unavailable for distribution. It can be thought of as the semantic opposite of the `published event`. Some examples of the unpublished activity are, taking down digital content from a website, taking down a previously published memo from the notice board, etcetera. The [`object`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) field should specify the object that was taken down/unpublished, whereas the [`target`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target) field, if present, should describe where the said object was taken down from. The `unpublished event` can only be used in passive contexts. Example: the act of taking down a previously published memo from the notice board would be represented by the `unpublished` activity wherein, the memo would be the `object` of the `unpublished event` and the notice board would be the `target`.", "allOf": [ { "$ref": "https://ns.adobe.com/xdm/common/eventenvelope" diff --git a/schemas/common/event/updated.example.1.json b/schemas/common/event/updated.example.1.json index 86a871f2b..dc66378f8 100644 --- a/schemas/common/event/updated.example.1.json +++ b/schemas/common/event/updated.example.1.json @@ -1,6 +1,5 @@ { - "@id": - "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "@type": "https://ns.adobe.com/xdm/common/event/updated", "xdm:objectType": "https://ns.adobe.com/xdm/assets/asset", "activitystreams:actor": { diff --git a/schemas/common/event/updated.schema.json b/schemas/common/event/updated.schema.json index f6e532ea1..88f463e83 100644 --- a/schemas/common/event/updated.schema.json +++ b/schemas/common/event/updated.schema.json @@ -10,8 +10,7 @@ "type": "object", "title": "Updated Event", "meta:extends": "https://ns.adobe.com/xdm/common/eventenvelope", - "description": - "A `updated event` follows semantics that are exactly equivalent to the semantics described by the [`update activity`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-update), except for one difference. The `update activity` can be used in imperative contexts, however, the `updated event` can only be used in passive contexts.", + "description": "A `updated event` follows semantics that are exactly equivalent to the semantics described by the [`update activity`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-update), except for one difference. The `update activity` can be used in imperative contexts, however, the `updated event` can only be used in passive contexts.", "allOf": [ { "$ref": "https://ns.adobe.com/xdm/common/eventenvelope" diff --git a/schemas/content/repository-policies/encryption.schema.json b/schemas/content/repository-policies/encryption.schema.json index 23346dc07..b9bb66402 100644 --- a/schemas/content/repository-policies/encryption.schema.json +++ b/schemas/content/repository-policies/encryption.schema.json @@ -17,16 +17,14 @@ "properties": { "xdm:keyType": { "name": "Key Type", - "description": - "The type of encryption key - 'platform': a key used across all tenants of the platform; 'org': a key managed exclusviely for the org to which the storage belongs", + "description": "The type of encryption key - 'platform': a key used across all tenants of the platform; 'org': a key managed exclusviely for the org to which the storage belongs", "meta:usereditable": false, "type": "string", "enum": ["platform", "org"] }, "xdm:keyStatus": { "name": "Key Status", - "description": - "The status of the encryption key - 'enabled': the key is enabled and content is accessible to authorized users; 'disabled': the key is disabled and content is not accessible", + "description": "The status of the encryption key - 'enabled': the key is enabled and content is accessible to authorized users; 'disabled': the key is disabled and content is not accessible", "meta:usereditable": false, "type": "string", "enum": ["enabled", "disabled"] diff --git a/schemas/content/repository-policies/quota.schema.json b/schemas/content/repository-policies/quota.schema.json index 61b055c5d..147efdaa9 100644 --- a/schemas/content/repository-policies/quota.schema.json +++ b/schemas/content/repository-policies/quota.schema.json @@ -16,29 +16,25 @@ "properties": { "xdm:enforcement": { "name": "Enforcement Type", - "decription": - "Determines whether the quota is being enforced (hard quota) or only reported on (soft quota)", + "decription": "Determines whether the quota is being enforced (hard quota) or only reported on (soft quota)", "type": "string", "enum": ["hard", "soft"] }, "xdm:amount": { "name": "Quota amount", - "decription": - "The quota against which consumption is measured at the point of the repository that links to this document.", + "decription": "The quota against which consumption is measured at the point of the repository that links to this document.", "type": "number", "minimum": 0 }, "xdm:consumed": { "name": "Currently consumed amount", - "decription": - "The amount currently consumed against the quota at the point of the repository that links to this document.", + "decription": "The amount currently consumed against the quota at the point of the repository that links to this document.", "meta:usereditable": false, "type": "number" }, "xdm:unit": { "name": "Unit of the 'limit' and 'consumed' properties", - "decription": - "The unit that is used to determine the quota and measure consumption. This property is optional, but fixed, i.e. it allows consumers to quickly understand the value just by looking at the JSON response from the API.", + "decription": "The unit that is used to determine the quota and measure consumption. This property is optional, but fixed, i.e. it allows consumers to quickly understand the value just by looking at the JSON response from the API.", "meta:usereditable": false, "type": "string", "const": "Bytes" diff --git a/schemas/content/repository-policies/versioning.schema.json b/schemas/content/repository-policies/versioning.schema.json index ae092865b..4772d6b90 100644 --- a/schemas/content/repository-policies/versioning.schema.json +++ b/schemas/content/repository-policies/versioning.schema.json @@ -16,14 +16,12 @@ "properties": { "xdm:retentionTime": { "name": "Retention Time (days)", - "description": - "The maximum time (in days) up to which a version is retained if it is not marked as a milestone", + "description": "The maximum time (in days) up to which a version is retained if it is not marked as a milestone", "type": "integer" }, "xdm:maxMilestones": { "name": "Maximum Number of Milestones", - "description": - "The maximum number of old versions that can be marked as a mlestone on a versioned resource", + "description": "The maximum number of old versions that can be marked as a mlestone on a versioned resource", "type": "integer" } } diff --git a/schemas/external/activity-streams-2/activity.example.1.json b/schemas/external/activity-streams-2/activity.example.1.json index 6081aaea4..5a5d7c16d 100644 --- a/schemas/external/activity-streams-2/activity.example.1.json +++ b/schemas/external/activity-streams-2/activity.example.1.json @@ -3,13 +3,11 @@ "activitystreams": "http://www.w3.org/ns/activitystreams#", "xdm": "https://ns.adobe.com/xdm/" }, - "@id": - "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", + "@id": "https://events.adobe.io/event/id/82235bac-2b81-4e70-90b5-2bd1f04b5c7b", "@type": "https://ns.adobe.com/xdm/common/event/created", "activitystreams:published": "2016-07-16T19:20:30+01:00", "activitystreams:to": { - "https://ns.adobe.com/adobecloudplatform/ims/user#id": - "D13A1E7053E46A220A4C86E1@AdobeID", + "https://ns.adobe.com/adobecloudplatform/ims/user#id": "D13A1E7053E46A220A4C86E1@AdobeID", "@type": "https://ns.adobe.com/adobecloudplatform/ims/user" }, "activitystreams:generator": { @@ -17,8 +15,7 @@ "@type": "https://ns.adobe.com/xdm/content/repository" }, "activitystreams:actor": { - "https://ns.adobe.com/adobecloudplatform/ims/user#id": - "D13A1E7053E46A220A4C86E1@AdobeID", + "https://ns.adobe.com/adobecloudplatform/ims/user#id": "D13A1E7053E46A220A4C86E1@AdobeID", "@type": "https://ns.adobe.com/adobecloudplatform/ims/user" }, "activitystreams:object": { diff --git a/schemas/external/activity-streams-2/activity.schema.json b/schemas/external/activity-streams-2/activity.schema.json index 350e5030a..348a51fcb 100644 --- a/schemas/external/activity-streams-2/activity.schema.json +++ b/schemas/external/activity-streams-2/activity.schema.json @@ -42,40 +42,33 @@ "extra-properties": { "properties": { "activitystreams:actor": { - "description": - "Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor) document for a complete description.", + "description": "Describes one or more entities that either performed or are expected to perform the activity. Any single activity can have multiple actors. The actor MAY be specified using an indirect Link. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-actor) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:object": { - "description": - "When used within an Activity, describes the direct object of the activity. For instance, in the activity 'John added a movie to his wishlist', the object of the activity is the movie added. When used within a Relationship describes the entity to which the subject is related. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) document for a complete description.", + "description": "When used within an Activity, describes the direct object of the activity. For instance, in the activity 'John added a movie to his wishlist', the object of the activity is the movie added. When used within a Relationship describes the entity to which the subject is related. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:target": { - "description": - "Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition 'to'. For instance, in the activity 'John added a movie to his wishlist', the target of the activity is John's wishlist. An activity can have more than one target. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target) document for a complete description.", + "description": "Describes the indirect object, or target, of the activity. The precise meaning of the target is largely dependent on the type of action being described but will often be the object of the English preposition 'to'. For instance, in the activity 'John added a movie to his wishlist', the target of the activity is John's wishlist. An activity can have more than one target. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-target) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:result": { - "description": - "Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-result) document for a complete description.", + "description": "Describes the result of the activity. For instance, if a particular action results in the creation of a new resource, the result property can be used to describe that new resource. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-result) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:origin": { - "description": - "Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition 'from'. For instance, in the activity 'John moved an item to List B from List A', the origin of the activity is 'List A'. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-origin) document for a complete description.", + "description": "Describes an indirect object of the activity from which the activity is directed. The precise meaning of the origin is the object of the English preposition 'from'. For instance, in the activity 'John moved an item to List B from List A', the origin of the activity is 'List A'. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-origin) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:instrument": { - "description": - "Identifies one or more objects used (or to be used) in the completion of an Activity. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-instrument) document for a complete description.", + "description": "Identifies one or more objects used (or to be used) in the completion of an Activity. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-instrument) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" } } } }, - "description": - "An [Activity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-activity) is a subtype of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` that describes some form of action that may happen, is currently happening, or has already happened. The `Activity` type itself serves as an abstract base type for all types of activities. It is important to note that the `Activity` type itself does not carry any specific semantics about the kind of action being taken.", + "description": "An [Activity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-activity) is a subtype of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` that describes some form of action that may happen, is currently happening, or has already happened. The `Activity` type itself serves as an abstract base type for all types of activities. It is important to note that the `Activity` type itself does not carry any specific semantics about the kind of action being taken.", "type": "object", "allOf": [ { diff --git a/schemas/external/activity-streams-2/collection-page.schema.json b/schemas/external/activity-streams-2/collection-page.schema.json index c5cd83cbe..9405a808d 100644 --- a/schemas/external/activity-streams-2/collection-page.schema.json +++ b/schemas/external/activity-streams-2/collection-page.schema.json @@ -15,8 +15,7 @@ "format": "uri" }, { - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/collection" + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/collection" }, { "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/link" @@ -26,8 +25,7 @@ "single-collectionPage-or-link": { "anyOf": [ { - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/collection-page" + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/collection-page" }, { "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/link" @@ -37,25 +35,21 @@ "extra-properties": { "properties": { "activitystreams:partOf": { - "description": - "Identifies the Collection to which a CollectionPage objects items belong. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-partof) document for a complete description.", + "description": "Identifies the Collection to which a CollectionPage objects items belong. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-partof) document for a complete description.", "$ref": "#/definitions/single-collection-or-link" }, "activitystreams:next": { - "description": - "In a paged Collection, indicates the next page of items. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-next) document for a complete description.", + "description": "In a paged Collection, indicates the next page of items. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-next) document for a complete description.", "$ref": "#/definitions/single-collectionPage-or-link" }, "activitystreams:prev": { - "description": - "In a paged Collection, identifies the previous page of items. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-prev) document for a complete description.", + "description": "In a paged Collection, identifies the previous page of items. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-prev) document for a complete description.", "$ref": "#/definitions/single-collectionPage-or-link" } } } }, - "description": - "Used to represent distinct subsets of items from a `Collection`. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collectionpage) for a complete description of the `CollectionPage` object.", + "description": "Used to represent distinct subsets of items from a `Collection`. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collectionpage) for a complete description of the `CollectionPage` object.", "type": "object", "allOf": [ { diff --git a/schemas/external/activity-streams-2/collection.schema.json b/schemas/external/activity-streams-2/collection.schema.json index e86986d41..71986a1ea 100644 --- a/schemas/external/activity-streams-2/collection.schema.json +++ b/schemas/external/activity-streams-2/collection.schema.json @@ -15,8 +15,7 @@ "format": "uri" }, { - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/collection-page" + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/collection-page" }, { "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/link" @@ -52,37 +51,30 @@ "extra-properties": { "properties": { "activitystreams:totalItems": { - "description": - "A non-negative integer specifying the total number of objects contained by the logical view of the collection. This number might not reflect the actual number of items serialized within the Collection object instance. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-totalitems) document for a complete description.", + "description": "A non-negative integer specifying the total number of objects contained by the logical view of the collection. This number might not reflect the actual number of items serialized within the Collection object instance. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-totalitems) document for a complete description.", "type": "integer", "minimum": 0 }, "activitystreams:current": { - "description": - "In a paged Collection, indicates the page that contains the most recently updated member items. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-current) document for a complete description.", + "description": "In a paged Collection, indicates the page that contains the most recently updated member items. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-current) document for a complete description.", "$ref": "#/definitions/single-collectionPage-or-link" }, "activitystreams:first": { - "description": - "In a paged Collection, indicates the furthest preceeding page of items in the collection. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-first) document for a complete description.", + "description": "In a paged Collection, indicates the furthest preceeding page of items in the collection. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-first) document for a complete description.", "$ref": "#/definitions/single-collectionPage-or-link" }, "activitystreams:last": { - "description": - "In a paged Collection, indicates the furthest proceeding page of the collection. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-last) document for a complete description.", + "description": "In a paged Collection, indicates the furthest proceeding page of the collection. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-last) document for a complete description.", "$ref": "#/definitions/single-collectionPage-or-link" }, "activitystreams:items": { - "description": - "Identifies the items contained in a collection. The items might be ordered or unordered. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-items) document for a complete description.", - "$ref": - "#/definitions/object-or-link-or-ordered-list-of-object-or-link" + "description": "Identifies the items contained in a collection. The items might be ordered or unordered. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-items) document for a complete description.", + "$ref": "#/definitions/object-or-link-or-ordered-list-of-object-or-link" } } } }, - "description": - "A `Collection` is a subtype of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` that represents ordered or unordered sets of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) or [Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)` instances. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collection) specification for a complete description of the `Collection` type.", + "description": "A `Collection` is a subtype of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` that represents ordered or unordered sets of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) or [Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)` instances. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collection) specification for a complete description of the `Collection` type.", "type": "object", "allOf": [ { diff --git a/schemas/external/activity-streams-2/context.schema.json b/schemas/external/activity-streams-2/context.schema.json index 0c4125ae3..3d818ee3a 100644 --- a/schemas/external/activity-streams-2/context.schema.json +++ b/schemas/external/activity-streams-2/context.schema.json @@ -7,8 +7,7 @@ ], "$schema": "http://json-schema.org/draft-06/schema#", "$id": "https://ns.adobe.com/xdm/external/activity-streams-2/context", - "description": - "A a set of rules for interpreting a JSON-LD document as specified in [the Context of the JSON-LD specification](https://json-ld.org/spec/latest/json-ld/#the-context).", + "description": "A a set of rules for interpreting a JSON-LD document as specified in [the Context of the JSON-LD specification](https://json-ld.org/spec/latest/json-ld/#the-context).", "definitions": { "keywords": { "type": "string", @@ -101,8 +100,7 @@ "@language": { "oneOf": [ { - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring#/definitions/tag" + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring#/definitions/tag" }, { "type": "null" @@ -157,8 +155,7 @@ "@language": { "oneOf": [ { - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring#/definitions/tag" + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring#/definitions/tag" }, { "type": "null" diff --git a/schemas/external/activity-streams-2/document.schema.json b/schemas/external/activity-streams-2/document.schema.json index c114281bf..4c5dd4151 100644 --- a/schemas/external/activity-streams-2/document.schema.json +++ b/schemas/external/activity-streams-2/document.schema.json @@ -7,8 +7,7 @@ ], "$schema": "http://json-schema.org/draft-06/schema#", "$id": "https://ns.adobe.com/xdm/external/activity-streams-2/document", - "description": - "Represents a document of any kind. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-document) specification for a complete description of the `document` type.", + "description": "Represents a document of any kind. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-document) specification for a complete description of the `document` type.", "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/object", "title": "Document", "type": "object", diff --git a/schemas/external/activity-streams-2/id.schema.json b/schemas/external/activity-streams-2/id.schema.json index 59b36fecb..2eb4a074d 100644 --- a/schemas/external/activity-streams-2/id.schema.json +++ b/schemas/external/activity-streams-2/id.schema.json @@ -7,8 +7,7 @@ ], "$schema": "http://json-schema.org/draft-06/schema#", "$id": "https://ns.adobe.com/xdm/external/activity-streams-2/id", - "description": - "Provides the globally unique identifier for an [Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) or [Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link). Refer to the [JSON-LD](https://json-ld.org/spec/latest/json-ld/) specification for a complete description of the `@id` field.", + "description": "Provides the globally unique identifier for an [Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) or [Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link). Refer to the [JSON-LD](https://json-ld.org/spec/latest/json-ld/) specification for a complete description of the `@id` field.", "properties": { "@id": { "type": "string", diff --git a/schemas/external/activity-streams-2/image.schema.json b/schemas/external/activity-streams-2/image.schema.json index b0e9f6f6c..cb183b50b 100644 --- a/schemas/external/activity-streams-2/image.schema.json +++ b/schemas/external/activity-streams-2/image.schema.json @@ -7,8 +7,7 @@ ], "$schema": "http://json-schema.org/draft-06/schema#", "$id": "https://ns.adobe.com/xdm/external/activity-streams-2/image", - "description": - "An image document of any kind. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-image) specification for a complete description of the `image` type.", + "description": "An image document of any kind. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-image) specification for a complete description of the `image` type.", "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/document", "title": "Image Document", "type": "object", diff --git a/schemas/external/activity-streams-2/link.schema.json b/schemas/external/activity-streams-2/link.schema.json index 516caa723..23ea66de9 100644 --- a/schemas/external/activity-streams-2/link.schema.json +++ b/schemas/external/activity-streams-2/link.schema.json @@ -41,19 +41,16 @@ } }, "type": "object", - "description": - "A Link is an indirect, qualified reference to a resource identified by a URL. The fundamental model for links is established by [RFC5988](https://tools.ietf.org/html/rfc5988). Many of the properties defined by the Activity Vocabulary allow values that are either instances of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` or `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)`. When a `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)` is used, it establishes a [qualified relation](http://patterns.dataincubator.org/book/qualified-relation.html) connecting the subject (the containing object) to the resource identified by the `[href](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-href)`. Properties of the `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)` are properties of the reference as opposed to properties of the resource.", + "description": "A Link is an indirect, qualified reference to a resource identified by a URL. The fundamental model for links is established by [RFC5988](https://tools.ietf.org/html/rfc5988). Many of the properties defined by the Activity Vocabulary allow values that are either instances of `[Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object)` or `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)`. When a `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)` is used, it establishes a [qualified relation](http://patterns.dataincubator.org/book/qualified-relation.html) connecting the subject (the containing object) to the resource identified by the `[href](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-href)`. Properties of the `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)` are properties of the reference as opposed to properties of the resource.", "properties": { "activitystreams:href": { - "description": - "The target resource pointed to by a Link. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-href) document for a complete description.", + "description": "The target resource pointed to by a Link. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-href) document for a complete description.", "type": "string", "format": "uri" }, "activitystreams:rel": { "title": "Link Relation", - "description": - "A link relation associated with a `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)`. The value _MUST_ conform to both the [HTML5](https://www.w3.org/TR/html5/) and [RFC5988](https://tools.ietf.org/html/rfc5988) 'link relation' definitions. In the [HTML5](https://www.w3.org/TR/html5/), any string not containing the 'space' U+0020, 'tab' (U+0009), 'LF' (U+000A), 'FF' (U+000C), 'CR' (U+000D) or ',' (U+002C) characters can be used as a valid link relation.", + "description": "A link relation associated with a `[Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link)`. The value _MUST_ conform to both the [HTML5](https://www.w3.org/TR/html5/) and [RFC5988](https://tools.ietf.org/html/rfc5988) 'link relation' definitions. In the [HTML5](https://www.w3.org/TR/html5/), any string not containing the 'space' U+0020, 'tab' (U+0009), 'LF' (U+000A), 'FF' (U+000C), 'CR' (U+000D) or ',' (U+002C) characters can be used as a valid link relation.", "oneOf": [ { "type": "string", @@ -69,45 +66,36 @@ ] }, "activitystreams:mediaType": { - "description": - "When used on a Link, identifies the MIME media type of the referenced resource. When used on an Object, identifies the MIME media type of the value of the content property. If not specified, the content property is assumed to contain text/html content. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype) document for a complete description.", - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/object#/definitions/mime-media-type" + "description": "When used on a Link, identifies the MIME media type of the referenced resource. When used on an Object, identifies the MIME media type of the value of the content property. If not specified, the content property is assumed to contain text/html content. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype) document for a complete description.", + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/object#/definitions/mime-media-type" }, "activitystreams:name": { - "description": - "Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name) document for a complete description.", + "description": "Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name) document for a complete description.", "oneOf": [ { "type": "string" }, { - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring" + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring" } ] }, "activitystreams:hreflang": { - "description": - "Hints as to the language used by the target resource. Value must be a [BCP47] Language-Tag. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-hreflang) document for a complete description.", - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring#/definitions/tag" + "description": "Hints as to the language used by the target resource. Value must be a [BCP47] Language-Tag. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-hreflang) document for a complete description.", + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring#/definitions/tag" }, "activitystreams:height": { - "description": - "On a Link, specifies a hint as to the rendering height in device-independent pixels of the linked resource. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-height) document for a complete description.", + "description": "On a Link, specifies a hint as to the rendering height in device-independent pixels of the linked resource. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-height) document for a complete description.", "type": "integer", "minimum": 0 }, "activitystreams:width": { - "description": - "On a Link, specifies a hint as to the rendering width in device-independent pixels of the linked resource. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-width) document for a complete description.", + "description": "On a Link, specifies a hint as to the rendering width in device-independent pixels of the linked resource. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-width) document for a complete description.", "type": "integer", "minimum": 0 }, "activitystreams:preview": { - "description": - "Identifies an entity that provides a preview of this object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview) document for a complete description.", + "description": "Identifies an entity that provides a preview of this object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" } }, diff --git a/schemas/external/activity-streams-2/object.schema.json b/schemas/external/activity-streams-2/object.schema.json index 1dfbbe3af..3191120e4 100644 --- a/schemas/external/activity-streams-2/object.schema.json +++ b/schemas/external/activity-streams-2/object.schema.json @@ -12,8 +12,7 @@ "mime-media-type": { "type": "string", "title": "MIME Media Type", - "description": - "[Multipurpose Internet Mail Extensions (MIME)](https://tools.ietf.org/html/rfc2046)", + "description": "[Multipurpose Internet Mail Extensions (MIME)](https://tools.ietf.org/html/rfc2046)", "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?" }, "single-object-or-link": { @@ -109,158 +108,127 @@ "type": "string" }, { - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring" + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/rdf-langstring" } ] }, "object-properties": { "properties": { "activitystreams:attachment": { - "description": - "Identifies a resource attached or related to an object that potentially requires special handling. The intent is to provide a model that is at least semantically similar to attachments in email. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment) document for a complete description.", + "description": "Identifies a resource attached or related to an object that potentially requires special handling. The intent is to provide a model that is at least semantically similar to attachments in email. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attachment) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:attributedTo": { - "description": - "Identifies one or more entities to which this object is attributed. The attributed entities might not be Actors. For instance, an object might be attributed to the completion of another activity. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attributedTo) document for a complete description.", + "description": "Identifies one or more entities to which this object is attributed. The attributed entities might not be Actors. For instance, an object might be attributed to the completion of another activity. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-attributedTo) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:audience": { - "description": - "Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-audience) document for a complete description.", + "description": "Identifies one or more entities that represent the total population of entities for which the object can considered to be relevant. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-audience) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:content": { - "description": - "The content or textual representation of the Object encoded as a JSON string. By default, the value of content is HTML. The mediaType property can be used in the object to indicate a different content type. The content may be expressed using multiple language-tagged values. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content) document for a complete description.", + "description": "The content or textual representation of the Object encoded as a JSON string. By default, the value of content is HTML. The mediaType property can be used in the object to indicate a different content type. The content may be expressed using multiple language-tagged values. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-content) document for a complete description.", "$ref": "#/definitions/string-type" }, "activitystreams:context": { - "description": - "Identifies the context within which the object exists or an activity was performed. The notion of 'context' used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context) document for a complete description.", + "description": "Identifies the context within which the object exists or an activity was performed. The notion of 'context' used is intentionally vague. The intended function is to serve as a means of grouping objects and activities that share a common originating context or purpose. An example could be all activities relating to a common project or event. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-context) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:name": { - "description": - "A simple, human-readable, plain-text name for the object. HTML markup must not be included. The name may be expressed using multiple language-tagged values. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name) document for a complete description.", + "description": "A simple, human-readable, plain-text name for the object. HTML markup must not be included. The name may be expressed using multiple language-tagged values. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-name) document for a complete description.", "$ref": "#/definitions/string-type" }, "activitystreams:endTime": { - "description": - "The date and time describing the actual or expected ending time of the object. When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-endtime) document for a complete description.", + "description": "The date and time describing the actual or expected ending time of the object. When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-endtime) document for a complete description.", "type": "string", "format": "date-time" }, "activitystreams:generator": { - "description": - "Identifies the entity (e.g. an application) that generated the object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-generator) document for a complete description.", + "description": "Identifies the entity (e.g. an application) that generated the object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-generator) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:icon": { - "description": - "Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-icon) document for a complete description.", + "description": "Indicates an entity that describes an icon for this object. The image should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-icon) document for a complete description.", "$ref": "#/definitions/image-or-link-or-array-of-image-or-link" }, "activitystreams:image": { - "description": - "Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-image) document for a complete description.", + "description": "Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-image) document for a complete description.", "$ref": "#/definitions/image-or-link-or-array-of-image-or-link" }, "activitystreams:inReplyTo": { - "description": - "Indicates one or more entities for which this object is considered a response. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-inreplyto) document for a complete description.", + "description": "Indicates one or more entities for which this object is considered a response. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-inreplyto) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:location": { - "description": - "Indicates one or more physical or logical locations associated with the object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-location) document for a complete description.", + "description": "Indicates one or more physical or logical locations associated with the object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-location) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:preview": { - "description": - "Identifies an entity that provides a preview of this object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview) document for a complete description.", + "description": "Identifies an entity that provides a preview of this object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-preview) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:published": { - "description": - "The date and time at which the object was published Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-published) document for a complete description.", + "description": "The date and time at which the object was published Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-published) document for a complete description.", "type": "string", "format": "date-time" }, "activitystreams:replies": { - "description": - "Identifies a Collection containing objects considered to be responses to this object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-replies) document for a complete description.", - "$ref": - "https://ns.adobe.com/xdm/external/activity-streams-2/collection" + "description": "Identifies a Collection containing objects considered to be responses to this object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-replies) document for a complete description.", + "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/collection" }, "activitystreams:startTime": { - "description": - "The date and time describing the actual or expected starting time of the object. When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-starttime) document for a complete description.", + "description": "The date and time describing the actual or expected starting time of the object. When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-starttime) document for a complete description.", "type": "string", "format": "date-time" }, "activitystreams:summary": { - "description": - "A natural language summarization of the object encoded as HTML. Multiple language tagged summaries may be provided. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary) document for a complete description.", + "description": "A natural language summarization of the object encoded as HTML. Multiple language tagged summaries may be provided. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-summary) document for a complete description.", "$ref": "#/definitions/string-type" }, "activitystreams:tag": { - "description": - "One or more 'tags' that have been associated with an objects. A tag can be any kind of Object. The key difference between attachment and tag is that the former implies association by inclusion, while the latter implies associated by reference. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag) document for a complete description.", + "description": "One or more 'tags' that have been associated with an objects. A tag can be any kind of Object. The key difference between attachment and tag is that the former implies association by inclusion, while the latter implies associated by reference. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-tag) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:updated": { - "description": - "The date and time at which the object was updated Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-updated) document for a complete description.", + "description": "The date and time at which the object was updated Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-updated) document for a complete description.", "type": "string", "format": "date-time" }, "activitystreams:url": { - "description": - "Identifies one or more links to representations of the object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-url) document for a complete description.", - "$ref": - "#/definitions/xsd:anyURI-or-link-or-array-of-xsd:anyURI-or-link" + "description": "Identifies one or more links to representations of the object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-url) document for a complete description.", + "$ref": "#/definitions/xsd:anyURI-or-link-or-array-of-xsd:anyURI-or-link" }, "activitystreams:to": { - "description": - "Identifies an entity considered to be part of the public primary audience of an Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-to) document for a complete description.", + "description": "Identifies an entity considered to be part of the public primary audience of an Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-to) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:bto": { - "description": - "Identifies an Object that is part of the private primary audience of this Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bto) document for a complete description.", + "description": "Identifies an Object that is part of the private primary audience of this Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bto) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:cc": { - "description": - "Identifies an Object that is part of the public secondary audience of this Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-cc) document for a complete description.", + "description": "Identifies an Object that is part of the public secondary audience of this Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-cc) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:bcc": { - "description": - "Identifies one or more Objects that are part of the private secondary audience of this Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bcc) document for a complete description.", + "description": "Identifies one or more Objects that are part of the private secondary audience of this Object. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-bcc) document for a complete description.", "$ref": "#/definitions/object-or-link-or-array-of-object-or-link" }, "activitystreams:mediaType": { - "description": - "When used on a Link, identifies the MIME media type of the referenced resource. When used on an Object, identifies the MIME media type of the value of the content property. If not specified, the content property is assumed to contain text/html content. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype) document for a complete description.", + "description": "When used on a Link, identifies the MIME media type of the referenced resource. When used on an Object, identifies the MIME media type of the value of the content property. If not specified, the content property is assumed to contain text/html content. Refer to the [Activity Streams 2.0 Core](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-mediatype) document for a complete description.", "$ref": "#/definitions/mime-media-type" }, "activitystreams:duration": { "type": "string", - "pattern": - "^[-]?P(?!$)(?:\\d+Y)?(?:\\d+M)?(?:\\d+D)?(?:T(?!$)(?:\\d+H)?(?:\\d+M)?(?:\\d+(?:\\.\\d+)?S)?)?$", - "description": - "XSD Duration according to [specification](https://www.w3.org/TR/xmlschema11-2/#duration)", + "pattern": "^[-]?P(?!$)(?:\\d+Y)?(?:\\d+M)?(?:\\d+D)?(?:T(?!$)(?:\\d+H)?(?:\\d+M)?(?:\\d+(?:\\.\\d+)?S)?)?$", + "description": "XSD Duration according to [specification](https://www.w3.org/TR/xmlschema11-2/#duration)", "title": "XSD Duration" } } } }, "type": "object", - "description": - "Describes an object of any kind. The [`Object`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) type serves as the base type for most of the other kinds of objects defined in the Activity Vocabulary, including other Core types such as `[Activity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-activity)`, `[IntransitiveActivity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-intransitiveactivity)`, `[Collection](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collection)` and `[OrderedCollection](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection)`.", + "description": "Describes an object of any kind. The [`Object`](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) type serves as the base type for most of the other kinds of objects defined in the Activity Vocabulary, including other Core types such as `[Activity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-activity)`, `[IntransitiveActivity](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-intransitiveactivity)`, `[Collection](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-collection)` and `[OrderedCollection](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-orderedcollection)`.", "allOf": [ { "$ref": "https://ns.adobe.com/xdm/external/activity-streams-2/context" diff --git a/schemas/external/activity-streams-2/rdf-langstring.example.1.json b/schemas/external/activity-streams-2/rdf-langstring.example.1.json index a1bbfc59d..d4e83d213 100644 --- a/schemas/external/activity-streams-2/rdf-langstring.example.1.json +++ b/schemas/external/activity-streams-2/rdf-langstring.example.1.json @@ -1,4 +1,3 @@ { - "en-US": - "A created event follows semantics that are exactly equivalent to the semantics described by the create activity." + "en-US": "A created event follows semantics that are exactly equivalent to the semantics described by the create activity." } diff --git a/schemas/external/activity-streams-2/rdf-langstring.schema.json b/schemas/external/activity-streams-2/rdf-langstring.schema.json index bb0e67eaf..841a5285d 100644 --- a/schemas/external/activity-streams-2/rdf-langstring.schema.json +++ b/schemas/external/activity-streams-2/rdf-langstring.schema.json @@ -12,10 +12,8 @@ "tag": { "type": "string", "title": "Language Tag", - "pattern": - "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", - "description": - "A language tag as defined by [BCP47](https://tools.ietf.org/html/bcp47)." + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "description": "A language tag as defined by [BCP47](https://tools.ietf.org/html/bcp47)." } }, "patternProperties": { @@ -25,7 +23,6 @@ }, "additionalProperties": false, "title": "RDF Language Tagged String", - "description": - "The class `rdf:langString` is the class of [language-tagged string values](http://www.w3.org/TR/rdf11-concepts/#dfn-language-tagged-string).", + "description": "The class `rdf:langString` is the class of [language-tagged string values](http://www.w3.org/TR/rdf11-concepts/#dfn-language-tagged-string).", "meta:status": "experimental" } diff --git a/schemas/external/activity-streams-2/type.schema.json b/schemas/external/activity-streams-2/type.schema.json index e0df13e7f..18afc7ada 100644 --- a/schemas/external/activity-streams-2/type.schema.json +++ b/schemas/external/activity-streams-2/type.schema.json @@ -9,8 +9,7 @@ "$id": "https://ns.adobe.com/xdm/external/activity-streams-2/type", "type": "object", "title": "JSON-LD `@type`", - "description": - "Identifies the [Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) or [Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link) type. Multiple values may be specified. Refer to the [JSON-LD](https://json-ld.org/spec/latest/json-ld/) specification for a complete description of the `@type` field.", + "description": "Identifies the [Object](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-object) or [Link](https://www.w3.org/TR/activitystreams-vocabulary/#dfn-link) type. Multiple values may be specified. Refer to the [JSON-LD](https://json-ld.org/spec/latest/json-ld/) specification for a complete description of the `@type` field.", "definitions": { "type": { "oneOf": [ diff --git a/schemas/external/hal/hal-link.schema.json b/schemas/external/hal/hal-link.schema.json index ec194ed89..f7a0f49e7 100644 --- a/schemas/external/hal/hal-link.schema.json +++ b/schemas/external/hal/hal-link.schema.json @@ -16,64 +16,53 @@ "properties": { "templated": { "type": "boolean", - "description": - "> Its value is boolean and SHOULD be true when the Link Object's `href` property is a URI Template.\\n\\nIts value SHOULD be considered false if it is undefined or any other value than `true`." + "description": "> Its value is boolean and SHOULD be true when the Link Object's `href` property is a URI Template.\\n\\nIts value SHOULD be considered false if it is undefined or any other value than `true`." }, "href": { - "description": - "> If the value is a URI Template then the Link Object SHOULD have a `templated` attribute whose value is `true`", + "description": "> If the value is a URI Template then the Link Object SHOULD have a `templated` attribute whose value is `true`", "type": "string" }, "type": { "type": "string", "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?", - "description": - "> Its value is a string used as a hint to indicate the media type expected when dereferencing the target resource." + "description": "> Its value is a string used as a hint to indicate the media type expected when dereferencing the target resource." }, "deprecation": { "type": "string", "format": "uri", - "description": - "> Its presence indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation." + "description": "> Its presence indicates that the link is to be deprecated (i.e. removed) at a future date. Its value is a URL that SHOULD provide further information about the deprecation." }, "name": { "type": "string", - "description": - "> Its value MAY be used as a secondary key for selecting Link Objects which share the same relation type." + "description": "> Its value MAY be used as a secondary key for selecting Link Objects which share the same relation type." }, "profile": { "type": "string", "format": "uri", - "description": - "> Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-wilde-profile-link-04) of the target resource." + "description": "> Its value is a string which is a URI that hints about the profile (as defined by [I-D.wilde-profile-link](https://tools.ietf.org/html/draft-wilde-profile-link-04) of the target resource." }, "title": { "type": "string", - "description": - "> Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988))" + "description": "> Its value is a string and is intended for labelling the link with a human-readable identifier (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988))" }, "hreflang": { "type": "string", - "pattern": - "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", - "description": - "> Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)" + "pattern": "^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$", + "description": "> Its value is a string and is intended for indicating the language of the target resource (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)" } } }, "hal-link-templated": { "properties": { "href": { - "description": - "> If the value is a URI Template then the Link Object SHOULD have a `templated` attribute whose value is `true`", + "description": "> If the value is a URI Template then the Link Object SHOULD have a `templated` attribute whose value is `true`", "type": "string", "pattern": "uri-template" }, "templated": { "type": "boolean", "const": true, - "description": - "> Its value is boolean and SHOULD be true when the Link Object's `href` property is a URI Template.\\n\\nIts value SHOULD be considered false if it is undefined or any other value than `true`." + "description": "> Its value is boolean and SHOULD be true when the Link Object's `href` property is a URI Template.\\n\\nIts value SHOULD be considered false if it is undefined or any other value than `true`." } }, "required": ["href", "templated"], @@ -82,16 +71,14 @@ "hal-link": { "properties": { "href": { - "description": - "> If the value is a URI Template then the Link Object SHOULD have a `templated` attribute whose value is `true`", + "description": "> If the value is a URI Template then the Link Object SHOULD have a `templated` attribute whose value is `true`", "type": "string", "format": "uri-reference" }, "templated": { "type": "boolean", "default": false, - "description": - "> Its value is boolean and SHOULD be true when the Link Object's `href` property is a URI Template.\\n\\nIts value SHOULD be considered false if it is undefined or any other value than `true`." + "description": "> Its value is boolean and SHOULD be true when the Link Object's `href` property is a URI Template.\\n\\nIts value SHOULD be considered false if it is undefined or any other value than `true`." } }, "required": ["href"], diff --git a/schemas/external/hal/hal.schema.json b/schemas/external/hal/hal.schema.json index 23c223c58..0a2d25e52 100644 --- a/schemas/external/hal/hal.schema.json +++ b/schemas/external/hal/hal.schema.json @@ -17,148 +17,86 @@ "type": "object", "additionalProperties": false, "meta:keys": { - "about": - "Refers to a resource that is the subject of the link's context.", + "about": "Refers to a resource that is the subject of the link's context.", "alternate": "Refers to a substitute for this context", "appendix": "Refers to an appendix.", - "archives": - "Refers to a collection of records, documents, or other materials of historical interest.", + "archives": "Refers to a collection of records, documents, or other materials of historical interest.", "author": "Refers to the context's author.", - "blocked-by": - "Identifies the entity that blocks access to a resource following receipt of a legal demand.", - "bookmark": - "Gives a permanent link to use for bookmarking purposes.", - "canonical": - "Designates the preferred version of a resource (the IRI and its contents).", + "blocked-by": "Identifies the entity that blocks access to a resource following receipt of a legal demand.", + "bookmark": "Gives a permanent link to use for bookmarking purposes.", + "canonical": "Designates the preferred version of a resource (the IRI and its contents).", "chapter": "Refers to a chapter in a collection of resources.", - "cite-as": - "Indicates that the link target is preferred over the link context for the purpose of referencing.", - "collection": - "The target IRI points to a resource which represents the collection resource for the context IRI.", + "cite-as": "Indicates that the link target is preferred over the link context for the purpose of referencing.", + "collection": "The target IRI points to a resource which represents the collection resource for the context IRI.", "contents": "Refers to a table of contents.", - "convertedFrom": - "The document linked to was later converted to the document that contains this link relation. For example, an RFC can have a link to the Internet-Draft that became the RFC; in that case, the link relation would be `convertedFrom`.", - "copyright": - "Refers to a copyright statement that applies to the link's context.", - "create-form": - "The target IRI points to a resource where a submission form can be obtained.", - "current": - "Refers to a resource containing the most recent item(s) in a collection of resources.", - "describedby": - "Refers to a resource providing information about the link's context.", - "describes": - "The relationship A 'describes' B asserts that resource A provides a description of resource B. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource.", - "disclosure": - "Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.", - "dns-prefetch": - "Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.", - "duplicate": - "Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.", - "edit": - "Refers to a resource that can be used to edit the link's context.", - "edit-form": - "The target IRI points to a resource where a submission form for editing associated resource can be obtained.", - "edit-media": - "Refers to a resource that can be used to edit media associated with the link's context.", - "enclosure": - "Identifies a related resource that is potentially large and might require special handling.", - "first": - "An IRI that refers to the furthest preceding resource in a series of resources.", + "convertedFrom": "The document linked to was later converted to the document that contains this link relation. For example, an RFC can have a link to the Internet-Draft that became the RFC; in that case, the link relation would be `convertedFrom`.", + "copyright": "Refers to a copyright statement that applies to the link's context.", + "create-form": "The target IRI points to a resource where a submission form can be obtained.", + "current": "Refers to a resource containing the most recent item(s) in a collection of resources.", + "describedby": "Refers to a resource providing information about the link's context.", + "describes": "The relationship A 'describes' B asserts that resource A provides a description of resource B. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource.", + "disclosure": "Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.", + "dns-prefetch": "Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.", + "duplicate": "Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.", + "edit": "Refers to a resource that can be used to edit the link's context.", + "edit-form": "The target IRI points to a resource where a submission form for editing associated resource can be obtained.", + "edit-media": "Refers to a resource that can be used to edit media associated with the link's context.", + "enclosure": "Identifies a related resource that is potentially large and might require special handling.", + "first": "An IRI that refers to the furthest preceding resource in a series of resources.", "glossary": "Refers to a glossary of terms.", "help": "Refers to context-sensitive help.", - "hosts": - "Refers to a resource hosted by the server indicated by the link context.", - "hub": - "Refers to a hub that enables registration for notification of updates to the context.", + "hosts": "Refers to a resource hosted by the server indicated by the link context.", + "hub": "Refers to a hub that enables registration for notification of updates to the context.", "icon": "Refers to an icon representing the link's context.", "index": "Refers to an index.", - "item": - "The target IRI points to a resource that is a member of the collection represented by the context IRI.", - "last": - "An IRI that refers to the furthest following resource in a series of resources.", - "latest-version": - "Points to a resource containing the latest (e.g., current) version of the context.", + "item": "The target IRI points to a resource that is a member of the collection represented by the context IRI.", + "last": "An IRI that refers to the furthest following resource in a series of resources.", + "latest-version": "Points to a resource containing the latest (e.g., current) version of the context.", "license": "Refers to a license associated with this context.", - "lrdd": - "Refers to further information about the link's context, expressed as a LRDD (\"Link-based Resource Descriptor Document\") resource. See [RFC6415] for information about processing this relation type in host-meta documents. When used elsewhere, it refers to additional links and other metadata. Multiple instances indicate additional LRDD resources. LRDD resources MUST have an `application/xrd+xml` representation, and MAY have others.", - "memento": - "The Target IRI points to a Memento, a fixed resource that will not change state anymore.", - "monitor": - "Refers to a resource that can be used to monitor changes in an HTTP resource.", - "monitor-group": - "Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.", - "next": - "Indicates that the link's context is a part of a series, and that the next in the series is the link target.", - "next-archive": - "Refers to the immediately following archive resource.", - "nofollow": - "Indicates that the context’s original author or publisher does not endorse the link target.", - "noreferrer": - "Indicates that no referrer information is to be leaked when following the link.", + "lrdd": "Refers to further information about the link's context, expressed as a LRDD (\"Link-based Resource Descriptor Document\") resource. See [RFC6415] for information about processing this relation type in host-meta documents. When used elsewhere, it refers to additional links and other metadata. Multiple instances indicate additional LRDD resources. LRDD resources MUST have an `application/xrd+xml` representation, and MAY have others.", + "memento": "The Target IRI points to a Memento, a fixed resource that will not change state anymore.", + "monitor": "Refers to a resource that can be used to monitor changes in an HTTP resource.", + "monitor-group": "Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.", + "next": "Indicates that the link's context is a part of a series, and that the next in the series is the link target.", + "next-archive": "Refers to the immediately following archive resource.", + "nofollow": "Indicates that the context’s original author or publisher does not endorse the link target.", + "noreferrer": "Indicates that no referrer information is to be leaked when following the link.", "original": "The Target IRI points to an Original Resource.", "payment": "Indicates a resource where payment is accepted.", - "pingback": - "Gives the address of the pingback resource for the link context.", - "preconnect": - "Used to indicate an origin that will be used to fetch required resources for the link context. Initiating an early connection, which includes the DNS lookup, TCP handshake, and optional TLS negotiation, allows the user agent to mask the high latency costs of establishing a connection.", - "predecessor-version": - "Points to a resource containing the predecessor version in the version history.", - "prefetch": - "The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.", - "preload": - "Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.", - "prerender": - "Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.", - "prev": - "Indicates that the link's context is a part of a series, and that the previous in the series is the link target.", - "preview": - "Refers to a resource that provides a preview of the link's context.", - "previous": - "Refers to the previous resource in an ordered series of resources. Synonym for `prev`.", - "prev-archive": - "Refers to the immediately preceding archive resource.", - "privacy-policy": - "Refers to a privacy policy associated with the link's context.", - "profile": - "Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.", + "pingback": "Gives the address of the pingback resource for the link context.", + "preconnect": "Used to indicate an origin that will be used to fetch required resources for the link context. Initiating an early connection, which includes the DNS lookup, TCP handshake, and optional TLS negotiation, allows the user agent to mask the high latency costs of establishing a connection.", + "predecessor-version": "Points to a resource containing the predecessor version in the version history.", + "prefetch": "The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.", + "preload": "Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.", + "prerender": "Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.", + "prev": "Indicates that the link's context is a part of a series, and that the previous in the series is the link target.", + "preview": "Refers to a resource that provides a preview of the link's context.", + "previous": "Refers to the previous resource in an ordered series of resources. Synonym for `prev`.", + "prev-archive": "Refers to the immediately preceding archive resource.", + "privacy-policy": "Refers to a privacy policy associated with the link's context.", + "profile": "Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.", "related": "Identifies a related resource.", - "restconf": - "Identifies the root of RESTCONF API as configured on this HTTP server. The `restconf` relation defines the root of the API defined in RFC8040. Subsequent revisions of RESTCONF will use alternate relation values to support protocol versioning.", - "replies": - "Identifies a resource that is a reply to the context of the link.", - "search": - "Refers to a resource that can be used to search through the link's context and related resources.", + "restconf": "Identifies the root of RESTCONF API as configured on this HTTP server. The `restconf` relation defines the root of the API defined in RFC8040. Subsequent revisions of RESTCONF will use alternate relation values to support protocol versioning.", + "replies": "Identifies a resource that is a reply to the context of the link.", + "search": "Refers to a resource that can be used to search through the link's context and related resources.", "section": "Refers to a section in a collection of resources.", "self": "Conveys an identifier for the link's context.", - "service": - "Indicates a URI that can be used to retrieve a service document.", - "start": - "Refers to the first resource in a collection of resources.", + "service": "Indicates a URI that can be used to retrieve a service document.", + "start": "Refers to the first resource in a collection of resources.", "stylesheet": "Refers to a stylesheet.", - "subsection": - "Refers to a resource serving as a subsection in a collection of resources.", - "successor-version": - "Points to a resource containing the successor version in the version history.", - "tag": - "Gives a tag (identified by the given address) that applies to the current document.", - "terms-of-service": - "Refers to the terms of service associated with the link's context.", - "timegate": - "The Target IRI points to a TimeGate for an Original Resource.", - "timemap": - "The Target IRI points to a TimeMap for an Original Resource.", - "type": - "Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.", + "subsection": "Refers to a resource serving as a subsection in a collection of resources.", + "successor-version": "Points to a resource containing the successor version in the version history.", + "tag": "Gives a tag (identified by the given address) that applies to the current document.", + "terms-of-service": "Refers to the terms of service associated with the link's context.", + "timegate": "The Target IRI points to a TimeGate for an Original Resource.", + "timemap": "The Target IRI points to a TimeMap for an Original Resource.", + "type": "Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.", "up": "Refers to a parent document in a hierarchy of documents.", - "version-history": - "Points to a resource containing the version history for the context.", - "via": - "Identifies a resource that is the source of the information in the link's context.", - "webmention": - "Identifies a target URI that supports the Webmention protcol. This allows clients that mention a resource in some form of publishing process to contact that endpoint and inform it that this resource has been mentioned.", + "version-history": "Points to a resource containing the version history for the context.", + "via": "Identifies a resource that is the source of the information in the link's context.", + "webmention": "Identifies a target URI that supports the Webmention protcol. This allows clients that mention a resource in some form of publishing process to contact that endpoint and inform it that this resource has been mentioned.", "working-copy": "Points to a working copy for this resource.", - "working-copy-of": - "Points to the versioned resource from which this working copy was obtained." + "working-copy-of": "Points to the versioned resource from which this working copy was obtained." }, "patternProperties": { "^[a-z]+[a-z0-9\\.-]*$": { @@ -190,155 +128,92 @@ ] } }, - "description": - "It is an object whose property names are link relation types (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988) and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing `_links` object is a property." + "description": "It is an object whose property names are link relation types (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988) and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing `_links` object is a property." }, "_embedded": { "type": "object", "additionalProperties": false, "meta:keys": { - "about": - "Refers to a resource that is the subject of the link's context.", + "about": "Refers to a resource that is the subject of the link's context.", "alternate": "Refers to a substitute for this context", "appendix": "Refers to an appendix.", - "archives": - "Refers to a collection of records, documents, or other materials of historical interest.", + "archives": "Refers to a collection of records, documents, or other materials of historical interest.", "author": "Refers to the context's author.", - "blocked-by": - "Identifies the entity that blocks access to a resource following receipt of a legal demand.", - "bookmark": - "Gives a permanent link to use for bookmarking purposes.", - "canonical": - "Designates the preferred version of a resource (the IRI and its contents).", + "blocked-by": "Identifies the entity that blocks access to a resource following receipt of a legal demand.", + "bookmark": "Gives a permanent link to use for bookmarking purposes.", + "canonical": "Designates the preferred version of a resource (the IRI and its contents).", "chapter": "Refers to a chapter in a collection of resources.", - "cite-as": - "Indicates that the link target is preferred over the link context for the purpose of referencing.", - "collection": - "The target IRI points to a resource which represents the collection resource for the context IRI.", + "cite-as": "Indicates that the link target is preferred over the link context for the purpose of referencing.", + "collection": "The target IRI points to a resource which represents the collection resource for the context IRI.", "contents": "Refers to a table of contents.", - "convertedFrom": - "The document linked to was later converted to the document that contains this link relation. For example, an RFC can have a link to the Internet-Draft that became the RFC; in that case, the link relation would be `convertedFrom`.", - "copyright": - "Refers to a copyright statement that applies to the link's context.", - "create-form": - "The target IRI points to a resource where a submission form can be obtained.", - "current": - "Refers to a resource containing the most recent item(s) in a collection of resources.", - "describedby": - "Refers to a resource providing information about the link's context.", - "describes": - "The relationship A 'describes' B asserts that resource A provides a description of resource B. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource.", - "disclosure": - "Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.", - "dns-prefetch": - "Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.", - "duplicate": - "Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.", - "edit": - "Refers to a resource that can be used to edit the link's context.", - "edit-form": - "The target IRI points to a resource where a submission form for editing associated resource can be obtained.", - "edit-media": - "Refers to a resource that can be used to edit media associated with the link's context.", - "enclosure": - "Identifies a related resource that is potentially large and might require special handling.", - "first": - "An IRI that refers to the furthest preceding resource in a series of resources.", + "convertedFrom": "The document linked to was later converted to the document that contains this link relation. For example, an RFC can have a link to the Internet-Draft that became the RFC; in that case, the link relation would be `convertedFrom`.", + "copyright": "Refers to a copyright statement that applies to the link's context.", + "create-form": "The target IRI points to a resource where a submission form can be obtained.", + "current": "Refers to a resource containing the most recent item(s) in a collection of resources.", + "describedby": "Refers to a resource providing information about the link's context.", + "describes": "The relationship A 'describes' B asserts that resource A provides a description of resource B. There are no constraints on the format or representation of either A or B, neither are there any further constraints on either resource.", + "disclosure": "Refers to a list of patent disclosures made with respect to material for which 'disclosure' relation is specified.", + "dns-prefetch": "Used to indicate an origin that will be used to fetch required resources for the link context, and that the user agent ought to resolve as early as possible.", + "duplicate": "Refers to a resource whose available representations are byte-for-byte identical with the corresponding representations of the context IRI.", + "edit": "Refers to a resource that can be used to edit the link's context.", + "edit-form": "The target IRI points to a resource where a submission form for editing associated resource can be obtained.", + "edit-media": "Refers to a resource that can be used to edit media associated with the link's context.", + "enclosure": "Identifies a related resource that is potentially large and might require special handling.", + "first": "An IRI that refers to the furthest preceding resource in a series of resources.", "glossary": "Refers to a glossary of terms.", "help": "Refers to context-sensitive help.", - "hosts": - "Refers to a resource hosted by the server indicated by the link context.", - "hub": - "Refers to a hub that enables registration for notification of updates to the context.", + "hosts": "Refers to a resource hosted by the server indicated by the link context.", + "hub": "Refers to a hub that enables registration for notification of updates to the context.", "icon": "Refers to an icon representing the link's context.", "index": "Refers to an index.", - "item": - "The target IRI points to a resource that is a member of the collection represented by the context IRI.", - "last": - "An IRI that refers to the furthest following resource in a series of resources.", - "latest-version": - "Points to a resource containing the latest (e.g., current) version of the context.", + "item": "The target IRI points to a resource that is a member of the collection represented by the context IRI.", + "last": "An IRI that refers to the furthest following resource in a series of resources.", + "latest-version": "Points to a resource containing the latest (e.g., current) version of the context.", "license": "Refers to a license associated with this context.", - "lrdd": - "Refers to further information about the link's context, expressed as a LRDD (\"Link-based Resource Descriptor Document\") resource. See [RFC6415] for information about processing this relation type in host-meta documents. When used elsewhere, it refers to additional links and other metadata. Multiple instances indicate additional LRDD resources. LRDD resources MUST have an `application/xrd+xml` representation, and MAY have others.", - "memento": - "The Target IRI points to a Memento, a fixed resource that will not change state anymore.", - "monitor": - "Refers to a resource that can be used to monitor changes in an HTTP resource.", - "monitor-group": - "Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.", - "next": - "Indicates that the link's context is a part of a series, and that the next in the series is the link target.", - "next-archive": - "Refers to the immediately following archive resource.", - "nofollow": - "Indicates that the context’s original author or publisher does not endorse the link target.", - "noreferrer": - "Indicates that no referrer information is to be leaked when following the link.", + "lrdd": "Refers to further information about the link's context, expressed as a LRDD (\"Link-based Resource Descriptor Document\") resource. See [RFC6415] for information about processing this relation type in host-meta documents. When used elsewhere, it refers to additional links and other metadata. Multiple instances indicate additional LRDD resources. LRDD resources MUST have an `application/xrd+xml` representation, and MAY have others.", + "memento": "The Target IRI points to a Memento, a fixed resource that will not change state anymore.", + "monitor": "Refers to a resource that can be used to monitor changes in an HTTP resource.", + "monitor-group": "Refers to a resource that can be used to monitor changes in a specified group of HTTP resources.", + "next": "Indicates that the link's context is a part of a series, and that the next in the series is the link target.", + "next-archive": "Refers to the immediately following archive resource.", + "nofollow": "Indicates that the context’s original author or publisher does not endorse the link target.", + "noreferrer": "Indicates that no referrer information is to be leaked when following the link.", "original": "The Target IRI points to an Original Resource.", "payment": "Indicates a resource where payment is accepted.", - "pingback": - "Gives the address of the pingback resource for the link context.", - "preconnect": - "Used to indicate an origin that will be used to fetch required resources for the link context. Initiating an early connection, which includes the DNS lookup, TCP handshake, and optional TLS negotiation, allows the user agent to mask the high latency costs of establishing a connection.", - "predecessor-version": - "Points to a resource containing the predecessor version in the version history.", - "prefetch": - "The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.", - "preload": - "Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.", - "prerender": - "Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.", - "prev": - "Indicates that the link's context is a part of a series, and that the previous in the series is the link target.", - "preview": - "Refers to a resource that provides a preview of the link's context.", - "previous": - "Refers to the previous resource in an ordered series of resources. Synonym for `prev`.", - "prev-archive": - "Refers to the immediately preceding archive resource.", - "privacy-policy": - "Refers to a privacy policy associated with the link's context.", - "profile": - "Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.", + "pingback": "Gives the address of the pingback resource for the link context.", + "preconnect": "Used to indicate an origin that will be used to fetch required resources for the link context. Initiating an early connection, which includes the DNS lookup, TCP handshake, and optional TLS negotiation, allows the user agent to mask the high latency costs of establishing a connection.", + "predecessor-version": "Points to a resource containing the predecessor version in the version history.", + "prefetch": "The prefetch link relation type is used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch, such that the user agent can deliver a faster response once the resource is requested in the future.", + "preload": "Refers to a resource that should be loaded early in the processing of the link's context, without blocking rendering.", + "prerender": "Used to identify a resource that might be required by the next navigation from the link context, and that the user agent ought to fetch and execute, such that the user agent can deliver a faster response once the resource is requested in the future.", + "prev": "Indicates that the link's context is a part of a series, and that the previous in the series is the link target.", + "preview": "Refers to a resource that provides a preview of the link's context.", + "previous": "Refers to the previous resource in an ordered series of resources. Synonym for `prev`.", + "prev-archive": "Refers to the immediately preceding archive resource.", + "privacy-policy": "Refers to a privacy policy associated with the link's context.", + "profile": "Identifying that a resource representation conforms to a certain profile, without affecting the non-profile semantics of the resource representation.", "related": "Identifies a related resource.", - "restconf": - "Identifies the root of RESTCONF API as configured on this HTTP server. The `restconf` relation defines the root of the API defined in RFC8040. Subsequent revisions of RESTCONF will use alternate relation values to support protocol versioning.", - "replies": - "Identifies a resource that is a reply to the context of the link.", - "search": - "Refers to a resource that can be used to search through the link's context and related resources.", + "restconf": "Identifies the root of RESTCONF API as configured on this HTTP server. The `restconf` relation defines the root of the API defined in RFC8040. Subsequent revisions of RESTCONF will use alternate relation values to support protocol versioning.", + "replies": "Identifies a resource that is a reply to the context of the link.", + "search": "Refers to a resource that can be used to search through the link's context and related resources.", "section": "Refers to a section in a collection of resources.", "self": "Conveys an identifier for the link's context.", - "service": - "Indicates a URI that can be used to retrieve a service document.", - "start": - "Refers to the first resource in a collection of resources.", + "service": "Indicates a URI that can be used to retrieve a service document.", + "start": "Refers to the first resource in a collection of resources.", "stylesheet": "Refers to a stylesheet.", - "subsection": - "Refers to a resource serving as a subsection in a collection of resources.", - "successor-version": - "Points to a resource containing the successor version in the version history.", - "tag": - "Gives a tag (identified by the given address) that applies to the current document.", - "terms-of-service": - "Refers to the terms of service associated with the link's context.", - "timegate": - "The Target IRI points to a TimeGate for an Original Resource.", - "timemap": - "The Target IRI points to a TimeMap for an Original Resource.", - "type": - "Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.", + "subsection": "Refers to a resource serving as a subsection in a collection of resources.", + "successor-version": "Points to a resource containing the successor version in the version history.", + "tag": "Gives a tag (identified by the given address) that applies to the current document.", + "terms-of-service": "Refers to the terms of service associated with the link's context.", + "timegate": "The Target IRI points to a TimeGate for an Original Resource.", + "timemap": "The Target IRI points to a TimeMap for an Original Resource.", + "type": "Refers to a resource identifying the abstract semantic type of which the link's context is considered to be an instance.", "up": "Refers to a parent document in a hierarchy of documents.", - "version-history": - "Points to a resource containing the version history for the context.", - "via": - "Identifies a resource that is the source of the information in the link's context.", - "webmention": - "Identifies a target URI that supports the Webmention protcol. This allows clients that mention a resource in some form of publishing process to contact that endpoint and inform it that this resource has been mentioned.", + "version-history": "Points to a resource containing the version history for the context.", + "via": "Identifies a resource that is the source of the information in the link's context.", + "webmention": "Identifies a target URI that supports the Webmention protcol. This allows clients that mention a resource in some form of publishing process to contact that endpoint and inform it that this resource has been mentioned.", "working-copy": "Points to a working copy for this resource.", - "working-copy-of": - "Points to the versioned resource from which this working copy was obtained." + "working-copy-of": "Points to the versioned resource from which this working copy was obtained." }, "patternProperties": { "^[a-z]+[a-z0-9\\.-]*$": { @@ -355,15 +230,13 @@ }, { "type": "object", - "description": - "`_embedded` can contain any object or resource." + "description": "`_embedded` can contain any object or resource." }, { "type": "array", "items": { "type": "object", - "description": - "`_embedded` can contain any object or resource." + "description": "`_embedded` can contain any object or resource." } } ] @@ -382,23 +255,20 @@ }, { "type": "object", - "description": - "`_embedded` can contain any object or resource." + "description": "`_embedded` can contain any object or resource." }, { "type": "array", "minItems": 1, "items": { "type": "object", - "description": - "`_embedded` can contain any object or resource." + "description": "`_embedded` can contain any object or resource." } } ] } }, - "description": - "It is an object whose property names are link relation types (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)) and values are either a Resource Object or an array of Resource Objects.\\n\\nEmbedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI." + "description": "It is an object whose property names are link relation types (as defined by [RFC5988](https://tools.ietf.org/html/rfc5988)) and values are either a Resource Object or an array of Resource Objects.\\n\\nEmbedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI." } } } diff --git a/schemas/external/iptc/creator.schema.json b/schemas/external/iptc/creator.schema.json index 41f55c825..fe932820c 100644 --- a/schemas/external/iptc/creator.schema.json +++ b/schemas/external/iptc/creator.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Creator", "type": "object", - "description": - "The creator of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "description": "The creator of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", "definitions": { "creator": { "properties": { diff --git a/schemas/external/iptc/episode.schema.json b/schemas/external/iptc/episode.schema.json index 0442ace40..3aa1eb685 100644 --- a/schemas/external/iptc/episode.schema.json +++ b/schemas/external/iptc/episode.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Episode", "type": "object", - "description": - "The season the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "description": "The season the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", "definitions": { "episode": { "properties": { diff --git a/schemas/external/iptc/rating.schema.json b/schemas/external/iptc/rating.schema.json index 17351a138..e688e7f8a 100644 --- a/schemas/external/iptc/rating.schema.json +++ b/schemas/external/iptc/rating.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Rating", "type": "object", - "description": - "The rating of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "description": "The rating of the show. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", "definitions": { "rating": { "properties": { @@ -23,8 +22,7 @@ "title": "Rating Source Link", "type": "string", "format": "uri", - "description": - "Link to the site and optionally the page of the party which has issued the rating value, linked resource should explain the rating rules." + "description": "Link to the site and optionally the page of the party which has issued the rating value, linked resource should explain the rating rules." } }, "required": ["iptc4xmpExt:RatingValue", "iptc4xmpExt:RatingSourceLink"] diff --git a/schemas/external/iptc/season.schema.json b/schemas/external/iptc/season.schema.json index afa09aab4..545a80fd4 100644 --- a/schemas/external/iptc/season.schema.json +++ b/schemas/external/iptc/season.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Season", "type": "object", - "description": - "The season the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "description": "The season the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", "definitions": { "season": { "properties": { diff --git a/schemas/external/iptc/series.schema.json b/schemas/external/iptc/series.schema.json index b35beb6ad..3e25da1ab 100644 --- a/schemas/external/iptc/series.schema.json +++ b/schemas/external/iptc/series.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Series", "type": "object", - "description": - "The series the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", + "description": "The series the show belongs to. Based on [www.iptc.org](https://www.iptc.org/std/videometadatahub/recommendation/pre-versions/IPTC-VideoMetadataHub-props-Rec_1.1.html)", "definitions": { "series": { "properties": { diff --git a/schemas/external/repo/accesscontrolentry.schema.json b/schemas/external/repo/accesscontrolentry.schema.json index 9cd2df1f4..22f2840ac 100644 --- a/schemas/external/repo/accesscontrolentry.schema.json +++ b/schemas/external/repo/accesscontrolentry.schema.json @@ -8,8 +8,7 @@ "$id": "https://ns.adobe.com/xdm/external/repo/accesscontrolentry", "$schema": "http://json-schema.org/draft-06/schema#", "title": "Access Control Entry", - "description": - "Schema for the Access Control Entry for the Access Control List of a resource", + "description": "Schema for the Access Control Entry for the Access Control List of a resource", "type": "object", "definitions": { "acl": { @@ -29,13 +28,10 @@ "$ref": "https://ns.adobe.com/xdm/common/principal" }, { - "description": - "A special principal to which the entry applies. 'Authenticated' refers to any authenticated user, 'Unauthenticated' refers to an unknown user, 'all' refers to any user regardless of authenticated or not.", + "description": "A special principal to which the entry applies. 'Authenticated' refers to any authenticated user, 'Unauthenticated' refers to an unknown user, 'all' refers to any user regardless of authenticated or not.", "meta:enum": { - "authenticated": - "A special Principal which is implicitly part of any Subject relating to an authenticated (identified) user.", - "unauthenticated": - "A special Principal representing an unknown user. If a session is established without credentials, such as an HTTP request without the Authentication header, a Subject is used consisting of the Unauthenticated Principal.", + "authenticated": "A special Principal which is implicitly part of any Subject relating to an authenticated (identified) user.", + "unauthenticated": "A special Principal representing an unknown user. If a session is established without credentials, such as an HTTP request without the Authentication header, a Subject is used consisting of the Unauthenticated Principal.", "all": "A special Principal representing all users." } } @@ -49,16 +45,14 @@ } }, "repo:relations": { - "description": - "List of relation link types to which this privilege applies", + "description": "List of relation link types to which this privilege applies", "type": "array", "items": { "type": "string" } }, "repo:modifier": { - "description": - "Optional modified to the privilege: either grant or deny to grant or deny, resp., the privilege. The default modifier is grant if this property is missing or has an invalid value.", + "description": "Optional modified to the privilege: either grant or deny to grant or deny, resp., the privilege. The default modifier is grant if this property is missing or has an invalid value.", "type": "string", "meta:enum": { "grant": "Permission is granted to the Principal.", @@ -67,12 +61,10 @@ "default": "grant" }, "repo:inheritance": { - "description": - "Optional inheritance of the ace: whether the deny or grant is inherited by the children of the resource. The default inheritance is deep if this property is missing or has an invalid value.", + "description": "Optional inheritance of the ace: whether the deny or grant is inherited by the children of the resource. The default inheritance is deep if this property is missing or has an invalid value.", "type": "string", "meta:enum": { - "deep": - "Deny or grant applies to the resource and to all children of the resource.", + "deep": "Deny or grant applies to the resource and to all children of the resource.", "self": "Deny or grant only applies to the resource." }, "default": "deep" diff --git a/schemas/external/repo/accesscontrolpolicy.schema.json b/schemas/external/repo/accesscontrolpolicy.schema.json index 5e23b67a1..2bf85a676 100644 --- a/schemas/external/repo/accesscontrolpolicy.schema.json +++ b/schemas/external/repo/accesscontrolpolicy.schema.json @@ -15,8 +15,7 @@ "type": "object", "properties": { "repo:acl": { - "$ref": - "https://ns.adobe.com/xdm/external/repo/accesscontrolentry#/definitions/acl" + "$ref": "https://ns.adobe.com/xdm/external/repo/accesscontrolentry#/definitions/acl" } } } diff --git a/schemas/external/repo/asset.schema.json b/schemas/external/repo/asset.schema.json index e7246f96d..d86c5abb3 100644 --- a/schemas/external/repo/asset.schema.json +++ b/schemas/external/repo/asset.schema.json @@ -15,8 +15,7 @@ "https://ns.adobe.com/xdm/external/hal/resource#/definitions/hal" ], "meta:extensible": true, - "description": - "An asset in Adobe Cloud Platform. It is not neccessarily a Digital Asset in the sense of Digital Asset Management, but a piece of content or data that can be represented in the form of a file.", + "description": "An asset in Adobe Cloud Platform. It is not neccessarily a Digital Asset in the sense of Digital Asset Management, but a piece of content or data that can be represented in the form of a file.", "definitions": { "asset": { "properties": { @@ -24,23 +23,20 @@ "type": "string", "meta:immutable": true, "meta:usereditable": false, - "description": - "A unique identifier given to every addressable asset in a given repository.", + "description": "A unique identifier given to every addressable asset in a given repository.", "examples": ["urn:aaid:sc:US:6dc33479-13ca-4b19-b25d-c805eff8a69e"] }, "repo:etag": { "meta:usereditable": false, "type": "string", "title": "ETag", - "description": - "An ETag is an HTTP response header returned by an HTTP/1.1 compliant web server used to determine change in content of a resource at a given URL. " + "description": "An ETag is an HTTP response header returned by an HTTP/1.1 compliant web server used to determine change in content of a resource at a given URL. " }, "repo:version": { "type": "string", "meta:immutable": true, "meta:usereditable": false, - "description": - "The version ID of the piece of content. It will be generated both on explicit and implicit save or upload." + "description": "The version ID of the piece of content. It will be generated both on explicit and implicit save or upload." }, "tiff:imageWidth": { "title": "Width", @@ -52,8 +48,7 @@ }, "tiff:imageLength": { "title": "Length", - "description": - "Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property `imageLength`. The duration of the video (also commonly called length) is specified in the property `extent`", + "description": "Height in pixels. To maintain continuity with the XMP and TIFF standards, the height of an image or video is specified in the property `imageLength`. The duration of the video (also commonly called length) is specified in the property `extent`", "type": "integer", "meta:usereditable": false, "minimum": 0, @@ -73,12 +68,10 @@ "$ref": "#/definitions/asset" }, { - "$ref": - "http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties" + "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties" }, { - "$ref": - "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties" + "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties" }, { "$ref": "https://ns.adobe.com/xdm/external/hal/resource#/definitions/hal" diff --git a/schemas/external/repo/common.schema.json b/schemas/external/repo/common.schema.json index 515335c7a..6e72d7ff7 100644 --- a/schemas/external/repo/common.schema.json +++ b/schemas/external/repo/common.schema.json @@ -25,8 +25,7 @@ "title": "Format", "pattern": "\\w+\\/[-.\\w]+(?:\\+[-.\\w]+)?", "examples": ["application/vnd.adobe.photoshop"], - "description": - "The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats)." + "description": "The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats)." } } }, @@ -38,16 +37,14 @@ "meta:immutable": true, "meta:usereditable": false, "examples": ["2004-10-23T12:00:00-06:00"], - "description": - "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The Date Time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\"." + "description": "The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The Date Time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\"." }, "repo:lastModifiedDate": { "type": "string", "format": "date-time", "meta:usereditable": false, "examples": ["2004-10-23T12:00:00-06:00"], - "description": - "The server date and time when the resource was most recently modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The Date Time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\"." + "description": "The server date and time when the resource was most recently modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The Date Time property should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\"." } } } diff --git a/schemas/external/repo/directory.schema.json b/schemas/external/repo/directory.schema.json index 6993cc554..67fda9c2b 100644 --- a/schemas/external/repo/directory.schema.json +++ b/schemas/external/repo/directory.schema.json @@ -25,8 +25,7 @@ }, "_page": { "$ref": "https://ns.adobe.com/xdm/common/page", - "description": - "Page info, included if this resource is part of paginated result." + "description": "Page info, included if this resource is part of paginated result." }, "children": { "type": "array", @@ -49,12 +48,10 @@ "$ref": "#/definitions/directory" }, { - "$ref": - "http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties" + "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties" }, { - "$ref": - "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties" + "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties" }, { "$ref": "https://ns.adobe.com/xdm/external/hal/resource#/definitions/hal" diff --git a/schemas/external/repo/sub-directory.schema.json b/schemas/external/repo/sub-directory.schema.json index 98d20a697..a625be396 100644 --- a/schemas/external/repo/sub-directory.schema.json +++ b/schemas/external/repo/sub-directory.schema.json @@ -31,8 +31,7 @@ "$ref": "#/definitions/sub-directory" }, { - "$ref": - "http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties" + "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/common-properties" }, { "$ref": "https://ns.adobe.com/xdm/external/hal/resource#/definitions/hal" diff --git a/schemas/external/schema/geocircle.schema.json b/schemas/external/schema/geocircle.schema.json index ef03eb263..d1197aaeb 100644 --- a/schemas/external/schema/geocircle.schema.json +++ b/schemas/external/schema/geocircle.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Geo Circle", "type": "object", - "description": - "A circular region of a particular radius centered on a GeoCoordinate. Based on [schema.org](http://schema.org/GeoCircle)", + "description": "A circular region of a particular radius centered on a GeoCoordinate. Based on [schema.org](http://schema.org/GeoCircle)", "definitions": { "geocircle": { "properties": { @@ -32,8 +31,7 @@ "schema:radius": { "title": "Radius", "type": "number", - "description": - "The length of the radius of the circle. This value conforms to the WGS84 datum and is measured in meters." + "description": "The length of the radius of the circle. This value conforms to the WGS84 datum and is measured in meters." } } } diff --git a/schemas/external/schema/geocoordinates.schema.json b/schemas/external/schema/geocoordinates.schema.json index b564d19b5..cd3a7c775 100644 --- a/schemas/external/schema/geocoordinates.schema.json +++ b/schemas/external/schema/geocoordinates.schema.json @@ -10,8 +10,7 @@ "title": "Geo Coordinates", "type": "object", "meta:extensible": true, - "description": - "The geographic coordinates of a place. Based on [schema.org](http://schema.org/GeoCoordinates).", + "description": "The geographic coordinates of a place. Based on [schema.org](http://schema.org/GeoCoordinates).", "definitions": { "geocoordinates": { "properties": { @@ -38,14 +37,12 @@ "type": "number", "minimum": -180, "maximum": 180, - "description": - "The signed horizontal coordinate of a geographic point." + "description": "The signed horizontal coordinate of a geographic point." }, "schema:elevation": { "title": "Elevation", "type": "number", - "description": - "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters." + "description": "The specific elevation of the defined coordinate. The value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters." } } } diff --git a/schemas/external/schema/geoshape.schema.json b/schemas/external/schema/geoshape.schema.json index a6a3ce37e..798aa305c 100644 --- a/schemas/external/schema/geoshape.schema.json +++ b/schemas/external/schema/geoshape.schema.json @@ -9,8 +9,7 @@ "$schema": "http://json-schema.org/draft-06/schema#", "title": "Geo Shape", "type": "object", - "description": - "The geographic shape of a place. Based on [schema.org](http://schema.org/GeoShape).", + "description": "The geographic shape of a place. Based on [schema.org](http://schema.org/GeoShape).", "definitions": { "geoshape": { "properties": { @@ -30,15 +29,13 @@ "items": { "$ref": "http://schema.org/GeoCoordinates" }, - "description": - "A series of four or more coordinates where the first and final coordinates are identical. In schema.org, this is a plain text. In XDM, it is a structured array instead.", + "description": "A series of four or more coordinates where the first and final coordinates are identical. In schema.org, this is a plain text. In XDM, it is a structured array instead.", "minItems": 4 }, "schema:circle": { "title": "Circle", "$ref": "http://schema.org/GeoCircle", - "description": - "A circular region with a specific radius centered on a geographic coordinate." + "description": "A circular region with a specific radius centered on a geographic coordinate." }, "schema:box": { "title": "Box", @@ -46,22 +43,19 @@ "items": { "$ref": "http://schema.org/GeoCoordinates" }, - "description": - "The area enclosed by the rectangle formed by two coordinates. The first coordinate is the lower corner and the second coordinate is the upper corner of a rectangle.", + "description": "The area enclosed by the rectangle formed by two coordinates. The first coordinate is the lower corner and the second coordinate is the upper corner of a rectangle.", "minItems": 2, "maxItems": 2 }, "schema:elevation": { "title": "Elevation", "type": "number", - "description": - "The specific or minimum elevation of the shape. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. In combination with `ceiling`, this property can be used to express a three-dimensional bounding box for a location." + "description": "The specific or minimum elevation of the shape. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. In combination with `ceiling`, this property can be used to express a three-dimensional bounding box for a location." }, "xdm:ceiling": { "title": "Ceiling", "type": "number", - "description": - "The maximum elevation of the shape. Only valid when used in combination with `elevation`. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. This value is not part of the schema.org spec. In combination with `elevation`, this property can be used to express a three-dimensional bounding box for a location." + "description": "The maximum elevation of the shape. Only valid when used in combination with `elevation`. This value conforms to the [WGS84](http://gisgeography.com/wgs84-world-geodetic-system/) datum and is measured in meters. This value is not part of the schema.org spec. In combination with `elevation`, this property can be used to express a three-dimensional bounding box for a location." } } }