diff --git a/components/behaviors/adhoc.schema.json b/components/behaviors/adhoc.schema.json index 24a0a9119..09eed0046 100644 --- a/components/behaviors/adhoc.schema.json +++ b/components/behaviors/adhoc.schema.json @@ -1,22 +1,30 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/adhoc", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Ad Hoc Schema", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "description" : "Used to indicate the behavior of the Ad hoc data semantic when composed into data Schemas. The Ad hoc semantic scope is limited to just the local schema, and no compatibility can be assumed between schemas.", - "definitions" : { - "adhoc" : { - "properties" : { } + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/adhoc", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad Hoc Schema", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Used to indicate the behavior of the Ad hoc data semantic when composed into data Schemas. The Ad hoc semantic scope is limited to just the local schema, and no compatibility can be assumed between schemas.", + "definitions": { + "adhoc": { + "properties": {} } }, - "allOf" : [ { - "$ref" : "#/definitions/adhoc" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/adhoc" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/behaviors/record.schema.json b/components/behaviors/record.schema.json index 36b922f8c..c328b3799 100644 --- a/components/behaviors/record.schema.json +++ b/components/behaviors/record.schema.json @@ -1,29 +1,37 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/record", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Record Schema", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "description" : "Used to indicate the behavior of record data semantic when composed into data schemas.", - "definitions" : { - "record" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "A unique identifier for the record." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/record", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Record Schema", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Used to indicate the behavior of record data semantic when composed into data schemas.", + "definitions": { + "record": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the record." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/record" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/behaviors/time-series.schema.json b/components/behaviors/time-series.schema.json index f9710c311..6de902b51 100644 --- a/components/behaviors/time-series.schema.json +++ b/components/behaviors/time-series.schema.json @@ -1,85 +1,93 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/time-series", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Time-series Schema", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "description" : "Used to indicate the behavior of time partitioned semantics when composed into data schemas.", - "definitions" : { - "time-series" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "A unique identifier for the time-series event." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/time-series", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Time-series Schema", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "Used to indicate the behavior of time partitioned semantics when composed into data schemas.", + "definitions": { + "time-series": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the time-series event." }, - "xdm:timestamp" : { - "title" : "Timestamp", - "type" : "string", - "format" : "date-time", - "description" : "The time when an event or observation occurred." + "xdm:timestamp": { + "title": "Timestamp", + "type": "string", + "format": "date-time", + "description": "The time when an event or observation occurred." }, - "xdm:eventType" : { - "title" : "Event Type", - "type" : "string", - "description" : "The primary event type for this time-series record.", - "meta:enum" : { - "advertising.completes" : "Advertising Completes", - "advertising.timePlayed" : "Advertising Time Played", - "advertising.federated" : "Advertising Federated", - "advertising.clicks" : "Advertising Clicks", - "advertising.conversions" : "Advertising Conversions", - "advertising.firstQuartiles" : "Advertising First Quartiles", - "advertising.impressions" : "Advertising Impressions", - "advertising.midpoints" : "Advertising Midpoints", - "advertising.starts" : "Advertising Starts", - "advertising.thirdQuartiles" : "Advertising Third Quartiles", - "web.webpagedetails.pageViews" : "Web Webpagedetails Page Views", - "web.webinteraction.linkClicks" : "Web Webinteraction Link Clicks", - "web.formFilledOut" : "Web Form Filled Out", - "commerce.checkouts" : "Commerce Checkouts", - "commerce.productListAdds" : "Commerce Product List Adds", - "commerce.productListOpens" : "Commerce Product List Opens", - "commerce.productListRemovals" : "Commerce Product List Removals", - "commerce.productListReopens" : "Commerce Product List Reopens", - "commerce.productListViews" : "Commerce Product List Views", - "commerce.productViews" : "Commerce Product Views", - "commerce.purchases" : "Commerce Purchases", - "commerce.saveForLaters" : "Commerce Save For Laters", - "delivery.feedback" : "Delivery Feedback", - "message.feedback" : "Message Feedback", - "message.tracking" : "Message Tracking", - "pushTracking.applicationOpened" : "Push Tracking Application Opened", - "pushTracking.customAction" : "Push Tracking Custom Action", - "listOperation.removeFromList" : "List Operation Remove From List", - "listOperation.addToList" : "List Operation Add To List", - "leadOperation.scoreChanged" : "Lead Operation Score Changed", - "leadOperation.statusInCampaignProgressionChanged" : "Lead Operation Status In Campaign Progression Changed", - "leadOperation.interestingMoment" : "Lead Operation Interesting Moment", - "leadOperation.newLead" : "Lead Operation New Lead", - "leadOperation.convertLead" : "Lead Operation Convert Lead", - "directMarketing.emailBounced" : "Direct Marketing Email Bounced", - "directMarketing.emailBouncedSoft" : "Direct Marketing Email Bounced Soft", - "directMarketing.emailDelivered" : "Direct Marketing Email Delivered", - "directMarketing.emailUnsubscribed" : "Direct Marketing Email Unsubscribed", - "directMarketing.emailOpened" : "Direct Marketing Email Opened", - "directMarketing.emailClicked" : "Direct Marketing Email Clicked", - "opportunityEvent.removeFromOpportunity" : "Opportunity Event Remove From Opportunity", - "opportunityEvent.addToOpportunity" : "Opportunity Event Add To Opportunity", - "opportunityevent.opportunityUpdated" : "Opportunity Event Opportunity Updated" + "xdm:eventType": { + "title": "Event Type", + "type": "string", + "description": "The primary event type for this time-series record.", + "meta:enum": { + "advertising.completes": "Advertising Completes", + "advertising.timePlayed": "Advertising Time Played", + "advertising.federated": "Advertising Federated", + "advertising.clicks": "Advertising Clicks", + "advertising.conversions": "Advertising Conversions", + "advertising.firstQuartiles": "Advertising First Quartiles", + "advertising.impressions": "Advertising Impressions", + "advertising.midpoints": "Advertising Midpoints", + "advertising.starts": "Advertising Starts", + "advertising.thirdQuartiles": "Advertising Third Quartiles", + "web.webpagedetails.pageViews": "Web Webpagedetails Page Views", + "web.webinteraction.linkClicks": "Web Webinteraction Link Clicks", + "web.formFilledOut": "Web Form Filled Out", + "commerce.checkouts": "Commerce Checkouts", + "commerce.productListAdds": "Commerce Product List Adds", + "commerce.productListOpens": "Commerce Product List Opens", + "commerce.productListRemovals": "Commerce Product List Removals", + "commerce.productListReopens": "Commerce Product List Reopens", + "commerce.productListViews": "Commerce Product List Views", + "commerce.productViews": "Commerce Product Views", + "commerce.purchases": "Commerce Purchases", + "commerce.saveForLaters": "Commerce Save For Laters", + "delivery.feedback": "Delivery Feedback", + "message.feedback": "Message Feedback", + "message.tracking": "Message Tracking", + "pushTracking.applicationOpened": "Push Tracking Application Opened", + "pushTracking.customAction": "Push Tracking Custom Action", + "listOperation.removeFromList": "List Operation Remove From List", + "listOperation.addToList": "List Operation Add To List", + "leadOperation.scoreChanged": "Lead Operation Score Changed", + "leadOperation.statusInCampaignProgressionChanged": "Lead Operation Status In Campaign Progression Changed", + "leadOperation.interestingMoment": "Lead Operation Interesting Moment", + "leadOperation.newLead": "Lead Operation New Lead", + "leadOperation.convertLead": "Lead Operation Convert Lead", + "directMarketing.emailBounced": "Direct Marketing Email Bounced", + "directMarketing.emailBouncedSoft": "Direct Marketing Email Bounced Soft", + "directMarketing.emailDelivered": "Direct Marketing Email Delivered", + "directMarketing.emailUnsubscribed": "Direct Marketing Email Unsubscribed", + "directMarketing.emailOpened": "Direct Marketing Email Opened", + "directMarketing.emailClicked": "Direct Marketing Email Clicked", + "opportunityEvent.removeFromOpportunity": "Opportunity Event Remove From Opportunity", + "opportunityEvent.addToOpportunity": "Opportunity Event Add To Opportunity", + "opportunityevent.opportunityUpdated": "Opportunity Event Opportunity Updated" } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/time-series" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/time-series" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/classes/campaign-member.schema.json b/components/classes/campaign-member.schema.json index a17546577..7cb2b6738 100644 --- a/components/classes/campaign-member.schema.json +++ b/components/classes/campaign-member.schema.json @@ -1,42 +1,51 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/campaign-member", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Campaign Members", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record" ], - "description" : "An XDM Business Campaign Member,which relates members such as contact/lead to a campaign.", - "definitions" : { - "campaign-member" : { - "properties" : { - "xdm:campaignMemberID" : { - "title" : "Campaign Member ID", - "description" : "Campaign Member unique identifer.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/campaign-member", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Members", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "description": "An XDM Business Campaign Member,which relates members such as contact/lead to a campaign.", + "definitions": { + "campaign-member": { + "properties": { + "xdm:campaignMemberID": { + "title": "Campaign Member ID", + "description": "Campaign Member unique identifer.", + "type": "string" }, - "xdm:campaignID" : { - "title" : "Campaign ID", - "description" : "Campaign Unique Identifer.", - "type" : "string" + "xdm:campaignID": { + "title": "Campaign ID", + "description": "Campaign Unique Identifer.", + "type": "string" }, - "xdm:personID" : { - "title" : "Person ID", - "description" : "Person unique identifier.", - "type" : "string" + "xdm:personID": { + "title": "Person ID", + "description": "Person unique identifier.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/external-source-system-audit-details" - }, { - "$ref" : "#/definitions/campaign-member" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-08-18" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "#/definitions/campaign-member" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-08-18" +} diff --git a/components/classes/campaign.schema.json b/components/classes/campaign.schema.json index 4f53bcdb8..a37165deb 100644 --- a/components/classes/campaign.schema.json +++ b/components/classes/campaign.schema.json @@ -1,49 +1,59 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/classes/campaign", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Campaign", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record" ], - "description" : "This class is used to capture minimum properties that are required to define xdm business campaign concept.", - "definitions" : { - "campaign" : { - "properties" : { - "xdm:campaignID" : { - "title" : "Campaign ID", - "description" : "Unique identifer for campaign.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/classes/campaign", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "description": "This class is used to capture minimum properties that are required to define xdm business campaign concept.", + "definitions": { + "campaign": { + "properties": { + "xdm:campaignID": { + "title": "Campaign ID", + "description": "Unique identifer for campaign.", + "type": "string" }, - "xdm:campaignName" : { - "title" : "Campaign Name", - "description" : "Friendly name for campaign.", - "type" : "string" + "xdm:campaignName": { + "title": "Campaign Name", + "description": "Friendly name for campaign.", + "type": "string" }, - "xdm:campaignType" : { - "title" : "Campaign Type", - "description" : "The type of campaign for which audience gets selected.", - "type" : "string" + "xdm:campaignType": { + "title": "Campaign Type", + "description": "The type of campaign for which audience gets selected.", + "type": "string" }, - "xdm:campaignDescription" : { - "title" : "Campaign Description", - "description" : "Campaign description.", - "type" : "string" + "xdm:campaignDescription": { + "title": "Campaign Description", + "description": "Campaign description.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/external-source-system-audit-details" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/campaign" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-09-29" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/campaign" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-09-29" +} diff --git a/components/classes/experienceevent.schema.json b/components/classes/experienceevent.schema.json index aa92e42df..e62f24417 100644 --- a/components/classes/experienceevent.schema.json +++ b/components/classes/experienceevent.schema.json @@ -1,37 +1,50 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM ExperienceEvent", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM ExperienceEvent", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/time-series", "https://ns.adobe.com/xdm/context/identitymap" ], - "description" : "An ExperienceEvent is a fact record of what occurred, including the point in time and identity of the individual involved. ExperienceEvents can be either explicit (directly observable human actions) or implicit (raised without a direct human action) and are recorded without aggregation or interpretation. They are critical for time-domain analytics as they allow for observation and analysis of changes that occur in a given window of time and the comparison between multiple windows of time to track trends.", - "definitions" : { - "experienceevent" : { - "properties" : { - "xdm:eventMergeId" : { - "title" : "ExperienceEvent merge ID", - "type" : "string", - "description" : "An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion." + "meta:extends": [ + "https://ns.adobe.com/xdm/data/time-series", + "https://ns.adobe.com/xdm/context/identitymap" + ], + "description": "An ExperienceEvent is a fact record of what occurred, including the point in time and identity of the individual involved. ExperienceEvents can be either explicit (directly observable human actions) or implicit (raised without a direct human action) and are recorded without aggregation or interpretation. They are critical for time-domain analytics as they allow for observation and analysis of changes that occur in a given window of time and the comparison between multiple windows of time to track trends.", + "definitions": { + "experienceevent": { + "properties": { + "xdm:eventMergeId": { + "title": "ExperienceEvent merge ID", + "type": "string", + "description": "An ID to correlate or merge multiple Experience events together that are essentially the same event or should be merged. This is intended to be populated by the data producer prior to ingestion." } } } }, - "required" : [ "@id", "xdm:timestamp" ], - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/identitymap" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/time-series" - }, { - "$ref" : "#/definitions/experienceevent" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "required": ["@id", "xdm:timestamp"], + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/time-series" + }, + { + "$ref": "#/definitions/experienceevent" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/classes/fsi/atm.schema.json b/components/classes/fsi/atm.schema.json index 95061deff..0148eba09 100644 --- a/components/classes/fsi/atm.schema.json +++ b/components/classes/fsi/atm.schema.json @@ -1,47 +1,55 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/classes/fsi/atm", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "ATM", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/classes/fsi/atm", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ATM", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record" ], - "description" : "For ATM information such as active status, addrerss, ID and name. ", - "definitions" : { - "atm" : { - "properties" : { - "xdm:isAtmActive" : { - "title" : "Is ATM Active", - "type" : "boolean", - "description" : "Yes/no if the ATM is currently active." + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "description": "For ATM information such as active status, addrerss, ID and name. ", + "definitions": { + "atm": { + "properties": { + "xdm:isAtmActive": { + "title": "Is ATM Active", + "type": "boolean", + "description": "Yes/no if the ATM is currently active." }, - "xdm:atmAddress" : { - "title" : "ATM Address", - "$ref" : "https://ns.adobe.com/xdm/common/address", - "description" : "Physicial address where the ATM is located." + "xdm:atmAddress": { + "title": "ATM Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "Physicial address where the ATM is located." }, - "xdm:atmID" : { - "title" : "ATM ID", - "type" : "string", - "description" : "ID associated with the ATM." + "xdm:atmID": { + "title": "ATM ID", + "type": "string", + "description": "ID associated with the ATM." }, - "xdm:atmName" : { - "title" : "ATM Name", - "type" : "string", - "description" : "Name associated with the ATM." + "xdm:atmName": { + "title": "ATM Name", + "type": "string", + "description": "Name associated with the ATM." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/atm" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-11-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/atm" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-11-19" +} diff --git a/components/classes/fsi/branch.schema.json b/components/classes/fsi/branch.schema.json index 53ecc973e..91c53a48f 100644 --- a/components/classes/fsi/branch.schema.json +++ b/components/classes/fsi/branch.schema.json @@ -1,59 +1,67 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/classes/fsi/branch", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Branch", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/classes/fsi/branch", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Branch", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record" ], - "description" : "For branch information such as ID, name, and open and close times.", - "definitions" : { - "branch" : { - "properties" : { - "xdm:isBranchActive" : { - "title" : "Is Branch Active", - "type" : "boolean", - "description" : "Yes/no if the branch is currently active." + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "description": "For branch information such as ID, name, and open and close times.", + "definitions": { + "branch": { + "properties": { + "xdm:isBranchActive": { + "title": "Is Branch Active", + "type": "boolean", + "description": "Yes/no if the branch is currently active." }, - "xdm:branchAddress" : { - "title" : "Branch Address", - "$ref" : "https://ns.adobe.com/xdm/common/address", - "description" : "Physical address where the branch is located." + "xdm:branchAddress": { + "title": "Branch Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "Physical address where the branch is located." }, - "xdm:branchID" : { - "title" : "Branch ID", - "type" : "string", - "description" : "ID associated with the branch. " + "xdm:branchID": { + "title": "Branch ID", + "type": "string", + "description": "ID associated with the branch. " }, - "xdm:branchName" : { - "title" : "Branch Name", - "type" : "string", - "description" : "Name of the branch." + "xdm:branchName": { + "title": "Branch Name", + "type": "string", + "description": "Name of the branch." }, - "xdm:branchCloseTime" : { - "title" : "Branch Close Time", - "type" : "string", - "format" : "date-time", - "description" : "Time of day the branch closes." + "xdm:branchCloseTime": { + "title": "Branch Close Time", + "type": "string", + "format": "date-time", + "description": "Time of day the branch closes." }, - "xdm:branchOpenTime" : { - "title" : "Brancn Open Time", - "type" : "string", - "format" : "date-time", - "description" : "Time of day the branch opens." + "xdm:branchOpenTime": { + "title": "Brancn Open Time", + "type": "string", + "format": "date-time", + "description": "Time of day the branch opens." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/branch" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-11-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/branch" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-11-19" +} diff --git a/components/classes/graphs.schema.json b/components/classes/graphs.schema.json index e57087313..f6d774895 100644 --- a/components/classes/graphs.schema.json +++ b/components/classes/graphs.schema.json @@ -1,27 +1,37 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/graphs", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Graphs", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record" ], - "description" : "An XDM Graph. A Graph represents a set of related nodes and their relationships (often called as edges). These graphs could also be a set of nodes only without relationships. For example, person graph where each node is a device which the person uses.", - "definitions" : { - "graphs" : { - "properties" : { } + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graphs", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graphs", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "description": "An XDM Graph. A Graph represents a set of related nodes and their relationships (often called as edges). These graphs could also be a set of nodes only without relationships. For example, person graph where each node is a device which the person uses.", + "definitions": { + "graphs": { + "properties": {} } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/auditable" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/graphs" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/graphs" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/classes/product.schema.json b/components/classes/product.schema.json index 215e3cebc..12994f8f7 100644 --- a/components/classes/product.schema.json +++ b/components/classes/product.schema.json @@ -1,65 +1,85 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/classes/product", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/classes/product", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record" ], - "description" : "This class is used to capture minimum set of properties that define a product.", - "definitions" : { - "product" : { - "properties" : { - "xdm:productID" : { - "title" : "Product ID", - "type" : "string", - "description" : "Product unique identifer." + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "description": "This class is used to capture minimum set of properties that define a product.", + "definitions": { + "product": { + "properties": { + "xdm:productID": { + "title": "Product ID", + "type": "string", + "description": "Product unique identifer." }, - "xdm:productName" : { - "title" : "Product Name", - "type" : "string", - "description" : "Name of the product." + "xdm:productName": { + "title": "Product Name", + "type": "string", + "description": "Name of the product." }, - "xdm:productDescription" : { - "title" : "Product Description", - "type" : "string", - "description" : "Description of the product." + "xdm:productDescription": { + "title": "Product Description", + "type": "string", + "description": "Description of the product." }, - "xdm:productRating" : { - "title" : "Product Rating", - "type" : "number", - "description" : "Customer review rating of the product." + "xdm:productRating": { + "title": "Product Rating", + "type": "number", + "description": "Customer review rating of the product." }, - "xdm:productListPrice" : { - "title" : "Product List price", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "Default price of the product before sales and discounting." + "xdm:productListPrice": { + "title": "Product List price", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "Default price of the product before sales and discounting." }, - "xdm:productManufacturedDate" : { - "title" : "Product Manufactured date", - "type" : "string", - "format" : "date-time", - "description" : "The date when this product was created. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + "xdm:productManufacturedDate": { + "title": "Product Manufactured date", + "type": "string", + "format": "date-time", + "description": "The date when this product was created. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." }, - "xdm:productLastModifiedDate" : { - "title" : "Product last modified Date", - "type" : "string", - "format" : "date-time", - "description" : "The date when this product was last modified for any updates. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + "xdm:productLastModifiedDate": { + "title": "Product last modified Date", + "type": "string", + "format": "date-time", + "description": "The date when this product was last modified for any updates. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/product" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-10-16" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/product" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-10-16" +} diff --git a/components/classes/profile.schema.json b/components/classes/profile.schema.json index ca8909dc7..1ac5287b5 100644 --- a/components/classes/profile.schema.json +++ b/components/classes/profile.schema.json @@ -1,37 +1,50 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Individual Profile", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Individual Profile", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record", "https://ns.adobe.com/xdm/common/auditable" ], - "description" : "An XDM Individual Profile forms a singular representation of the attributes and interests of both identified and partially-identified individuals. Less-identified profiles may contain only anonymous behavioral signals, such as browser cookies, while highly-identified profiles may contain detailed personal information such as name, date of birth, location, and email address. As a profile grows, it becomes a robust repository of personal information, identification information, contact details, and communication preferences for an individual.", - "definitions" : { - "profile" : { - "properties" : { - "xdm:personID" : { - "title" : "Person ID", - "description" : "Unique identifier of Person/Profile fragment.", - "type" : "string" + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record", + "https://ns.adobe.com/xdm/common/auditable" + ], + "description": "An XDM Individual Profile forms a singular representation of the attributes and interests of both identified and partially-identified individuals. Less-identified profiles may contain only anonymous behavioral signals, such as browser cookies, while highly-identified profiles may contain detailed personal information such as name, date of birth, location, and email address. As a profile grows, it becomes a robust repository of personal information, identification information, contact details, and communication preferences for an individual.", + "definitions": { + "profile": { + "properties": { + "xdm:personID": { + "title": "Person ID", + "description": "Unique identifier of Person/Profile fragment.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/auditable" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/profile" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/profile" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/classes/promotion.schema.json b/components/classes/promotion.schema.json index 548c7824f..087b22b38 100644 --- a/components/classes/promotion.schema.json +++ b/components/classes/promotion.schema.json @@ -1,64 +1,84 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/classes/promotion", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Promotion", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record" ], - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/classes/promotion", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Promotion", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/record"], + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "description" : "For promition information such as details, and start and end date.", - "definitions" : { - "promotion" : { - "properties" : { - "xdm:endDate" : { - "title" : "End Date", - "type" : "string", - "format" : "date-time", - "description" : "Date on which the promotion ceases to be valid." + "description": "For promition information such as details, and start and end date.", + "definitions": { + "promotion": { + "properties": { + "xdm:endDate": { + "title": "End Date", + "type": "string", + "format": "date-time", + "description": "Date on which the promotion ceases to be valid." }, - "xdm:promoCreative" : { - "title" : "Promotion Creative", - "type" : "string", - "description" : "The text or creative variation associated with the promotion." + "xdm:promoCreative": { + "title": "Promotion Creative", + "type": "string", + "description": "The text or creative variation associated with the promotion." }, - "xdm:promotionDetails" : { - "title" : "Promotion Details", - "type" : "string", - "description" : "Details of the promotion such as percentage off, or other restrictions." + "xdm:promotionDetails": { + "title": "Promotion Details", + "type": "string", + "description": "Details of the promotion such as percentage off, or other restrictions." }, - "xdm:ID" : { - "title" : "Promotion ID", - "type" : "string", - "description" : "The ID associated with the promotion." + "xdm:ID": { + "title": "Promotion ID", + "type": "string", + "description": "The ID associated with the promotion." }, - "xdm:promoName" : { - "title" : "Promotion Name", - "type" : "string", - "description" : "Promotion name" + "xdm:promoName": { + "title": "Promotion Name", + "type": "string", + "description": "Promotion name" }, - "xdm:promoPosition" : { - "title" : "Promotion Position", - "type" : "string", - "description" : "Promotion position on site." + "xdm:promoPosition": { + "title": "Promotion Position", + "type": "string", + "description": "Promotion position on site." }, - "xdm:startDate" : { - "title" : "Start Date", - "type" : "string", - "format" : "date-time", - "description" : "Date on which the promotion is valid." + "xdm:startDate": { + "title": "Start Date", + "type": "string", + "format": "date-time", + "description": "Date on which the promotion is valid." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/promotion" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-24" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/promotion" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-24" +} diff --git a/components/classes/segmentdefinition.schema.json b/components/classes/segmentdefinition.schema.json index c4fadda11..1f29def32 100644 --- a/components/classes/segmentdefinition.schema.json +++ b/components/classes/segmentdefinition.schema.json @@ -1,58 +1,72 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/segmentdefinition", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Segment definition", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "description" : "This is the base class for a segment definition which includes required fields like identity of a segment and name of segment. Segment definitions coming from various system can use this class to build Segment Definition XDM schema.", - "meta:extends" : [ "https://ns.adobe.com/xdm/data/record", "https://ns.adobe.com/xdm/common/auditable" ], - "definitions" : { - "segmentdefinition" : { - "properties" : { - "xdm:segmentIdentity" : { - "title" : "Segment identity", - "$ref" : "https://ns.adobe.com/xdm/context/segmentidentity", - "description" : "Identity of the segment.", - "meta:status" : "deprecated" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentdefinition", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment definition", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "This is the base class for a segment definition which includes required fields like identity of a segment and name of segment. Segment definitions coming from various system can use this class to build Segment Definition XDM schema.", + "meta:extends": [ + "https://ns.adobe.com/xdm/data/record", + "https://ns.adobe.com/xdm/common/auditable" + ], + "definitions": { + "segmentdefinition": { + "properties": { + "xdm:segmentIdentity": { + "title": "Segment identity", + "$ref": "https://ns.adobe.com/xdm/context/segmentidentity", + "description": "Identity of the segment.", + "meta:status": "deprecated" }, - "xdm:segmentName" : { - "title" : "Segment name", - "type" : "string", - "description" : "Name of the segment." + "xdm:segmentName": { + "title": "Segment name", + "type": "string", + "description": "Name of the segment." }, - "xdm:description" : { - "title" : "Segment description", - "type" : "string", - "description" : "Description of the segment." + "xdm:description": { + "title": "Segment description", + "type": "string", + "description": "Description of the segment." }, - "xdm:version" : { - "title" : "Segment version", - "type" : "string", - "description" : "Version of the segment." + "xdm:version": { + "title": "Segment version", + "type": "string", + "description": "Version of the segment." }, - "xdm:segmentStatus" : { - "type" : "string", - "title" : "Segment status", - "description" : "Current status of segment from external system normalized to active, inactive, deleted, draft or revoked.", - "enum" : [ "ACTIVE", "INACTIVE", "DELETED", "DRAFT", "REVOKED" ] + "xdm:segmentStatus": { + "type": "string", + "title": "Segment status", + "description": "Current status of segment from external system normalized to active, inactive, deleted, draft or revoked.", + "enum": ["ACTIVE", "INACTIVE", "DELETED", "DRAFT", "REVOKED"] } } } }, - "required" : [ "xdm:identityMap", "xdm:segmentName" ], - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/identitymap" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/auditable" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/record" - }, { - "$ref" : "#/definitions/segmentdefinition" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "required": ["xdm:identityMap", "xdm:segmentName"], + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/record" + }, + { + "$ref": "#/definitions/segmentdefinition" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/common/identity.schema.json b/components/common/identity.schema.json index 11b51d6d5..3d972b73d 100644 --- a/components/common/identity.schema.json +++ b/components/common/identity.schema.json @@ -1,58 +1,66 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$schema" : "http://json-schema.org/draft-06/schema#", - "$id" : "https://ns.adobe.com/xdm/common/identity", - "title" : "User identity", - "type" : "object", - "meta:extensible" : true, - "description" : "This model represents an authenticated IMS user. The IMS user principal is a user account under Adobe's identity management system (IMS).", - "definitions" : { - "identity" : { - "type" : "object", - "properties" : { - "xdm:identityProvider" : { - "description" : "The identity provider that manages this principal.", - "type" : "string", - "meta:enum" : [ "ims" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/identity", + "title": "User identity", + "type": "object", + "meta:extensible": true, + "description": "This model represents an authenticated IMS user. The IMS user principal is a user account under Adobe's identity management system (IMS).", + "definitions": { + "identity": { + "type": "object", + "properties": { + "xdm:identityProvider": { + "description": "The identity provider that manages this principal.", + "type": "string", + "meta:enum": ["ims"] }, - "xdm:id" : { - "description" : "Principal ID identifies a user account in IMS. Its value is equivalent to the standard claim, `sub` as mentioned in the [openid connect 1.0 standard claims](http://openid.net/specs/openid-connect-core-1_0.html#StandardClaim). This value can be obtained by fetching the [userinfo resource](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo) for a particular user [in IMS](https://wiki.corp.adobe.com/display/ims/IMS+API+-+userinfo).", - "type" : "string" + "xdm:id": { + "description": "Principal ID identifies a user account in IMS. Its value is equivalent to the standard claim, `sub` as mentioned in the [openid connect 1.0 standard claims](http://openid.net/specs/openid-connect-core-1_0.html#StandardClaim). This value can be obtained by fetching the [userinfo resource](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo) for a particular user [in IMS](https://wiki.corp.adobe.com/display/ims/IMS+API+-+userinfo).", + "type": "string" }, - "xdm:type" : { - "type" : "string", - "meta:enum" : [ "https://ns.adobe.com/xdm/common/user" ], - "format" : "uri", - "description" : "The type of the identity. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986)." + "xdm:type": { + "type": "string", + "meta:enum": ["https://ns.adobe.com/xdm/common/user"], + "format": "uri", + "description": "The type of the identity. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986)." } } }, - "publicprofile" : { - "xdm:displayName" : { - "title" : "Name", - "type" : "string", - "description" : "Display name." + "publicprofile": { + "xdm:displayName": { + "title": "Name", + "type": "string", + "description": "Display name." }, - "xdm:profileImage" : { - "title" : "Image", - "format" : "uri", - "type" : "string", - "description" : "Profile avatar or picture of the person." + "xdm:profileImage": { + "title": "Image", + "format": "uri", + "type": "string", + "description": "Profile avatar or picture of the person." }, - "xdm:profileLink" : { - "title" : "Image", - "format" : "uri", - "type" : "string", - "description" : "Link to the public profile of the person, for example linking to the users Adobe Behance public profile." + "xdm:profileLink": { + "title": "Image", + "format": "uri", + "type": "string", + "description": "Link to the public profile of the person, for example linking to the users Adobe Behance public profile." } } }, - "allOf" : [ { - "$ref" : "#/definitions/identity" - }, { - "$ref" : "#/definitions/publicprofile" - } ], - "required" : [ "xdm:identityProvider", "xdm:id", "xdm:type" ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/identity" + }, + { + "$ref": "#/definitions/publicprofile" + } + ], + "required": ["xdm:identityProvider", "xdm:id", "xdm:type"], + "meta:status": "deprecated", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/application.schema.json b/components/datatypes/application.schema.json index 4965d12e3..1d7a328ff 100644 --- a/components/datatypes/application.schema.json +++ b/components/datatypes/application.schema.json @@ -1,75 +1,83 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/application", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Application", - "type" : "object", - "description" : "Details related to the application generated interactions. Application refers to a software experience, such as a mobile or desktop application that can be installed, run, closed, or uninstalled by an end user. Details are not intended to describe agents such as chatbots, browser-based plugins, or other experiences that do not apply to applications.", - "meta:extensible" : true, - "definitions" : { - "application" : { - "properties" : { - "xdm:id" : { - "title" : "Application identifier", - "type" : "string", - "description" : "Identifier of the application." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/application", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Application", + "type": "object", + "description": "Details related to the application generated interactions. Application refers to a software experience, such as a mobile or desktop application that can be installed, run, closed, or uninstalled by an end user. Details are not intended to describe agents such as chatbots, browser-based plugins, or other experiences that do not apply to applications.", + "meta:extensible": true, + "definitions": { + "application": { + "properties": { + "xdm:id": { + "title": "Application identifier", + "type": "string", + "description": "Identifier of the application." }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "Name of the application." + "xdm:name": { + "title": "Name", + "type": "string", + "description": "Name of the application." }, - "xdm:version" : { - "title" : "Version", - "type" : "string", - "description" : "Version of the application." + "xdm:version": { + "title": "Version", + "type": "string", + "description": "Version of the application." }, - "xdm:applicationCloses" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Graceful termination of an application." + "xdm:applicationCloses": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Graceful termination of an application." }, - "xdm:crashes" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Triggered when the application does not exit gracefully. Event is sent on application launch after a crash." + "xdm:crashes": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Triggered when the application does not exit gracefully. Event is sent on application launch after a crash." }, - "xdm:featureUsages" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Activation of an application feature that is being measured." + "xdm:featureUsages": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Activation of an application feature that is being measured." }, - "xdm:installs" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Install of an application on a device where the specific install event is available." + "xdm:installs": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Install of an application on a device where the specific install event is available." }, - "xdm:firstLaunches" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Triggered on first launch after install." + "xdm:firstLaunches": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Triggered on first launch after install." }, - "xdm:launches" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Launch of an application. Triggered on every run, including crashes and installs. Also triggered on a resume from background when the session timeout has been exceeded." + "xdm:launches": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Launch of an application. Triggered on every run, including crashes and installs. Also triggered on a resume from background when the session timeout has been exceeded." }, - "xdm:upgrades" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Upgrade of an application that has previously been installed. Triggered on first launch after upgrade." + "xdm:upgrades": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Upgrade of an application that has previously been installed. Triggered on first launch after upgrade." }, - "xdm:userPerspective" : { - "type" : "string", - "description" : "The perspective/physical relationship between the user and the app/brand at the time the event happened. The most common are the app being in the foreground with the user directly interacting with it vs the app being in the background and still generating events. Detached means the event was related to the app but didn't come directly from the app like the sending of an email or push notification from an external system. Understanding the perspective of the user in relation to the app helps with accuratly generating sessions as the majority of the time you will not want to include background and detached events as part of an active session.", - "enum" : [ "foreground", "background", "detached" ], - "meta:enum" : { - "foreground" : "Foreground", - "background" : "Background", - "detached" : "Detached" + "xdm:userPerspective": { + "type": "string", + "description": "The perspective/physical relationship between the user and the app/brand at the time the event happened. The most common are the app being in the foreground with the user directly interacting with it vs the app being in the background and still generating events. Detached means the event was related to the app but didn't come directly from the app like the sending of an email or push notification from an external system. Understanding the perspective of the user in relation to the app helps with accuratly generating sessions as the majority of the time you will not want to include background and detached events as part of an active session.", + "enum": ["foreground", "background", "detached"], + "meta:enum": { + "foreground": "Foreground", + "background": "Background", + "detached": "Detached" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/application" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/application" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/auditing/auditable.schema.json b/components/datatypes/auditing/auditable.schema.json index 427d48b78..fd1ae868f 100644 --- a/components/datatypes/auditing/auditable.schema.json +++ b/components/datatypes/auditing/auditable.schema.json @@ -1,44 +1,52 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/auditable", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Audit trail", - "type" : "object", - "meta:abstract" : true, - "description" : "The audit trail schema indicates a data record is auditable. For example, who and when the record was last modified.", - "definitions" : { - "auditlog" : { - "properties" : { - "xdm:repositoryCreatedBy" : { - "title" : "Created by user identifier", - "type" : "string", - "description" : "User ID of who created the record." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/auditable", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Audit trail", + "type": "object", + "meta:abstract": true, + "description": "The audit trail schema indicates a data record is auditable. For example, who and when the record was last modified.", + "definitions": { + "auditlog": { + "properties": { + "xdm:repositoryCreatedBy": { + "title": "Created by user identifier", + "type": "string", + "description": "User ID of who created the record." }, - "xdm:repositoryLastModifiedBy" : { - "title" : "Modified by user identifier", - "type" : "string", - "description" : "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`." + "xdm:repositoryLastModifiedBy": { + "title": "Modified by user identifier", + "type": "string", + "description": "User ID of who last modified the record. At creation time, `modifiedByUser` is set as `createdByUser`." }, - "xdm:createdByBatchID" : { - "title" : "Created by batch identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "The dataset files in Catalog which has been originating the creation of the record." + "xdm:createdByBatchID": { + "title": "Created by batch identifier", + "type": "string", + "format": "uri-reference", + "description": "The dataset files in Catalog which has been originating the creation of the record." }, - "xdm:modifiedByBatchID" : { - "title" : "Modified by batch identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`." + "xdm:modifiedByBatchID": { + "title": "Modified by batch identifier", + "type": "string", + "format": "uri-reference", + "description": "The last dataset files in Catalog which has modified the record. At creation time, `modifiedByBatchID` is set as `createdByBatchID`." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/auditlog" - }, { - "$ref" : "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/auditlog" + }, + { + "$ref": "http://ns.adobe.com/adobecloud/core/1.0#/definitions/date-properties" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/auditing/external-source-system-audit.schema.json b/components/datatypes/auditing/external-source-system-audit.schema.json index 385684d6c..d2f8b2570 100644 --- a/components/datatypes/auditing/external-source-system-audit.schema.json +++ b/components/datatypes/auditing/external-source-system-audit.schema.json @@ -1,67 +1,75 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/external-source-system-audit", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "External Source System Audit Attributes", - "type" : "object", - "meta:extensible" : true, - "description" : "External Source System Audit fields.", - "definitions" : { - "externalSourceSystemAudit" : { - "properties" : { - "xdm:createdBy" : { - "title" : "Created By", - "description" : "Name of the user who created this record", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/external-source-system-audit", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "External Source System Audit Attributes", + "type": "object", + "meta:extensible": true, + "description": "External Source System Audit fields.", + "definitions": { + "externalSourceSystemAudit": { + "properties": { + "xdm:createdBy": { + "title": "Created By", + "description": "Name of the user who created this record", + "type": "string" }, - "xdm:createdDate" : { - "title" : "Created Date", - "description" : "Date when this record was created.", - "type" : "string", - "format" : "date-time" + "xdm:createdDate": { + "title": "Created Date", + "description": "Date when this record was created.", + "type": "string", + "format": "date-time" }, - "xdm:lastUpdatedBy" : { - "title" : "Last Updated By", - "description" : "User who last modified this record.", - "type" : "string" + "xdm:lastUpdatedBy": { + "title": "Last Updated By", + "description": "User who last modified this record.", + "type": "string" }, - "xdm:lastUpdatedDate" : { - "title" : "Last Updated Date", - "description" : "Date when this record was last modofied.", - "type" : "string", - "format" : "date-time" + "xdm:lastUpdatedDate": { + "title": "Last Updated Date", + "description": "Date when this record was last modofied.", + "type": "string", + "format": "date-time" }, - "xdm:lastActivityDate" : { - "title" : "Last Activity Date", - "description" : "Last activity date.", - "type" : "string", - "format" : "date-time" + "xdm:lastActivityDate": { + "title": "Last Activity Date", + "description": "Last activity date.", + "type": "string", + "format": "date-time" }, - "xdm:lastReferencedDate" : { - "title" : "Last Referenced Date", - "description" : "Last referenced date.", - "type" : "string", - "format" : "date-time" + "xdm:lastReferencedDate": { + "title": "Last Referenced Date", + "description": "Last referenced date.", + "type": "string", + "format": "date-time" }, - "xdm:lastViewedDate" : { - "title" : "Last Viewed Date", - "description" : "Last viewed date.", - "type" : "string", - "format" : "date-time" + "xdm:lastViewedDate": { + "title": "Last Viewed Date", + "description": "Last viewed date.", + "type": "string", + "format": "date-time" }, - "xdm:externalID" : { - "title" : "External ID", - "description" : "External unique identifier reference to external source to help identify and deduplicate if and when needed.", - "type" : "string" + "xdm:externalID": { + "title": "External ID", + "description": "External unique identifier reference to external source to help identify and deduplicate if and when needed.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/externalSourceSystemAudit" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/externalSourceSystemAudit" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/b2b/account-organization.schema.json b/components/datatypes/b2b/account-organization.schema.json index 659d9081b..df14b0ec9 100644 --- a/components/datatypes/b2b/account-organization.schema.json +++ b/components/datatypes/b2b/account-organization.schema.json @@ -1,120 +1,127 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/b2b-account-organization", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Account Details", - "type" : "object", - "description" : "Commonly used organizational attributes for a B2B account such as number of employees, market segment, industry, rating, tickersymbol etc.", - "definitions" : { - "b2b-account-organization" : { - "properties" : { - "xdm:organizationType" : { - "title" : "Type of Organizations", - "type" : "string", - "description" : "Label describing the type of organization" - }, - "xdm:numberOfEmployees" : { - "title" : "Number of employees", - "type" : "integer", - "description" : "The number of employees at the organization." - }, - "xdm:annualRevenue" : { - "title" : "Annual Revenue", - "description" : "Estimated amount of annual revenue of the organization.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency" - }, - "xdm:industry" : { - "title" : "Industry", - "type" : "string", - "description" : "The industry that this organization is a part of. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:classifier` property." - }, - "xdm:website" : { - "title" : "Website URL", - "type" : "string", - "description" : "The URL of the organization's website." - }, - "xdm:marketSegment" : { - "title" : "Market segment", - "type" : "string", - "description" : "The named market segment that the organization participates in. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:identifier` property." - }, - "xdm:rating" : { - "title" : "Rating", - "type" : "number", - "minimum" : 0, - "maximum" : 1, - "description" : "The calculated score or star rating for this organization. `1` indicates the maximum possible rating, `0` the minimum possible rating." - }, - "xdm:tickerSymbol" : { - "title" : "Ticker Symbol", - "description" : "The stock market symbol for this account. Maximum of 20 characters.", - "type" : "string" - }, - "xdm:logoUrl" : { - "title" : "Logo URL", - "description" : "Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account.", - "type" : "string" - }, - "xdm:linkedinPageUrl" : { - "title" : "Linkedinin Page URL", - "description" : "Website link to the Linkedin account of the account", - "type" : "string" - }, - "xdm:twitterHandleUrl" : { - "title" : "Twitter handle URL", - "description" : "Website link to the twitter handle of the account", - "type" : "string" - }, - "xdm:facebookPageUrl" : { - "title" : "Facebook Page URL", - "description" : "Website link to the Facebook account of the account", - "type" : "string" - }, - "xdm:NAICSCode" : { - "title" : "NAICS Code", - "type" : "string", - "description" : "A NAICS (pronounced NAKES) Code is a classification within the North American Industry Classification System." - }, - "xdm:SICCode" : { - "title" : "SIC Code", - "type" : "string", - "description" : "The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities." - }, - "xdm:NAICSDescription" : { - "title" : "NAICS Description", - "description" : "A brief description of an organization’s line of business, based on its NAICS code.", - "type" : "string" - }, - "xdm:SICDescription" : { - "title" : "SIC Description", - "description" : "A brief description of an organization’s line of business, based on its SIC code.", - "type" : "string" - }, - "xdm:DUNSNumber" : { - "title" : "Dun & Bradstreet D-U-N-S Number", - "description" : "The Dun & Bradstreet D-U-N-S Number is a non-indicative, nine-digit number assigned to each business location in the Dun & Bradstreet database having a unique, separate, and distinct operation, and is maintained solely by Dun & Bradstreet.", - "type" : "string" - }, - "xdm:jigsaw" : { - "title" : "Jigsaw", - "description" : "Data.com Key.", - "type" : "string" - }, - "xdm:primaryEmailDomain" : { - "title" : "Primary Email Domain", - "type" : "string" - }, - "xdm:companyProductAndServices" : { - "title" : "Company Product and Services", - "description" : "Product and Services the Company is dealing or doing business in.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/b2b-account-organization", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Account Details", + "type": "object", + "description": "Commonly used organizational attributes for a B2B account such as number of employees, market segment, industry, rating, tickersymbol etc.", + "definitions": { + "b2b-account-organization": { + "properties": { + "xdm:organizationType": { + "title": "Type of Organizations", + "type": "string", + "description": "Label describing the type of organization" + }, + "xdm:numberOfEmployees": { + "title": "Number of employees", + "type": "integer", + "description": "The number of employees at the organization." + }, + "xdm:annualRevenue": { + "title": "Annual Revenue", + "description": "Estimated amount of annual revenue of the organization.", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency" + }, + "xdm:industry": { + "title": "Industry", + "type": "string", + "description": "The industry that this organization is a part of. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:classifier` property." + }, + "xdm:website": { + "title": "Website URL", + "type": "string", + "description": "The URL of the organization's website." + }, + "xdm:marketSegment": { + "title": "Market segment", + "type": "string", + "description": "The named market segment that the organization participates in. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:identifier` property." + }, + "xdm:rating": { + "title": "Rating", + "type": "number", + "minimum": 0, + "maximum": 1, + "description": "The calculated score or star rating for this organization. `1` indicates the maximum possible rating, `0` the minimum possible rating." + }, + "xdm:tickerSymbol": { + "title": "Ticker Symbol", + "description": "The stock market symbol for this account. Maximum of 20 characters.", + "type": "string" + }, + "xdm:logoUrl": { + "title": "Logo URL", + "description": "Path to be combined with the URL of a Salesforce instance (for example, https://yourInstance.salesforce.com/) to generate a URL to request the social network profile image associated with the account. Generated URL returns an HTTP redirect (code 302) to the social network profile image for the account.", + "type": "string" + }, + "xdm:linkedinPageUrl": { + "title": "Linkedinin Page URL", + "description": "Website link to the Linkedin account of the account", + "type": "string" + }, + "xdm:twitterHandleUrl": { + "title": "Twitter handle URL", + "description": "Website link to the twitter handle of the account", + "type": "string" + }, + "xdm:facebookPageUrl": { + "title": "Facebook Page URL", + "description": "Website link to the Facebook account of the account", + "type": "string" + }, + "xdm:NAICSCode": { + "title": "NAICS Code", + "type": "string", + "description": "A NAICS (pronounced NAKES) Code is a classification within the North American Industry Classification System." + }, + "xdm:SICCode": { + "title": "SIC Code", + "type": "string", + "description": "The Standard Industrial Classification (SIC) are four-digit codes that categorize the industries that companies belong to based on their business activities." + }, + "xdm:NAICSDescription": { + "title": "NAICS Description", + "description": "A brief description of an organization’s line of business, based on its NAICS code.", + "type": "string" + }, + "xdm:SICDescription": { + "title": "SIC Description", + "description": "A brief description of an organization’s line of business, based on its SIC code.", + "type": "string" + }, + "xdm:DUNSNumber": { + "title": "Dun & Bradstreet D-U-N-S Number", + "description": "The Dun & Bradstreet D-U-N-S Number is a non-indicative, nine-digit number assigned to each business location in the Dun & Bradstreet database having a unique, separate, and distinct operation, and is maintained solely by Dun & Bradstreet.", + "type": "string" + }, + "xdm:jigsaw": { + "title": "Jigsaw", + "description": "Data.com Key.", + "type": "string" + }, + "xdm:primaryEmailDomain": { + "title": "Primary Email Domain", + "type": "string" + }, + "xdm:companyProductAndServices": { + "title": "Company Product and Services", + "description": "Product and Services the Company is dealing or doing business in.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/b2b-account-organization" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/b2b-account-organization" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/b2b/b2b-account.schema.json b/components/datatypes/b2b/b2b-account.schema.json index 718002ba7..c0c8ec507 100644 --- a/components/datatypes/b2b/b2b-account.schema.json +++ b/components/datatypes/b2b/b2b-account.schema.json @@ -1,122 +1,131 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/b2b-account", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "B2B Account", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "description" : "This Data Type is used to capture B2B Account properties. They are grouped functioanlly under separate definitions.", - "definitions" : { - "b2b-account-segmentation" : { - "properties" : { - "xdm:accountName" : { - "title" : "Account Name", - "description" : "name of company. Up to 255 characters are allowed in this field.", - "type" : "string" - }, - "xdm:accountTerritoryID" : { - "title" : "Account Territory Id", - "description" : "The territory to which the account has been assigned.", - "type" : "string" - }, - "xdm:accountScore" : { - "title" : "Account Score", - "type" : "number" - }, - "xdm:accountBillingAddress" : { - "title" : "Account Billing Address", - "$ref" : "https://ns.adobe.com/xdm/common/address" - }, - "xdm:accountShippingAddress" : { - "title" : "Account Shipping Address", - "$ref" : "https://ns.adobe.com/xdm/common/address" - }, - "xdm:accountPhysicalAddress" : { - "title" : "Account Physical Address", - "description" : "Actual physical address of the account. Could be the HQ address or any preffered business address for communication.", - "$ref" : "https://ns.adobe.com/xdm/common/address" - }, - "xdm:accountOrganization" : { - "title" : "Account Organization", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-account-organization" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/b2b-account", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "B2B Account", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "This Data Type is used to capture B2B Account properties. They are grouped functioanlly under separate definitions.", + "definitions": { + "b2b-account-segmentation": { + "properties": { + "xdm:accountName": { + "title": "Account Name", + "description": "name of company. Up to 255 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountTerritoryID": { + "title": "Account Territory Id", + "description": "The territory to which the account has been assigned.", + "type": "string" + }, + "xdm:accountScore": { + "title": "Account Score", + "type": "number" + }, + "xdm:accountBillingAddress": { + "title": "Account Billing Address", + "$ref": "https://ns.adobe.com/xdm/common/address" + }, + "xdm:accountShippingAddress": { + "title": "Account Shipping Address", + "$ref": "https://ns.adobe.com/xdm/common/address" + }, + "xdm:accountPhysicalAddress": { + "title": "Account Physical Address", + "description": "Actual physical address of the account. Could be the HQ address or any preffered business address for communication.", + "$ref": "https://ns.adobe.com/xdm/common/address" + }, + "xdm:accountOrganization": { + "title": "Account Organization", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-account-organization" } } }, - "b2b-account" : { - "properties" : { - "xdm:accountParentID" : { - "title" : "Parent Account", - "description" : "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.", - "type" : "string" - }, - "xdm:partnerAccountID" : { - "title" : "Partner Account Id", - "description" : "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.", - "type" : "string" - }, - "xdm:accountNumber" : { - "title" : "Account Number", - "description" : "Tracking or reference number for account. Up to 40 characters are allowed in this field.", - "type" : "string" - }, - "xdm:accountDescription" : { - "title" : "Account Description", - "description" : "Text description of the account.", - "type" : "string" - }, - "xdm:accountSite" : { - "title" : "Account Site Details", - "description" : "Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field.", - "type" : "string" - }, - "xdm:accountType" : { - "title" : "Account Type", - "description" : "Account Type.", - "type" : "string" - }, - "xdm:accountSourceType" : { - "title" : "Account Source Type", - "description" : "Source type for the account.", - "type" : "string" - }, - "xdm:defaultCurrencyCode" : { - "title" : "Default Currency Code", - "type" : "string", - "examples" : [ "USD", "EUR" ], - "pattern" : "^[A-Z]{3}$", - "description" : "The ISO 4217 currency code." - }, - "xdm:accountOwnership" : { - "title" : "Ownership", - "description" : "Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters.", - "type" : "string" - }, - "xdm:accountTradeStyle" : { - "title" : "Account Trade Style", - "description" : "A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA).", - "type" : "string" - }, - "xdm:accountPhone" : { - "title" : "Account Phone Number", - "description" : "Phone number for the account.", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber" - }, - "xdm:accountFax" : { - "title" : "Account Fax Number", - "description" : "Fax number for the account.", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber" + "b2b-account": { + "properties": { + "xdm:accountParentID": { + "title": "Parent Account", + "description": "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.", + "type": "string" + }, + "xdm:partnerAccountID": { + "title": "Partner Account Id", + "description": "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.", + "type": "string" + }, + "xdm:accountNumber": { + "title": "Account Number", + "description": "Tracking or reference number for account. Up to 40 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountDescription": { + "title": "Account Description", + "description": "Text description of the account.", + "type": "string" + }, + "xdm:accountSite": { + "title": "Account Site Details", + "description": "Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountType": { + "title": "Account Type", + "description": "Account Type.", + "type": "string" + }, + "xdm:accountSourceType": { + "title": "Account Source Type", + "description": "Source type for the account.", + "type": "string" + }, + "xdm:defaultCurrencyCode": { + "title": "Default Currency Code", + "type": "string", + "examples": ["USD", "EUR"], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code." + }, + "xdm:accountOwnership": { + "title": "Ownership", + "description": "Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters.", + "type": "string" + }, + "xdm:accountTradeStyle": { + "title": "Account Trade Style", + "description": "A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA).", + "type": "string" + }, + "xdm:accountPhone": { + "title": "Account Phone Number", + "description": "Phone number for the account.", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber" + }, + "xdm:accountFax": { + "title": "Account Fax Number", + "description": "Fax number for the account.", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/b2b-account" - }, { - "$ref" : "#/definitions/b2b-account-segmentation" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/b2b-account" + }, + { + "$ref": "#/definitions/b2b-account-segmentation" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/b2b/b2b-source.schema.json b/components/datatypes/b2b/b2b-source.schema.json index 420d0fd63..23164d30e 100644 --- a/components/datatypes/b2b/b2b-source.schema.json +++ b/components/datatypes/b2b/b2b-source.schema.json @@ -1,38 +1,46 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/b2b-source", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "B2B Source", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "description" : "This Data Type is used to capture B2B/CRM Source identifiers.", - "definitions" : { - "b2b-source" : { - "properties" : { - "xdm:systemID" : { - "title" : "System ID", - "type" : "string", - "description" : "This is an identifier for the source system itself and potentially includes the object type." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/b2b-source", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "B2B Source", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "description": "This Data Type is used to capture B2B/CRM Source identifiers.", + "definitions": { + "b2b-source": { + "properties": { + "xdm:systemID": { + "title": "System ID", + "type": "string", + "description": "This is an identifier for the source system itself and potentially includes the object type." }, - "xdm:ID" : { - "title" : "ID", - "type" : "string", - "description" : "This is the row id for the fragment (of whatever type it is).It could be row id for the contact, account, lead etc." + "xdm:ID": { + "title": "ID", + "type": "string", + "description": "This is the row id for the fragment (of whatever type it is).It could be row id for the contact, account, lead etc." }, - "xdm:key" : { - "title" : "System Key", - "description" : "This is concatination of systemId and id. The concatenated value is created by the connector in the data pipe, so it’s already in the source.", - "type" : "string" + "xdm:key": { + "title": "System Key", + "description": "This is concatination of systemId and id. The concatenated value is created by the connector in the data pipe, so it’s already in the source.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/b2b-source" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/b2b-source" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/b2b/organization.schema.json b/components/datatypes/b2b/organization.schema.json index c4089c7cf..75f5f3c38 100644 --- a/components/datatypes/b2b/organization.schema.json +++ b/components/datatypes/b2b/organization.schema.json @@ -1,99 +1,106 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/organization", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Organization", - "type" : "object", - "description" : "Examples of organization data are number of employees, market segment, industry, and location.", - "definitions" : { - "organization" : { - "properties" : { - "@id" : { - "title" : "Organization ID", - "type" : "string", - "format" : "uri-reference", - "description" : "A unique identifier for the organization." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/organization", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Organization", + "type": "object", + "description": "Examples of organization data are number of employees, market segment, industry, and location.", + "definitions": { + "organization": { + "properties": { + "@id": { + "title": "Organization ID", + "type": "string", + "format": "uri-reference", + "description": "A unique identifier for the organization." }, - "xdm:legalName" : { - "title" : "Organization legal name", - "type" : "string", - "description" : "The official or legal name of the organization." + "xdm:legalName": { + "title": "Organization legal name", + "type": "string", + "description": "The official or legal name of the organization." }, - "schema:description" : { - "title" : "Organization description", - "type" : "string", - "description" : "A description of the organization." + "schema:description": { + "title": "Organization description", + "type": "string", + "description": "A description of the organization." }, - "schema:numberOfEmployees" : { - "title" : "Number of employees", - "type" : "number", - "description" : "The number of employees the at the organization." + "schema:numberOfEmployees": { + "title": "Number of employees", + "type": "number", + "description": "The number of employees the at the organization." }, - "xdm:annualRevenue" : { - "title" : "Annual Revenue", - "description" : "Estimated amount of annual revenue of the organization.", - "type" : "number" + "xdm:annualRevenue": { + "title": "Annual Revenue", + "description": "Estimated amount of annual revenue of the organization.", + "type": "number" }, - "xdm:industry" : { - "title" : "Industry", - "type" : "string", - "description" : "The industry that this organization is a part of. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:classifier` property." + "xdm:industry": { + "title": "Industry", + "type": "string", + "description": "The industry that this organization is a part of. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:classifier` property." }, - "xdm:website" : { - "title" : "Website URL", - "type" : "string", - "format" : "uri", - "description" : "The URL of the organization's website." + "xdm:website": { + "title": "Website URL", + "type": "string", + "format": "uri", + "description": "The URL of the organization's website." }, - "xdm:marketSegment" : { - "title" : "Market segment", - "type" : "string", - "description" : "The named market segment that the organization participates in. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:identifier` property." + "xdm:marketSegment": { + "title": "Market segment", + "type": "string", + "description": "The named market segment that the organization participates in. This is a free-form field, and it is advisable to use a structured value for queries or to use the `xdm:identifier` property." }, - "xdm:location" : { - "title" : "Location", - "$ref" : "https://ns.adobe.com/xdm/context/place", - "description" : "The location of the organization's main office or headquarters." + "xdm:location": { + "title": "Location", + "$ref": "https://ns.adobe.com/xdm/context/place", + "description": "The location of the organization's main office or headquarters." }, - "xdm:rating" : { - "title" : "Rating", - "type" : "number", - "minimum" : 0, - "maximum" : 1, - "description" : "The calculated score or star rating for this organization. `1` indicates the maximum possible rating, `0` the minimum possible rating." + "xdm:rating": { + "title": "Rating", + "type": "number", + "minimum": 0, + "maximum": 1, + "description": "The calculated score or star rating for this organization. `1` indicates the maximum possible rating, `0` the minimum possible rating." }, - "xdm:identifier" : { - "title" : "Organization identifier", - "type" : "object", - "description" : "This object contains unambiguous identifiers for the organization. Each key is the URI of an identification service, each value is the unique ID or preferably URI of the organization as defined by the identification service.", - "meta:xdmType" : "map", - "additionalProperties" : { - "title" : "Organization identifier", - "type" : "array", - "items" : { - "type" : "string" + "xdm:identifier": { + "title": "Organization identifier", + "type": "object", + "description": "This object contains unambiguous identifiers for the organization. Each key is the URI of an identification service, each value is the unique ID or preferably URI of the organization as defined by the identification service.", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Organization identifier", + "type": "array", + "items": { + "type": "string" } } }, - "xdm:classifier" : { - "title" : "Market or industry classifier", - "type" : "object", - "description" : "This object contains unambiguous classifiers for the organization. Each key is the URI of an classification service or standard, each value is the unique ID or preferably URI of the organization as defined by the classification service.", - "meta:xdmType" : "map", - "additionalProperties" : { - "title" : "Market or industry classifier", - "type" : "array", - "items" : { - "type" : "string" + "xdm:classifier": { + "title": "Market or industry classifier", + "type": "object", + "description": "This object contains unambiguous classifiers for the organization. Each key is the URI of an classification service or standard, each value is the unique ID or preferably URI of the organization as defined by the classification service.", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Market or industry classifier", + "type": "array", + "items": { + "type": "string" } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/organization" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/organization" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/b2b/orgunit.schema.json b/components/datatypes/b2b/orgunit.schema.json index f411db133..b603ef91f 100644 --- a/components/datatypes/b2b/orgunit.schema.json +++ b/components/datatypes/b2b/orgunit.schema.json @@ -1,32 +1,39 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/orgunit", - "$schema" : "http://json-schema.org/draft-06/schema#", - "type" : "object", - "meta:extensible" : true, - "title" : "Organizational unit", - "description" : "The organizational unit of a parent organization.", - "definitions" : { - "orgunit" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "The ID associated with this organizational unit." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/orgunit", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "title": "Organizational unit", + "description": "The organizational unit of a parent organization.", + "definitions": { + "orgunit": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The ID associated with this organizational unit." }, - "xdm:label" : { - "title" : "Label of the organizational unit.", - "type" : "string", - "description" : "The user-friendly name for the organizational unit." + "xdm:label": { + "title": "Label of the organizational unit.", + "type": "string", + "description": "The user-friendly name for the organizational unit." } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "#/definitions/orgunit" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/orgunit" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/browserdetails.schema.json b/components/datatypes/browserdetails.schema.json index 828f8dc9e..d50a44e49 100644 --- a/components/datatypes/browserdetails.schema.json +++ b/components/datatypes/browserdetails.schema.json @@ -1,98 +1,107 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/browserdetails", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Browser details", - "type" : "object", - "meta:extensible" : true, - "description" : "Detail information related to the browser.", - "definitions" : { - "browserdetails" : { - "properties" : { - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "The application or browser name." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/browserdetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Browser details", + "type": "object", + "meta:extensible": true, + "description": "Detail information related to the browser.", + "definitions": { + "browserdetails": { + "properties": { + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The application or browser name." }, - "xdm:vendor" : { - "title" : "Vendor", - "type" : "string", - "description" : "The application or browser vendor." + "xdm:vendor": { + "title": "Vendor", + "type": "string", + "description": "The application or browser vendor." }, - "xdm:version" : { - "title" : "Version", - "type" : "string", - "description" : "The application or browser version." + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The application or browser version." }, - "xdm:acceptLanguage" : { - "title" : "Accept language", - "type" : "string", - "description" : "An IETF language tag (RFC 5646)." + "xdm:acceptLanguage": { + "title": "Accept language", + "type": "string", + "description": "An IETF language tag (RFC 5646)." }, - "xdm:cookiesEnabled" : { - "title" : "Allows cookies", - "type" : "boolean", - "description" : "The current user agent settings allow for the writing of cookies.'" + "xdm:cookiesEnabled": { + "title": "Allows cookies", + "type": "boolean", + "description": "The current user agent settings allow for the writing of cookies.'" }, - "xdm:javaScriptEnabled" : { - "title" : "JavaScript enabled", - "type" : "boolean", - "description" : "If JavaScript was enabled in the device this observation was made from." + "xdm:javaScriptEnabled": { + "title": "JavaScript enabled", + "type": "boolean", + "description": "If JavaScript was enabled in the device this observation was made from." }, - "xdm:javaScriptVersion" : { - "title" : "JavaScript version", - "type" : "string", - "description" : "The version of JavaScript supported during the observation." + "xdm:javaScriptVersion": { + "title": "JavaScript version", + "type": "string", + "description": "The version of JavaScript supported during the observation." }, - "xdm:javaEnabled" : { - "title" : "Java enabled", - "type" : "boolean", - "description" : "If Java was enabled in the device this observation was made from." + "xdm:javaEnabled": { + "title": "Java enabled", + "type": "boolean", + "description": "If Java was enabled in the device this observation was made from." }, - "xdm:javaVersion" : { - "title" : "Java version", - "type" : "string", - "description" : "The version of Java supported during the observation." + "xdm:javaVersion": { + "title": "Java version", + "type": "string", + "description": "The version of Java supported during the observation." }, - "xdm:quicktimeVersion" : { - "title" : "Quicktime version", - "type" : "string", - "description" : "The version of Apple Quicktime supported during the observation." + "xdm:quicktimeVersion": { + "title": "Quicktime version", + "type": "string", + "description": "The version of Apple Quicktime supported during the observation." }, - "xdm:thirdPartyCookiesEnabled" : { - "title" : "Allows third-party cookies", - "type" : "boolean", - "description" : "If third-party cookies were enabled when this observation was made." + "xdm:thirdPartyCookiesEnabled": { + "title": "Allows third-party cookies", + "type": "boolean", + "description": "If third-party cookies were enabled when this observation was made." }, - "xdm:viewportHeight" : { - "title" : "Viewport height", - "type" : "integer", - "description" : "The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height." + "xdm:viewportHeight": { + "title": "Viewport height", + "type": "integer", + "description": "The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height." }, - "xdm:viewportWidth" : { - "title" : "Viewport width", - "type" : "integer", - "description" : "The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width." + "xdm:viewportWidth": { + "title": "Viewport width", + "type": "integer", + "description": "The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width." } } }, - "user-agent" : { - "properties" : { - "xdm:userAgent" : { - "title" : "User agent", - "type" : "string", - "description" : "The HTTP user-agent string from the client request." + "user-agent": { + "properties": { + "xdm:userAgent": { + "title": "User agent", + "type": "string", + "description": "The HTTP user-agent string from the client request." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/browserdetails" - }, { - "$ref" : "#/definitions/user-agent" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/browserdetails" + }, + { + "$ref": "#/definitions/user-agent" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/channels/application.schema.json b/components/datatypes/channels/application.schema.json index f8304b5cd..3e44dad0a 100644 --- a/components/datatypes/channels/application.schema.json +++ b/components/datatypes/channels/application.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/channels/application", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Application Channel", - "type" : "object", - "meta:abstract" : true, - "description" : "An application channel identifies apps that accepts messages or transmit events to the channel.", - "definitions" : { - "application" : { - "properties" : { - "@id" : { - "title" : "Application Identifier", - "type" : "string", - "description" : "Unique identifier of the app." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/channels/application", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Application Channel", + "type": "object", + "meta:abstract": true, + "description": "An application channel identifies apps that accepts messages or transmit events to the channel.", + "definitions": { + "application": { + "properties": { + "@id": { + "title": "Application Identifier", + "type": "string", + "description": "Unique identifier of the app." }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "Name of the app." + "xdm:name": { + "title": "Name", + "type": "string", + "description": "Name of the app." }, - "xdm:version" : { - "title" : "Version", - "type" : "string", - "description" : "Version of the app." + "xdm:version": { + "title": "Version", + "type": "string", + "description": "Version of the app." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/application" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/application" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/channels/channel.schema.json b/components/datatypes/channels/channel.schema.json index fc8f7300e..f3ebcd891 100644 --- a/components/datatypes/channels/channel.schema.json +++ b/components/datatypes/channels/channel.schema.json @@ -1,122 +1,130 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/channels/channel", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Experience Channel", - "meta:extensible" : true, - "meta:abstract" : true, - "type" : "object", - "description" : "There are multiple experience channels, each with different constraints on how content is delivered and how customer interaction can be observed and data collected. Within a channel, experiences can be delivered to specific locations. The locations and types of locations that exist in a channel differ from channel to channel.", - "definitions" : { - "channel" : { - "properties" : { - "@id" : { - "type" : "string", - "format" : "uri-reference", - "description" : "The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/channels/channel", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Experience Channel", + "meta:extensible": true, + "meta:abstract": true, + "type": "object", + "description": "There are multiple experience channels, each with different constraints on how content is delivered and how customer interaction can be observed and data collected. Within a channel, experiences can be delivered to specific locations. The locations and types of locations that exist in a channel differ from channel to channel.", + "definitions": { + "channel": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "description": "The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`." }, - "xdm:typeAtSource" : { - "type" : "string", - "description" : "Customer defined custom channel name" + "xdm:typeAtSource": { + "type": "string", + "description": "Customer defined custom channel name" }, - "xdm:mode" : { - "type" : "string", - "enum" : [ "push", "pull", "bidirectional" ], - "description" : "How experiences are delivered in this channel.", - "meta:enum" : { - "push" : "The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in.", - "pull" : "The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered.", - "bidirectional" : "Both `push` and `pull` interaction modes are supported by the channel." + "xdm:mode": { + "type": "string", + "enum": ["push", "pull", "bidirectional"], + "description": "How experiences are delivered in this channel.", + "meta:enum": { + "push": "The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in.", + "pull": "The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered.", + "bidirectional": "Both `push` and `pull` interaction modes are supported by the channel." } }, - "@type" : { - "type" : "string", - "format" : "uri", - "description" : "The `@type` property is used to provide a rough classification of channels with similar properties.", - "meta:enum" : { - "https://ns.adobe.com/xdm/channel-types/web" : "The world wide web, including mobile web", - "https://ns.adobe.com/xdm/channel-types/social" : "Social media platforms", - "https://ns.adobe.com/xdm/channel-types/mobile" : "Mobile apps", - "https://ns.adobe.com/xdm/channel-types/messaging" : "Instant messaging", - "https://ns.adobe.com/xdm/channel-types/email" : "Email", - "https://ns.adobe.com/xdm/channel-types/offline" : "Non-digital experience channels", - "https://ns.adobe.com/xdm/channel-types/display" : "Display", - "https://ns.adobe.com/xdm/channel-types/search" : "Search", - "https://ns.adobe.com/xdm/channel-types/social_display" : "Social Display", - "https://ns.adobe.com/xdm/channel-types/video" : "Video", - "https://ns.adobe.com/xdm/channel-types/affiliate" : "Affiliate", - "https://ns.adobe.com/xdm/channel-types/affinity" : "Affinity", - "https://ns.adobe.com/xdm/channel-types/apps" : "Applications", - "https://ns.adobe.com/xdm/channel-types/preload" : "Preload", - "https://ns.adobe.com/xdm/channel-types/direct" : "Direct", - "https://ns.adobe.com/xdm/channel-types/external" : "External", - "https://ns.adobe.com/xdm/channel-types/mail" : "Mail", - "https://ns.adobe.com/xdm/channel-types/instore" : "Instore" + "@type": { + "type": "string", + "format": "uri", + "description": "The `@type` property is used to provide a rough classification of channels with similar properties.", + "meta:enum": { + "https://ns.adobe.com/xdm/channel-types/web": "The world wide web, including mobile web", + "https://ns.adobe.com/xdm/channel-types/social": "Social media platforms", + "https://ns.adobe.com/xdm/channel-types/mobile": "Mobile apps", + "https://ns.adobe.com/xdm/channel-types/messaging": "Instant messaging", + "https://ns.adobe.com/xdm/channel-types/email": "Email", + "https://ns.adobe.com/xdm/channel-types/offline": "Non-digital experience channels", + "https://ns.adobe.com/xdm/channel-types/display": "Display", + "https://ns.adobe.com/xdm/channel-types/search": "Search", + "https://ns.adobe.com/xdm/channel-types/social_display": "Social Display", + "https://ns.adobe.com/xdm/channel-types/video": "Video", + "https://ns.adobe.com/xdm/channel-types/affiliate": "Affiliate", + "https://ns.adobe.com/xdm/channel-types/affinity": "Affinity", + "https://ns.adobe.com/xdm/channel-types/apps": "Applications", + "https://ns.adobe.com/xdm/channel-types/preload": "Preload", + "https://ns.adobe.com/xdm/channel-types/direct": "Direct", + "https://ns.adobe.com/xdm/channel-types/external": "External", + "https://ns.adobe.com/xdm/channel-types/mail": "Mail", + "https://ns.adobe.com/xdm/channel-types/instore": "Instore" } }, - "xdm:mediaType" : { - "type" : "string", - "description" : "Describes whether the media type is paid,owned or earned.", - "meta:enum" : { - "paid" : "Paid", - "owned" : "Owned", - "earned" : "Earned" + "xdm:mediaType": { + "type": "string", + "description": "Describes whether the media type is paid,owned or earned.", + "meta:enum": { + "paid": "Paid", + "owned": "Owned", + "earned": "Earned" } }, - "xdm:mediaAction" : { - "type" : "string", - "description" : "The `mediaAction` property is used to provide a type of experiance event media action .", - "meta:enum" : { - "opens" : "Opens", - "sends" : "Sends", - "clicks" : "Clicks", - "impressions" : "Impressions", - "bounces" : "Bounces", - "mirrorpages" : "Mirrorpages", - "nonDeliverables" : "NonDeliverables", - "notSent" : "NotSent", - "offerOpens" : "OfferOpens", - "unSubscriptions" : "UnSubscriptions", - "userComplaints" : "UserComplaints", - "subscriptions" : "Subscriptions" + "xdm:mediaAction": { + "type": "string", + "description": "The `mediaAction` property is used to provide a type of experiance event media action .", + "meta:enum": { + "opens": "Opens", + "sends": "Sends", + "clicks": "Clicks", + "impressions": "Impressions", + "bounces": "Bounces", + "mirrorpages": "Mirrorpages", + "nonDeliverables": "NonDeliverables", + "notSent": "NotSent", + "offerOpens": "OfferOpens", + "unSubscriptions": "UnSubscriptions", + "userComplaints": "UserComplaints", + "subscriptions": "Subscriptions" } }, - "xdm:contentTypes" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "uri", - "description" : "The `@type` of an XDM-defined content type that is supported by this channel." + "xdm:contentTypes": { + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The `@type` of an XDM-defined content type that is supported by this channel." }, - "description" : "The content types that this channel can deliver." + "description": "The content types that this channel can deliver." }, - "xdm:metricTypes" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "uri", - "description" : "The `@type` of an XDM-defined metric that is supported by this channel." + "xdm:metricTypes": { + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The `@type` of an XDM-defined metric that is supported by this channel." }, - "description" : "The metrics that can be collected in this channel." + "description": "The metrics that can be collected in this channel." }, - "xdm:locationTypes" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "uri", - "description" : "The `@type` of an XDM-defined location (virtual place) that this channel can contain." + "xdm:locationTypes": { + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The `@type` of an XDM-defined location (virtual place) that this channel can contain." }, - "description" : "The types of locations (virtual places) that this channel consists of and can deliver content to." + "description": "The types of locations (virtual places) that this channel consists of and can deliver content to." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/channel" - } ], - "required" : [ "@id" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/channel" + } + ], + "required": ["@id"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/channels/phone.schema.json b/components/datatypes/channels/phone.schema.json index dec0af908..3b01e872d 100644 --- a/components/datatypes/channels/phone.schema.json +++ b/components/datatypes/channels/phone.schema.json @@ -1,81 +1,92 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/channels/phone", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Phone Channel", - "description" : "The telephone channel includes both inbound and outbound messages.", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/channels/channel#/definitions/channel" ], - "type" : "object", - "meta:abstract" : true, - "definitions" : { - "channel" : { - "properties" : { - "@id" : { - "type" : "string", - "format" : "uri-reference", - "const" : "https://ns.adobe.com/xdm/channels/phone", - "description" : "The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/channels/phone", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Phone Channel", + "description": "The telephone channel includes both inbound and outbound messages.", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/channels/channel#/definitions/channel" + ], + "type": "object", + "meta:abstract": true, + "definitions": { + "channel": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "const": "https://ns.adobe.com/xdm/channels/phone", + "description": "The ID uniquely identifies the channel. Each specific experience channel defines a constant `@id`." }, - "xdm:mode" : { - "type" : "string", - "const" : "bidirectional", - "description" : "How experiences are delivered in this channel.", - "meta:enum" : { - "push" : "The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in.", - "pull" : "The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered.", - "bidirectional" : "Both `push` and `pull` interaction modes are supported by the channel." + "xdm:mode": { + "type": "string", + "const": "bidirectional", + "description": "How experiences are delivered in this channel.", + "meta:enum": { + "push": "The publisher of an experience can initiate an experience by sending a message into the channel. Most `push` channels involve some form of subscription or opt-in.", + "pull": "The consumer can initiate an experience by requesting a location in the channel. Most `pull` channels give publishers some control how the experience is then delivered.", + "bidirectional": "Both `push` and `pull` interaction modes are supported by the channel." } }, - "@type" : { - "type" : "string", - "format" : "uri", - "description" : "The `@type` property is used to provide a rough classification of channels with similar properties.", - "const" : "https://ns.adobe.com/xdm/channel-types/offline", - "meta:enum" : { - "https://ns.adobe.com/xdm/channel-types/web" : "The world wide web, including mobile web", - "https://ns.adobe.com/xdm/channel-types/social" : "Social media platforms", - "https://ns.adobe.com/xdm/channel-types/mobile" : "Mobile apps", - "https://ns.adobe.com/xdm/channel-types/messaging" : "Instant messaging", - "https://ns.adobe.com/xdm/channel-types/email" : "Email", - "https://ns.adobe.com/xdm/channel-types/offline" : "Non-digital experience channels" + "@type": { + "type": "string", + "format": "uri", + "description": "The `@type` property is used to provide a rough classification of channels with similar properties.", + "const": "https://ns.adobe.com/xdm/channel-types/offline", + "meta:enum": { + "https://ns.adobe.com/xdm/channel-types/web": "The world wide web, including mobile web", + "https://ns.adobe.com/xdm/channel-types/social": "Social media platforms", + "https://ns.adobe.com/xdm/channel-types/mobile": "Mobile apps", + "https://ns.adobe.com/xdm/channel-types/messaging": "Instant messaging", + "https://ns.adobe.com/xdm/channel-types/email": "Email", + "https://ns.adobe.com/xdm/channel-types/offline": "Non-digital experience channels" } }, - "xdm:contentTypes" : { - "type" : "array", - "items" : { - "type" : "string" + "xdm:contentTypes": { + "type": "array", + "items": { + "type": "string" }, - "const" : [ ], - "description" : "The content types that this channel can deliver." + "const": [], + "description": "The content types that this channel can deliver." }, - "xdm:metricTypes" : { - "type" : "array", - "items" : { - "type" : "string" + "xdm:metricTypes": { + "type": "array", + "items": { + "type": "string" }, - "const" : [ ], - "description" : "The metrics that can be collected in this channel." + "const": [], + "description": "The metrics that can be collected in this channel." }, - "xdm:locationTypes" : { - "type" : "array", - "items" : { - "type" : "string" + "xdm:locationTypes": { + "type": "array", + "items": { + "type": "string" }, - "const" : [ ], - "description" : "The types of locations (virtual places) that this channel consists of and can deliver content to." + "const": [], + "description": "The types of locations (virtual places) that this channel consists of and can deliver content to." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "https://ns.adobe.com/xdm/channels/channel#/definitions/channel" - }, { - "$ref" : "#/definitions/channel" - } ], - "required" : [ "@id" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/channels/channel#/definitions/channel" + }, + { + "$ref": "#/definitions/channel" + } + ], + "required": ["@id"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/consent/consent-field.schema.json b/components/datatypes/consent/consent-field.schema.json index 627d02be3..43ddead4d 100644 --- a/components/datatypes/consent/consent-field.schema.json +++ b/components/datatypes/consent/consent-field.schema.json @@ -1,16 +1,23 @@ { - "meta:license" : [ "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatype/consent-field", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Generic Consent Field", - "description" : "This schema specifies the fields in a basic consent object.", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "definitions" : { }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/consent-field" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-03-19" -} \ No newline at end of file + "meta:license": [ + "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatype/consent-field", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Generic Consent Field", + "description": "This schema specifies the fields in a basic consent object.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/consent-field" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-03-19" +} diff --git a/components/datatypes/consent/consent-preferences.schema.json b/components/datatypes/consent/consent-preferences.schema.json index a51db7335..f21ef3a81 100644 --- a/components/datatypes/consent/consent-preferences.schema.json +++ b/components/datatypes/consent/consent-preferences.schema.json @@ -1,82 +1,87 @@ { - "meta:license" : [ "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/consents-and-preferences", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Consent for Privacy, Personalization and Marketing Preferences", - "description" : "This mixin captures consumer consent for collection and use of data related to privacy, personalization and marketing preferences.", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "definitions" : { - "choice-value" : { - "title" : "Choice Value", - "description" : "The value specified by the user as their preference or the basis of processing that precludes the need for user consent", - "type" : "string", - "enum" : [ "y", "n", "p", "u", "LI", "CT", "CP", "VI", "PI" ], - "meta:enum" : { - "y" : "Yes (opt-in)", - "n" : "No (opt-out)", - "p" : "Pending verification", - "u" : "Unknown", - "LI" : "Legitimate Interest", - "CT" : "Contract", - "CP" : "Compliance with a Legal Obligation", - "VI" : "Vital Interest of the Individual", - "PI" : "Public Interest" + "meta:license": [ + "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/consents-and-preferences", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Consent for Privacy, Personalization and Marketing Preferences", + "description": "This mixin captures consumer consent for collection and use of data related to privacy, personalization and marketing preferences.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "definitions": { + "choice-value": { + "title": "Choice Value", + "description": "The value specified by the user as their preference or the basis of processing that precludes the need for user consent", + "type": "string", + "enum": ["y", "n", "p", "u", "LI", "CT", "CP", "VI", "PI"], + "meta:enum": { + "y": "Yes (opt-in)", + "n": "No (opt-out)", + "p": "Pending verification", + "u": "Unknown", + "LI": "Legitimate Interest", + "CT": "Contract", + "CP": "Compliance with a Legal Obligation", + "VI": "Vital Interest of the Individual", + "PI": "Public Interest" } }, - "timestamp" : { - "title" : "Preference timestamp", - "description" : "Date and time this specific preference was collected. This value should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", - "type" : "string", - "format" : "date-time" + "timestamp": { + "title": "Preference timestamp", + "description": "Date and time this specific preference was collected. This value should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", + "type": "string", + "format": "date-time" }, - "source" : { - "title" : "Preference Source", - "description" : "Through which interface did the user provide this preference value", - "type" : "string", - "maxLength" : 15 + "source": { + "title": "Preference Source", + "description": "Through which interface did the user provide this preference value", + "type": "string", + "maxLength": 15 }, - "reason" : { - "title" : "Opt-out reason", - "type" : "string", - "description" : "Reason for opting out", - "maxLength" : 16 + "reason": { + "title": "Opt-out reason", + "type": "string", + "description": "Reason for opting out", + "maxLength": 16 }, - "subscriptions" : { - "title" : "Subscriptions", - "description" : "A set of notifications, newsletters, etc. to which the user subscribes", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "type" : "object", - "title" : "Subscription", - "description" : "The name or identifier of the specific subscription", - "properties" : { - "xdm:val" : { - "$ref" : "#/definitions/choice-value" + "subscriptions": { + "title": "Subscriptions", + "description": "A set of notifications, newsletters, etc. to which the user subscribes", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "object", + "title": "Subscription", + "description": "The name or identifier of the specific subscription", + "properties": { + "xdm:val": { + "$ref": "#/definitions/choice-value" }, - "xdm:type" : { - "title" : "Subscription Type", - "description" : "The type of subscription", - "type" : "string", - "maxLength" : 15 + "xdm:type": { + "title": "Subscription Type", + "description": "The type of subscription", + "type": "string", + "maxLength": 15 }, - "xdm:subscribers" : { - "title" : "Subscribers", - "description" : "The set of identifiers (email addresses, phone numbers, etc.) for this user who have subscribed", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "type" : "object", - "title" : "Subscriber", - "description" : "The specific identifier (email addresses, phone numbers, etc.) for this subscriber", - "properties" : { - "xdm:time" : { - "$ref" : "#/definitions/timestamp" + "xdm:subscribers": { + "title": "Subscribers", + "description": "The set of identifiers (email addresses, phone numbers, etc.) for this user who have subscribed", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "object", + "title": "Subscriber", + "description": "The specific identifier (email addresses, phone numbers, etc.) for this subscriber", + "properties": { + "xdm:time": { + "$ref": "#/definitions/timestamp" }, - "xdm:source" : { - "$ref" : "#/definitions/source" + "xdm:source": { + "$ref": "#/definitions/source" } } } @@ -84,314 +89,344 @@ } } }, - "consent-field" : { - "type" : "object", - "properties" : { - "xdm:val" : { - "description" : "The value specified by the user as their consent choice or the basis of processing that precludes the need for user consent", - "$ref" : "#/definitions/choice-value" + "consent-field": { + "type": "object", + "properties": { + "xdm:val": { + "description": "The value specified by the user as their consent choice or the basis of processing that precludes the need for user consent", + "$ref": "#/definitions/choice-value" } }, - "required" : [ "xdm:val" ] + "required": ["xdm:val"] }, - "personalization-field" : { - "type" : "object", - "properties" : { - "xdm:val" : { - "$ref" : "#/definitions/choice-value" + "personalization-field": { + "type": "object", + "properties": { + "xdm:val": { + "$ref": "#/definitions/choice-value" } }, - "required" : [ "xdm:val" ] + "required": ["xdm:val"] }, - "base-personalization" : { - "title" : "Personalization Preferences", - "description" : "User's Personalization Preferences", - "type" : "object", - "properties" : { - "xdm:content" : { - "title" : "Personalize Content", - "description" : "Allow personalization of the content on my site or in my apps", - "$ref" : "#/definitions/personalization-field" + "base-personalization": { + "title": "Personalization Preferences", + "description": "User's Personalization Preferences", + "type": "object", + "properties": { + "xdm:content": { + "title": "Personalize Content", + "description": "Allow personalization of the content on my site or in my apps", + "$ref": "#/definitions/personalization-field" } } }, - "marketing-field" : { - "type" : "object", - "properties" : { - "xdm:val" : { - "$ref" : "#/definitions/choice-value" + "marketing-field": { + "type": "object", + "properties": { + "xdm:val": { + "$ref": "#/definitions/choice-value" }, - "xdm:time" : { - "$ref" : "#/definitions/timestamp" + "xdm:time": { + "$ref": "#/definitions/timestamp" }, - "xdm:reason" : { - "$ref" : "#/definitions/reason" + "xdm:reason": { + "$ref": "#/definitions/reason" } }, - "required" : [ "xdm:val" ] + "required": ["xdm:val"] }, - "marketing-with-subscriptions" : { - "type" : "object", - "properties" : { - "xdm:val" : { - "$ref" : "#/definitions/choice-value" + "marketing-with-subscriptions": { + "type": "object", + "properties": { + "xdm:val": { + "$ref": "#/definitions/choice-value" }, - "xdm:time" : { - "$ref" : "#/definitions/timestamp" + "xdm:time": { + "$ref": "#/definitions/timestamp" }, - "xdm:reason" : { - "$ref" : "#/definitions/reason" + "xdm:reason": { + "$ref": "#/definitions/reason" }, - "xdm:subscriptions" : { - "$ref" : "#/definitions/subscriptions" + "xdm:subscriptions": { + "$ref": "#/definitions/subscriptions" } }, - "required" : [ "xdm:val" ] + "required": ["xdm:val"] }, - "base-marketing" : { - "title" : "Marketing Preferences", - "description" : "User's Direct Marketing Preferences", - "type" : "object", - "properties" : { - "xdm:preferred" : { - "title" : "Preferred Channel", - "description" : "User's preferred channel for receiving communications", - "type" : "string", - "enum" : [ "email", "push", "inApp", "sms", "phone", "phyMail", "inVehicle", "inHome", "iot", "social", "other", "none", "unknown" ], - "meta:enum" : { - "email" : "email", - "push" : "Push Notifications", - "inApp" : "In-app Messages", - "sms" : "SMS (Text Messages)", - "phone" : "Phone Calls", - "phyMail" : "Physical Mail", - "inVehicle" : "In-vehicle Messages", - "inHome" : "In-home Messages", - "iot" : "IoT Messages", - "social" : "Social Media", - "other" : "Other", - "none" : "No Preferred Channel", - "unknown" : "Unknown" + "base-marketing": { + "title": "Marketing Preferences", + "description": "User's Direct Marketing Preferences", + "type": "object", + "properties": { + "xdm:preferred": { + "title": "Preferred Channel", + "description": "User's preferred channel for receiving communications", + "type": "string", + "enum": [ + "email", + "push", + "inApp", + "sms", + "phone", + "phyMail", + "inVehicle", + "inHome", + "iot", + "social", + "other", + "none", + "unknown" + ], + "meta:enum": { + "email": "email", + "push": "Push Notifications", + "inApp": "In-app Messages", + "sms": "SMS (Text Messages)", + "phone": "Phone Calls", + "phyMail": "Physical Mail", + "inVehicle": "In-vehicle Messages", + "inHome": "In-home Messages", + "iot": "IoT Messages", + "social": "Social Media", + "other": "Other", + "none": "No Preferred Channel", + "unknown": "Unknown" } }, - "xdm:any" : { - "title" : "General Direct Marketing Preference", - "description" : "Does user permit any type of direct marketing", - "$ref" : "#/definitions/marketing-field" + "xdm:any": { + "title": "General Direct Marketing Preference", + "description": "Does user permit any type of direct marketing", + "$ref": "#/definitions/marketing-field" }, - "xdm:email" : { - "title" : "Receive email", - "description" : "User agrees to receive email", - "$ref" : "#/definitions/marketing-field" + "xdm:email": { + "title": "Receive email", + "description": "User agrees to receive email", + "$ref": "#/definitions/marketing-field" }, - "xdm:push" : { - "title" : "Receive push notifications", - "description" : "User permits receiving push notifications", - "$ref" : "#/definitions/marketing-field" + "xdm:push": { + "title": "Receive push notifications", + "description": "User permits receiving push notifications", + "$ref": "#/definitions/marketing-field" }, - "xdm:sms" : { - "title" : "Receive SMS", - "description" : "User agrees to receive text messages", - "$ref" : "#/definitions/marketing-field" + "xdm:sms": { + "title": "Receive SMS", + "description": "User agrees to receive text messages", + "$ref": "#/definitions/marketing-field" } } }, - "base-marketing-with-subscriptions" : { - "title" : "Marketing Preferences", - "description" : "User's Direct Marketing Preferences", - "type" : "object", - "properties" : { - "xdm:preferred" : { - "title" : "Preferred Channel", - "description" : "User's preferred channel for receiving communications", - "type" : "string", - "enum" : [ "email", "push", "inApp", "sms", "phone", "phyMail", "inVehicle", "inHome", "iot", "social", "other", "none", "unknown" ], - "meta:enum" : { - "email" : "email", - "push" : "Push Notifications", - "inApp" : "In-app Messages", - "sms" : "SMS (Text Messages)", - "phone" : "Phone Calls", - "phyMail" : "Physical Mail", - "inVehicle" : "In-vehicle Messages", - "inHome" : "In-home Messages", - "iot" : "IoT Messages", - "social" : "Social Media", - "other" : "Other", - "none" : "No Preferred Channel", - "unknown" : "Unknown" + "base-marketing-with-subscriptions": { + "title": "Marketing Preferences", + "description": "User's Direct Marketing Preferences", + "type": "object", + "properties": { + "xdm:preferred": { + "title": "Preferred Channel", + "description": "User's preferred channel for receiving communications", + "type": "string", + "enum": [ + "email", + "push", + "inApp", + "sms", + "phone", + "phyMail", + "inVehicle", + "inHome", + "iot", + "social", + "other", + "none", + "unknown" + ], + "meta:enum": { + "email": "email", + "push": "Push Notifications", + "inApp": "In-app Messages", + "sms": "SMS (Text Messages)", + "phone": "Phone Calls", + "phyMail": "Physical Mail", + "inVehicle": "In-vehicle Messages", + "inHome": "In-home Messages", + "iot": "IoT Messages", + "social": "Social Media", + "other": "Other", + "none": "No Preferred Channel", + "unknown": "Unknown" } }, - "xdm:any" : { - "title" : "General Direct Marketing Preference", - "description" : "Does user permit any type of direct marketing", - "$ref" : "#/definitions/marketing-field" + "xdm:any": { + "title": "General Direct Marketing Preference", + "description": "Does user permit any type of direct marketing", + "$ref": "#/definitions/marketing-field" }, - "xdm:email" : { - "title" : "Receive email", - "description" : "User agrees to receive email", - "$ref" : "#/definitions/marketing-with-subscriptions" + "xdm:email": { + "title": "Receive email", + "description": "User agrees to receive email", + "$ref": "#/definitions/marketing-with-subscriptions" }, - "xdm:push" : { - "title" : "Receive push notifications", - "description" : "User permits receiving push notifications", - "$ref" : "#/definitions/marketing-with-subscriptions" + "xdm:push": { + "title": "Receive push notifications", + "description": "User permits receiving push notifications", + "$ref": "#/definitions/marketing-with-subscriptions" }, - "xdm:sms" : { - "title" : "Receive SMS", - "description" : "User agrees to receive text messages", - "$ref" : "#/definitions/marketing-with-subscriptions" + "xdm:sms": { + "title": "Receive SMS", + "description": "User agrees to receive text messages", + "$ref": "#/definitions/marketing-with-subscriptions" } } }, - "idSpecific-marketing" : { - "title" : "Marketing Preferences", - "description" : "User's Direct Marketing Preferences", - "type" : "object", - "properties" : { - "xdm:email" : { - "title" : "Receive email", - "description" : "User agrees to receive email", - "$ref" : "#/definitions/marketing-field" + "idSpecific-marketing": { + "title": "Marketing Preferences", + "description": "User's Direct Marketing Preferences", + "type": "object", + "properties": { + "xdm:email": { + "title": "Receive email", + "description": "User agrees to receive email", + "$ref": "#/definitions/marketing-field" }, - "xdm:push" : { - "title" : "Receive push notifications", - "description" : "User permits receiving push notifications", - "$ref" : "#/definitions/marketing-field" + "xdm:push": { + "title": "Receive push notifications", + "description": "User permits receiving push notifications", + "$ref": "#/definitions/marketing-field" }, - "xdm:sms" : { - "title" : "Receive SMS", - "description" : "User agrees to receive text messages", - "$ref" : "#/definitions/marketing-field" + "xdm:sms": { + "title": "Receive SMS", + "description": "User agrees to receive text messages", + "$ref": "#/definitions/marketing-field" } } }, - "metadata" : { - "properties" : { - "xdm:time" : { - "title" : "Consent/Preferences timestamp", - "description" : "Timestamp of this complete set of user consents and preferences. This value should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", - "type" : "string", - "format" : "date-time" + "metadata": { + "properties": { + "xdm:time": { + "title": "Consent/Preferences timestamp", + "description": "Timestamp of this complete set of user consents and preferences. This value should conform to ISO 8601 standard. An example form is \"2004-10-23T12:00:00-06:00\".", + "type": "string", + "format": "date-time" } } }, - "consent-preferences" : { - "properties" : { - "xdm:consents" : { - "title" : "Consents and Preferences", - "description" : "Specific Consent and Preference Options", - "type" : "object", - "properties" : { - "xdm:collect" : { - "title" : "Data Collection", - "description" : "Data collection is permitted", - "$ref" : "#/definitions/consent-field" + "consent-preferences": { + "properties": { + "xdm:consents": { + "title": "Consents and Preferences", + "description": "Specific Consent and Preference Options", + "type": "object", + "properties": { + "xdm:collect": { + "title": "Data Collection", + "description": "Data collection is permitted", + "$ref": "#/definitions/consent-field" }, - "xdm:share" : { - "title" : "Share Data", - "description" : "Sharing of user's data with 2nd or 3rd parties is permitted", - "$ref" : "#/definitions/consent-field" + "xdm:share": { + "title": "Share Data", + "description": "Sharing of user's data with 2nd or 3rd parties is permitted", + "$ref": "#/definitions/consent-field" }, - "xdm:adID" : { - "title" : "Use Advertiser ID", - "description" : "The Advertiser ID (IDFA / AAID) can be used to link user across apps on this device", - "$ref" : "#/definitions/consent-field" + "xdm:adID": { + "title": "Use Advertiser ID", + "description": "The Advertiser ID (IDFA / AAID) can be used to link user across apps on this device", + "$ref": "#/definitions/consent-field" }, - "xdm:personalize" : { - "$ref" : "#/definitions/base-personalization" + "xdm:personalize": { + "$ref": "#/definitions/base-personalization" }, - "xdm:marketing" : { - "$ref" : "#/definitions/base-marketing" + "xdm:marketing": { + "$ref": "#/definitions/base-marketing" }, - "xdm:metadata" : { - "title" : "Consent and Preference Metadata", - "description" : "Metadata that applies to all consents and preferences that don't specify a different value", - "$ref" : "#/definitions/metadata" + "xdm:metadata": { + "title": "Consent and Preference Metadata", + "description": "Metadata that applies to all consents and preferences that don't specify a different value", + "$ref": "#/definitions/metadata" } } } } }, - "profile-consents" : { - "properties" : { - "xdm:consents" : { - "title" : "Consents and Preferences", - "description" : "Specific Consent and Preference Options", - "type" : "object", - "properties" : { - "xdm:collect" : { - "title" : "Data Collection", - "description" : "Data collection is permitted", - "$ref" : "#/definitions/consent-field" + "profile-consents": { + "properties": { + "xdm:consents": { + "title": "Consents and Preferences", + "description": "Specific Consent and Preference Options", + "type": "object", + "properties": { + "xdm:collect": { + "title": "Data Collection", + "description": "Data collection is permitted", + "$ref": "#/definitions/consent-field" }, - "xdm:share" : { - "title" : "Share Data", - "description" : "Sharing of user's data with 2nd or 3rd parties is permitted", - "$ref" : "#/definitions/consent-field" + "xdm:share": { + "title": "Share Data", + "description": "Sharing of user's data with 2nd or 3rd parties is permitted", + "$ref": "#/definitions/consent-field" }, - "xdm:personalize" : { - "$ref" : "#/definitions/base-personalization" + "xdm:personalize": { + "$ref": "#/definitions/base-personalization" }, - "xdm:marketing" : { - "$ref" : "#/definitions/base-marketing-with-subscriptions" + "xdm:marketing": { + "$ref": "#/definitions/base-marketing-with-subscriptions" }, - "xdm:idSpecific" : { - "title" : "Identifier specific", - "description" : "Identifier specific consents and preferences", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "title" : "Identifier Type", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "type" : "object", - "title" : "Identifier", - "properties" : { - "xdm:collect" : { - "title" : "Data Collection", - "description" : "Data collection is permitted", - "$ref" : "#/definitions/consent-field" + "xdm:idSpecific": { + "title": "Identifier specific", + "description": "Identifier specific consents and preferences", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Identifier Type", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "object", + "title": "Identifier", + "properties": { + "xdm:collect": { + "title": "Data Collection", + "description": "Data collection is permitted", + "$ref": "#/definitions/consent-field" }, - "xdm:share" : { - "title" : "Share Data", - "description" : "Sharing of user's data with 2nd or 3rd parties is permitted", - "$ref" : "#/definitions/consent-field" + "xdm:share": { + "title": "Share Data", + "description": "Sharing of user's data with 2nd or 3rd parties is permitted", + "$ref": "#/definitions/consent-field" }, - "xdm:adID" : { - "title" : "Use Advertiser ID", - "description" : "The Advertiser ID (IDFA / AAID) can be used to link user across apps on this device", - "$ref" : "#/definitions/consent-field" + "xdm:adID": { + "title": "Use Advertiser ID", + "description": "The Advertiser ID (IDFA / AAID) can be used to link user across apps on this device", + "$ref": "#/definitions/consent-field" }, - "xdm:personalize" : { - "$ref" : "#/definitions/base-personalization" + "xdm:personalize": { + "$ref": "#/definitions/base-personalization" }, - "xdm:marketing" : { - "$ref" : "#/definitions/idSpecific-marketing" + "xdm:marketing": { + "$ref": "#/definitions/idSpecific-marketing" } } } }, - "xdm:metadata" : { - "title" : "Consent and Preference Metadata", - "description" : "Metadata that applies to all consents and preferences that don't specify a different value", - "$ref" : "#/definitions/metadata" + "xdm:metadata": { + "title": "Consent and Preference Metadata", + "description": "Metadata that applies to all consents and preferences that don't specify a different value", + "$ref": "#/definitions/metadata" } }, - "xdm:metadata" : { - "title" : "Consent and Preference Metadata", - "description" : "Metadata that applies to all consents and preferences that don't specify a different value", - "$ref" : "#/definitions/metadata" + "xdm:metadata": { + "title": "Consent and Preference Metadata", + "description": "Metadata that applies to all consents and preferences that don't specify a different value", + "$ref": "#/definitions/metadata" } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/consent-preferences" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/consent-preferences" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/consent/consentstring.schema.json b/components/datatypes/consent/consentstring.schema.json index efa866a0c..b614c735d 100644 --- a/components/datatypes/consent/consentstring.schema.json +++ b/components/datatypes/consent/consentstring.schema.json @@ -1,49 +1,57 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/consentstring", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Consent String", - "type" : "object", - "meta:extensible" : true, - "description" : "Consent String as presented by user along with standard information to help consent enforcer to parse the String.", - "definitions" : { - "consentstring" : { - "properties" : { - "xdm:consentStandard" : { - "title" : "Standard for the consent", - "type" : "string", - "description" : "This helps determine the format of the consent string as set by consent management services." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/consentstring", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Consent String", + "type": "object", + "meta:extensible": true, + "description": "Consent String as presented by user along with standard information to help consent enforcer to parse the String.", + "definitions": { + "consentstring": { + "properties": { + "xdm:consentStandard": { + "title": "Standard for the consent", + "type": "string", + "description": "This helps determine the format of the consent string as set by consent management services." }, - "xdm:consentStandardVersion" : { - "title" : "Standards Version", - "type" : "string", - "description" : "Standards version to accurately define the format of the consent string as set by consent management services." + "xdm:consentStandardVersion": { + "title": "Standards Version", + "type": "string", + "description": "Standards version to accurately define the format of the consent string as set by consent management services." }, - "xdm:consentStringValue" : { - "title" : "Consent String", - "type" : "string", - "description" : "Full consent string as provided by consent management services. Standard and Version help define how to parse this string." + "xdm:consentStringValue": { + "title": "Consent String", + "type": "string", + "description": "Full consent string as provided by consent management services. Standard and Version help define how to parse this string." }, - "xdm:gdprApplies" : { - "title" : "GDPR Applies", - "type" : "boolean", - "default" : false, - "description" : "If this is true, it means this consent string needs to be processed for consent enforcement." + "xdm:gdprApplies": { + "title": "GDPR Applies", + "type": "boolean", + "default": false, + "description": "If this is true, it means this consent string needs to be processed for consent enforcement." }, - "xdm:containsPersonalData" : { - "title" : "Contains personal data", - "type" : "boolean", - "description" : "If this is true, it means consent is coming with personal data." + "xdm:containsPersonalData": { + "title": "Contains personal data", + "type": "boolean", + "description": "If this is true, it means consent is coming with personal data." } }, - "required" : [ "xdm:gdprApplies" ] + "required": ["xdm:gdprApplies"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/consentstring" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/consentstring" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/consent/marketing-field-basic.schema.json b/components/datatypes/consent/marketing-field-basic.schema.json index 6f2fe811d..69efd889d 100644 --- a/components/datatypes/consent/marketing-field-basic.schema.json +++ b/components/datatypes/consent/marketing-field-basic.schema.json @@ -1,16 +1,23 @@ { - "meta:license" : [ "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatype/marketing-preference-field", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Generic Marketing Preference Field", - "description" : "This schema specifies the fields in a basic marketing preference object.", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "definitions" : { }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/marketing-field" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-03-19" -} \ No newline at end of file + "meta:license": [ + "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatype/marketing-preference-field", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Generic Marketing Preference Field", + "description": "This schema specifies the fields in a basic marketing preference object.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/marketing-field" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-03-19" +} diff --git a/components/datatypes/consent/marketing-field-subscription.schema.json b/components/datatypes/consent/marketing-field-subscription.schema.json index 0be070d1a..41fb7a9e9 100644 --- a/components/datatypes/consent/marketing-field-subscription.schema.json +++ b/components/datatypes/consent/marketing-field-subscription.schema.json @@ -1,16 +1,23 @@ { - "meta:license" : [ "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatype/marketing-preference-with-subscriptions", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Generic Marketing Preference Field with Subscriptions", - "description" : "This schema specifies the fields in a marketing preference object that includes subscriptions.", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "definitions" : { }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/marketing-with-subscriptions" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-03-19" -} \ No newline at end of file + "meta:license": [ + "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatype/marketing-preference-with-subscriptions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Generic Marketing Preference Field with Subscriptions", + "description": "This schema specifies the fields in a marketing preference object that includes subscriptions.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/marketing-with-subscriptions" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-03-19" +} diff --git a/components/datatypes/consent/personalization-field.schema.json b/components/datatypes/consent/personalization-field.schema.json index bb4dc6600..d9b6f6a6f 100644 --- a/components/datatypes/consent/personalization-field.schema.json +++ b/components/datatypes/consent/personalization-field.schema.json @@ -1,16 +1,23 @@ { - "meta:license" : [ "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatype/personalization-preference-field", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Generic Personalization Preference Field", - "description" : "This schema specifies the fields in a basic personalization preference object.", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "definitions" : { }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/personalization-field" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-03-19" -} \ No newline at end of file + "meta:license": [ + "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatype/personalization-preference-field", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Generic Personalization Preference Field", + "description": "This schema specifies the fields in a basic personalization preference object.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/personalization-field" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-03-19" +} diff --git a/components/datatypes/currency.schema.json b/components/datatypes/currency.schema.json index 686f58047..348b45ed1 100644 --- a/components/datatypes/currency.schema.json +++ b/components/datatypes/currency.schema.json @@ -1,38 +1,45 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/currency", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Currency", - "type" : "object", - "meta:extensible" : true, - "description" : "This datatype is used where ever you want to store any kind of amount in combination of currency code.", - "definitions" : { - "currency" : { - "properties" : { - "xdm:amount" : { - "title" : "Amount", - "description" : "Amount represented by the currencyCode", - "type" : "number" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/currency", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Currency", + "type": "object", + "meta:extensible": true, + "description": "This datatype is used where ever you want to store any kind of amount in combination of currency code.", + "definitions": { + "currency": { + "properties": { + "xdm:amount": { + "title": "Amount", + "description": "Amount represented by the currencyCode", + "type": "number" }, - "xdm:currencyCode" : { - "title" : "Currency Code", - "type" : "string", - "examples" : [ "USD", "EUR" ], - "pattern" : "^[A-Z]{3}$", - "description" : "The ISO 4217 currency code." + "xdm:currencyCode": { + "title": "Currency Code", + "type": "string", + "examples": ["USD", "EUR"], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code." }, - "xdm:conversionDate" : { - "title" : "Conversion Date", - "description" : "Date when currency conversion was made.", - "type" : "string", - "format" : "date-time" + "xdm:conversionDate": { + "title": "Conversion Date", + "description": "Date when currency conversion was made.", + "type": "string", + "format": "date-time" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/currency" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-09-29" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/currency" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-09-29" +} diff --git a/components/datatypes/data/bounces.schema.json b/components/datatypes/data/bounces.schema.json index c0582322b..702af1872 100644 --- a/components/datatypes/data/bounces.schema.json +++ b/components/datatypes/data/bounces.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Bounces", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric bounces describes the number of asynchronous messages that have been rejected by the receiving system.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:bounces", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/bounces", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Bounces", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric bounces describes the number of asynchronous messages that have been rejected by the receiving system.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:bounces", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: bounces", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: bounces", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/cart-abandons.schema.json b/components/datatypes/data/cart-abandons.schema.json index 17c11422c..ddce43868 100644 --- a/components/datatypes/data/cart-abandons.schema.json +++ b/components/datatypes/data/cart-abandons.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/cart-abandons", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Cart Abandons", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "Number of cart abandons for which a product list has been identified as no longer purchasable or accessible by the user without the user re-creating the product list from scratch.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:cartAbandons", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/cart-abandons", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Cart Abandons", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "Number of cart abandons for which a product list has been identified as no longer purchasable or accessible by the user without the user re-creating the product list from scratch.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:cartAbandons", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: cartAbandons", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: cartAbandons", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/checkouts.schema.json b/components/datatypes/data/checkouts.schema.json index 7f3c8308b..83caa5cf9 100644 --- a/components/datatypes/data/checkouts.schema.json +++ b/components/datatypes/data/checkouts.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/checkouts", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Checkouts", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "Number of actions during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:checkouts", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/checkouts", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Checkouts", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "Number of actions during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:checkouts", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: checkouts", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: checkouts", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/datasource.schema.json b/components/datatypes/data/datasource.schema.json index 410e36a86..11a823746 100644 --- a/components/datatypes/data/datasource.schema.json +++ b/components/datatypes/data/datasource.schema.json @@ -1,40 +1,47 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/datasource", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Data Source", - "type" : "object", - "description" : "The data source acts as a namespace or unique identifier associated with a collection of data. Each EndUserID is associated with a given data source. A user can create and obtain information about a data source during the solution onboarding.\n", - "definitions" : { - "datasource" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "The unique ID of this data source. This would be provided by the individual or system that created the data source.\n" + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/datasource", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Data Source", + "type": "object", + "description": "The data source acts as a namespace or unique identifier associated with a collection of data. Each EndUserID is associated with a given data source. A user can create and obtain information about a data source during the solution onboarding.\n", + "definitions": { + "datasource": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The unique ID of this data source. This would be provided by the individual or system that created the data source.\n" }, - "xdm:code" : { - "title" : "Code", - "type" : "string", - "description" : "The code is a shortcut to the full @id and at least one of the code or @id can be used. Sometimes, this code is referred to as the data source integration code." + "xdm:code": { + "title": "Code", + "type": "string", + "description": "The code is a shortcut to the full @id and at least one of the code or @id can be used. Sometimes, this code is referred to as the data source integration code." }, - "xdm:tags" : { - "title" : "Tags", - "type" : "array", - "description" : "Tags are used to indicate how the aliases represented by a given data\nsource should be interpreted by applications using those aliases.\n\nExamples:\n\n* `isAVID`: data sources representing Analytics visitor IDs.\n* `isCRSKey`: data sources representing aliases that should be used as keys in CRS.\n\nTags are set when the data source is created but they are also included in\npipeline messages when referencing a given data source.\n", - "uniqueItems" : true, - "items" : { - "type" : "string" + "xdm:tags": { + "title": "Tags", + "type": "array", + "description": "Tags are used to indicate how the aliases represented by a given data\nsource should be interpreted by applications using those aliases.\n\nExamples:\n\n* `isAVID`: data sources representing Analytics visitor IDs.\n* `isCRSKey`: data sources representing aliases that should be used as keys in CRS.\n\nTags are set when the data source is created but they are also included in\npipeline messages when referencing a given data source.\n", + "uniqueItems": true, + "items": { + "type": "string" } } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "#/definitions/datasource" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/datasource" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/impressions.schema.json b/components/datatypes/data/impressions.schema.json index 102965984..3b1ab0c8f 100644 --- a/components/datatypes/data/impressions.schema.json +++ b/components/datatypes/data/impressions.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/advertising/impressions", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Impressions", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The metric impressions describes the number of digital assets rendered.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:impressions", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/advertising/impressions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Impressions", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The metric impressions describes the number of digital assets rendered.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:impressions", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "metric: impressions", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "metric: impressions", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/linkclicks.schema.json b/components/datatypes/data/linkclicks.schema.json index 803b9e254..da7e44e6c 100644 --- a/components/datatypes/data/linkclicks.schema.json +++ b/components/datatypes/data/linkclicks.schema.json @@ -1,43 +1,51 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/web/linkclicks", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Link-Clicks", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The web metric `link-clicks` describes the number of clicks on a link on a web page.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "format" : "uri-reference", - "const" : "xdm:linkClicks", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/web/linkclicks", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Link-Clicks", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The web metric `link-clicks` describes the number of clicks on a link on a web page.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "const": "xdm:linkClicks", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "web metric: linkClicks", - "description" : "The web metric `link-clicks` describes the number of clicks on a link on a web page." + "schema:name": { + "type": "string", + "const": "web metric: linkClicks", + "description": "The web metric `link-clicks` describes the number of clicks on a link on a web page." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/measure.schema.json b/components/datatypes/data/measure.schema.json index 66e5dffae..4886136bb 100644 --- a/components/datatypes/data/measure.schema.json +++ b/components/datatypes/data/measure.schema.json @@ -1,30 +1,37 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/measure", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Measure", - "type" : "object", - "meta:extensible" : false, - "description" : "", - "definitions" : { - "measure" : { - "properties" : { - "xdm:id" : { - "title" : "Unique Identifier", - "type" : "string", - "description" : "Unique identifier of the measure. In cases of data collection using lossy communication channels, such as mobile apps or websites with offline functionality, where transmission of measures cannot be ensured, this property contains a client-generated, unique ID of the measure taken. It is best practice to make this sufficiently long to ensure enough entropy. Additionally, if information such as time stamp, device ID, IP, or MAC address, or other potentially user-identifying values are incorporated in the generation of the xdm:id, the result should be hashed, so that no PII is encoded in the value, as the goal is not to identify user or device, but the specific measure in time." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/measure", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Measure", + "type": "object", + "meta:extensible": false, + "description": "", + "definitions": { + "measure": { + "properties": { + "xdm:id": { + "title": "Unique Identifier", + "type": "string", + "description": "Unique identifier of the measure. In cases of data collection using lossy communication channels, such as mobile apps or websites with offline functionality, where transmission of measures cannot be ensured, this property contains a client-generated, unique ID of the measure taken. It is best practice to make this sufficiently long to ensure enough entropy. Additionally, if information such as time stamp, device ID, IP, or MAC address, or other potentially user-identifying values are incorporated in the generation of the xdm:id, the result should be hashed, so that no PII is encoded in the value, as the goal is not to identify user or device, but the specific measure in time." }, - "xdm:value" : { - "type" : "number", - "description" : "The quantifiable value of this measure." + "xdm:value": { + "type": "number", + "description": "The quantifiable value of this measure." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/measure" - } ], - "required" : [ "xdm:value" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/measure" + } + ], + "required": ["xdm:value"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/metricdefinition.schema.json b/components/datatypes/data/metricdefinition.schema.json index 8f86d533a..0fa5b7327 100644 --- a/components/datatypes/data/metricdefinition.schema.json +++ b/components/datatypes/data/metricdefinition.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metricdefinition", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Metric Definition", - "type" : "object", - "meta:extensible" : true, - "description" : "", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "format" : "uri-reference", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metricdefinition", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Metric Definition", + "type": "object", + "meta:extensible": true, + "description": "", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "examples" : [ "distance", "time", "price", "count" ] + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "examples": ["distance", "time", "price", "count"] }, - "xdm:unit" : { - "type" : "string", - "description" : "The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null)", - "examples" : [ "m", "kg", "s", "USD" ] + "xdm:unit": { + "type": "string", + "description": "The unit that this metric is measured in. Whenever possible, metrics should follow the [SI base units](https://www.bipm.org/en/measurement-units/) or be [ISO 4217 currency codes](https://www.iso.org/iso-4217-currency-codes.html).For metric that are counts, the `xdm:unit` must be empty string (equivalent to null)", + "examples": ["m", "kg", "s", "USD"] } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/mirror-pages.schema.json b/components/datatypes/data/mirror-pages.schema.json index f5edbb1ca..92086a4b3 100644 --- a/components/datatypes/data/mirror-pages.schema.json +++ b/components/datatypes/data/mirror-pages.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Mirror Pages", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric `mirror-page`s describes the number of mirror pages for which a link to the online mirror page of a message has been clicked.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:mirrorPages", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/mirror-pages", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Mirror Pages", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric `mirror-page`s describes the number of mirror pages for which a link to the online mirror page of a message has been clicked.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:mirrorPages", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: mirrorPages", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: mirrorPages", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/non-deliverables.schema.json b/components/datatypes/data/non-deliverables.schema.json index 8fd9069ac..e9e80933c 100644 --- a/components/datatypes/data/non-deliverables.schema.json +++ b/components/datatypes/data/non-deliverables.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Non-Deliverables", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric `non-deliverables` describes the umber of asynchronous messages that failed to deliver in a way that indicates that no future messages will be deliverable either to this address.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:nonDeliverables", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/non-deliverables", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Non-Deliverables", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric `non-deliverables` describes the umber of asynchronous messages that failed to deliver in a way that indicates that no future messages will be deliverable either to this address.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:nonDeliverables", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: nonDeliverables", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: nonDeliverables", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/not-sent.schema.json b/components/datatypes/data/not-sent.schema.json index 666ca1f94..718800b62 100644 --- a/components/datatypes/data/not-sent.schema.json +++ b/components/datatypes/data/not-sent.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/notSent", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Not Sent", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric `not-sent` describes the number of asynchronous messages (email, SMS, MMS etc) that have not been dispatched to an recipient's account/address/device due to cancellation or expiration of the marketing activity.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:notSent", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/notSent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Not Sent", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric `not-sent` describes the number of asynchronous messages (email, SMS, MMS etc) that have not been dispatched to an recipient's account/address/device due to cancellation or expiration of the marketing activity.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:notSent", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: notSent", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: notSent", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/opens.schema.json b/components/datatypes/data/opens.schema.json index db94c55f9..0ae7a0656 100644 --- a/components/datatypes/data/opens.schema.json +++ b/components/datatypes/data/opens.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Opens", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric `opens` describes the number of times the direct marketing messages (email, SMS, Push Notifications etc) have been opened/swiped/touched by the recipients.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:opens", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/opens", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Opens", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric `opens` describes the number of times the direct marketing messages (email, SMS, Push Notifications etc) have been opened/swiped/touched by the recipients.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:opens", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: opens", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: opens", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/order.schema.json b/components/datatypes/data/order.schema.json index 763270f0f..c024359f9 100644 --- a/components/datatypes/data/order.schema.json +++ b/components/datatypes/data/order.schema.json @@ -1,49 +1,56 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/order", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Order", - "type" : "object", - "description" : "The order placed for a product list.", - "definitions" : { - "order" : { - "properties" : { - "xdm:purchaseID" : { - "title" : "Purchase ID", - "type" : "string", - "description" : "Unique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/order", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Order", + "type": "object", + "description": "The order placed for a product list.", + "definitions": { + "order": { + "properties": { + "xdm:purchaseID": { + "title": "Purchase ID", + "type": "string", + "description": "Unique identifier assigned by the seller for this purchase or contract. There is no guarantee that the ID is unique." }, - "xdm:purchaseOrderNumber" : { - "title" : "Purchase Order Number", - "type" : "string", - "description" : "Unique identifier assigned by the purchaser for this purchase or contract." + "xdm:purchaseOrderNumber": { + "title": "Purchase Order Number", + "type": "string", + "description": "Unique identifier assigned by the purchaser for this purchase or contract." }, - "xdm:payments" : { - "title" : "Payment List", - "type" : "array", - "description" : "The list of payments for this order.", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/data/paymentitem" + "xdm:payments": { + "title": "Payment List", + "type": "array", + "description": "The list of payments for this order.", + "items": { + "$ref": "https://ns.adobe.com/xdm/data/paymentitem" } }, - "xdm:currencyCode" : { - "title" : "Currency", - "type" : "string", - "examples" : [ "USD", "EUR" ], - "pattern" : "^[A-Z]{3}$", - "description" : "The ISO 4217 currency code used for the order totals." + "xdm:currencyCode": { + "title": "Currency", + "type": "string", + "examples": ["USD", "EUR"], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code used for the order totals." }, - "xdm:priceTotal" : { - "title" : "Price Total", - "type" : "number", - "description" : "The total price of this order after all discounts and taxes have been applied." + "xdm:priceTotal": { + "title": "Price Total", + "type": "number", + "description": "The total price of this order after all discounts and taxes have been applied." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/order" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/order" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/pageviews.schema.json b/components/datatypes/data/pageviews.schema.json index 5051ec8ff..494dbc69d 100644 --- a/components/datatypes/data/pageviews.schema.json +++ b/components/datatypes/data/pageviews.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/web/pageviews", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Page Views", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The web metric `pageViews` describes the number of impressions of a web page.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:pageViews", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/web/pageviews", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Page Views", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The web metric `pageViews` describes the number of impressions of a web page.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:pageViews", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "web metric: pageViews", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "web metric: pageViews", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/paymentitem.schema.json b/components/datatypes/data/paymentitem.schema.json index 131ce378f..f0fd589c5 100644 --- a/components/datatypes/data/paymentitem.schema.json +++ b/components/datatypes/data/paymentitem.schema.json @@ -1,53 +1,60 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/paymentitem", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Payment Item", - "type" : "object", - "description" : "A payment associated with an order that defines the type of payment, the amount and the associated currency.", - "definitions" : { - "paymentitem" : { - "properties" : { - "xdm:transactionID" : { - "title" : "Transaction ID", - "type" : "string", - "description" : "The unique transaction identifier for this payment item." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/paymentitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Payment Item", + "type": "object", + "description": "A payment associated with an order that defines the type of payment, the amount and the associated currency.", + "definitions": { + "paymentitem": { + "properties": { + "xdm:transactionID": { + "title": "Transaction ID", + "type": "string", + "description": "The unique transaction identifier for this payment item." }, - "xdm:paymentAmount" : { - "title" : "Payment Amount", - "type" : "number", - "description" : "The value of the payment." + "xdm:paymentAmount": { + "title": "Payment Amount", + "type": "number", + "description": "The value of the payment." }, - "xdm:paymentType" : { - "title" : "Payment Type", - "type" : "string", - "description" : "The method of payment for this order. Enumerated, custom values allowed.", - "default" : "other", - "meta:enum" : { - "cash" : "Cash", - "credit_card" : "Credit Card", - "debit_card" : "Debit Card", - "gift_card" : "Gift Card", - "check" : "Check", - "paypal" : "PayPal", - "wire_transfer" : "Wire Transfer", - "credit_card_reference" : "Credit Card Reference Transaction", - "other" : "Other" + "xdm:paymentType": { + "title": "Payment Type", + "type": "string", + "description": "The method of payment for this order. Enumerated, custom values allowed.", + "default": "other", + "meta:enum": { + "cash": "Cash", + "credit_card": "Credit Card", + "debit_card": "Debit Card", + "gift_card": "Gift Card", + "check": "Check", + "paypal": "PayPal", + "wire_transfer": "Wire Transfer", + "credit_card_reference": "Credit Card Reference Transaction", + "other": "Other" } }, - "xdm:currencyCode" : { - "title" : "Currency Code", - "type" : "string", - "examples" : [ "USD", "EUR" ], - "pattern" : "^[A-Z]{3}$", - "description" : "The ISO 4217 currency code used for this payment item." + "xdm:currencyCode": { + "title": "Currency Code", + "type": "string", + "examples": ["USD", "EUR"], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code used for this payment item." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/paymentitem" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/paymentitem" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/poi-entries.schema.json b/components/datatypes/data/poi-entries.schema.json index b903a9576..72569d249 100644 --- a/components/datatypes/data/poi-entries.schema.json +++ b/components/datatypes/data/poi-entries.schema.json @@ -1,43 +1,51 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Point of Interest (POI) Entries", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The place context metric `poi-entries` describes the number of times a person has left a point of interest (POI).", - "definitions" : { - "metric" : { - "properties" : { - "@id" : { - "type" : "string", - "format" : "uri-reference", - "const" : "xdm:poiEntries", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-entries", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of Interest (POI) Entries", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The place context metric `poi-entries` describes the number of times a person has left a point of interest (POI).", + "definitions": { + "metric": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "const": "xdm:poiEntries", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "placecontext: poiEntries", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "placecontext: poiEntries", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metric" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metric" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/poi-exits.schema.json b/components/datatypes/data/poi-exits.schema.json index 8be5d8222..12fed414c 100644 --- a/components/datatypes/data/poi-exits.schema.json +++ b/components/datatypes/data/poi-exits.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Point of Interest (POI) Exits", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The place context metric `poi-exits` describes the number of times a person has left a point of interest (POI).", - "definitions" : { - "metric" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:poiExits", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/placecontext/poi-exits", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of Interest (POI) Exits", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The place context metric `poi-exits` describes the number of times a person has left a point of interest (POI).", + "definitions": { + "metric": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:poiExits", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "placecontext: poiExits", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "placecontext: poiExits", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metric" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metric" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/product-list-adds.schema.json b/components/datatypes/data/product-list-adds.schema.json index f636c660b..5e7a8d970 100644 --- a/components/datatypes/data/product-list-adds.schema.json +++ b/components/datatypes/data/product-list-adds.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/product-list-adds", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product List Adds", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The commerce metric `productListAdds` describes the number of times a product has been added to a product list. The most common case is adding an item to the shopping cart.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:productListAdds", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-adds", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Adds", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The commerce metric `productListAdds` describes the number of times a product has been added to a product list. The most common case is adding an item to the shopping cart.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListAdds", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: productListAdds", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: productListAdds", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/product-list-opens.schema.json b/components/datatypes/data/product-list-opens.schema.json index d8812de16..8e90a8164 100644 --- a/components/datatypes/data/product-list-opens.schema.json +++ b/components/datatypes/data/product-list-opens.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/product-list-opens", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product List Opens", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The commerce metric `product-list-opens` describes how many new product lists have been created. The most common case is the creation of a new shopping cart by putting the first item into the shopping cart.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:productListOpens", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-opens", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Opens", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The commerce metric `product-list-opens` describes how many new product lists have been created. The most common case is the creation of a new shopping cart by putting the first item into the shopping cart.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListOpens", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: productListOpens", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: productListOpens", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/product-list-removals.schema.json b/components/datatypes/data/product-list-removals.schema.json index 8cc3d48e0..f0bfe9129 100644 --- a/components/datatypes/data/product-list-removals.schema.json +++ b/components/datatypes/data/product-list-removals.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/product-list-removals", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product List Removals", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The commerce metric `productListRemovals` describes the number of times a product has been removed from a product list. The most common use case is the removal of a product from the shopping cart.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:productListRemovals", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-removals", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Removals", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The commerce metric `productListRemovals` describes the number of times a product has been removed from a product list. The most common use case is the removal of a product from the shopping cart.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListRemovals", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: productListRemovals", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: productListRemovals", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/product-list-reopens.schema.json b/components/datatypes/data/product-list-reopens.schema.json index 316bedf15..a60b598be 100644 --- a/components/datatypes/data/product-list-reopens.schema.json +++ b/components/datatypes/data/product-list-reopens.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/product-list-reopens", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product List Reopens", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "Number of reopens for which a product list that was no longer accessible has been re-activated by the user, for example via a re-marketing activity.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:productListReopens", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-reopens", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Reopens", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "Number of reopens for which a product list that was no longer accessible has been re-activated by the user, for example via a re-marketing activity.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListReopens", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: productListReopens", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: productListReopens", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/product-list-views.schema.json b/components/datatypes/data/product-list-views.schema.json index af43006c4..e3dc06396 100644 --- a/components/datatypes/data/product-list-views.schema.json +++ b/components/datatypes/data/product-list-views.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/product-list-views", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product List Views", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The commerce metric `product-list-views` describes how often a product list has been seen by a shopper. The most common use case is to open the shopping cart to inspect its contents.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:productListViews", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-list-views", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product List Views", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The commerce metric `product-list-views` describes how often a product list has been seen by a shopper. The most common use case is to open the shopping cart to inspect its contents.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productListViews", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: productListViews", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: productListViews", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/product-views.schema.json b/components/datatypes/data/product-views.schema.json index 37544e14c..27903fed2 100644 --- a/components/datatypes/data/product-views.schema.json +++ b/components/datatypes/data/product-views.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/product-views", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product Views", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The commerce metric `productViews` describes the number of product views that have occurred. Because the number of products on a page might be greater than one, this number may differ from the page view count of product pages.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:productViews", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/product-views", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product Views", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The commerce metric `productViews` describes the number of product views that have occurred. Because the number of products on a page might be greater than one, this number may differ from the page view count of product pages.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:productViews", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: productViews", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: productViews", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/purchases.schema.json b/components/datatypes/data/purchases.schema.json index 479189fc1..b3a51d971 100644 --- a/components/datatypes/data/purchases.schema.json +++ b/components/datatypes/data/purchases.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/purchases", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Purchases", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "Number of orders has occurred. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:purchases", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/purchases", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Purchases", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "Number of orders has occurred. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:purchases", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: purchases", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: purchases", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/record-timeseries-events.schema.json b/components/datatypes/data/record-timeseries-events.schema.json index 94dd7e921..22b0871bb 100644 --- a/components/datatypes/data/record-timeseries-events.schema.json +++ b/components/datatypes/data/record-timeseries-events.schema.json @@ -1,32 +1,43 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/record-timeseries-events", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Time-series Extension for Record Data", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile", "https://ns.adobe.com/xdm/data/record" ], - "description" : "Time-series extension for record data.", - "definitions" : { - "record-timeseries-events" : { - "properties" : { - "xdm:timeSeriesEvents" : { - "title" : "Time-series Events", - "description" : "List of time-series based events that relate to schemas based on record.", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/data/time-series" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/record-timeseries-events", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Time-series Extension for Record Data", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/profile", + "https://ns.adobe.com/xdm/data/record" + ], + "description": "Time-series extension for record data.", + "definitions": { + "record-timeseries-events": { + "properties": { + "xdm:timeSeriesEvents": { + "title": "Time-series Events", + "description": "List of time-series based events that relate to schemas based on record.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/data/time-series" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/record-timeseries-events" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/record-timeseries-events" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/save-for-laters.schema.json b/components/datatypes/data/save-for-laters.schema.json index 185c842eb..37d7ec8e8 100644 --- a/components/datatypes/data/save-for-laters.schema.json +++ b/components/datatypes/data/save-for-laters.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/save-for-laters", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Save For Laters", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The commerce metric `saveForLaters` describes how often a product has been saved for a later day purchase.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:saveForLaters", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/save-for-laters", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Save For Laters", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The commerce metric `saveForLaters` describes how often a product has been saved for a later day purchase.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:saveForLaters", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "commerce metric: saveForLaters", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "commerce metric: saveForLaters", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/sends.schema.json b/components/datatypes/data/sends.schema.json index 645a57175..bb0b61a0f 100644 --- a/components/datatypes/data/sends.schema.json +++ b/components/datatypes/data/sends.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Sends", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric `sends` describes the number of asynchronous messages (email, SMS, MMS etc) that have been dispatched to an recipient's account/address/device.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:sends", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/sends", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Sends", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric `sends` describes the number of asynchronous messages (email, SMS, MMS etc) that have been dispatched to an recipient's account/address/device.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:sends", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: sends", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: sends", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/unsubscriptions.schema.json b/components/datatypes/data/unsubscriptions.schema.json index 172ddf47e..53c469c39 100644 --- a/components/datatypes/data/unsubscriptions.schema.json +++ b/components/datatypes/data/unsubscriptions.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Unsubscriptions", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric `unsubscriptions` describes the number of times the recipients of direct marketing messages (email, newsletters, etc) have opted out from receiving them.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:unsubscriptions", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/unsubscriptions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Unsubscriptions", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric `unsubscriptions` describes the number of times the recipients of direct marketing messages (email, newsletters, etc) have opted out from receiving them.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:unsubscriptions", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: unsubscriptions", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: unsubscriptions", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/data/user-complaints.schema.json b/components/datatypes/data/user-complaints.schema.json index 170cf12c7..cf2af9231 100644 --- a/components/datatypes/data/user-complaints.schema.json +++ b/components/datatypes/data/user-complaints.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "User Complaints", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/data/metricdefinition" ], - "description" : "The direct-marketing metric `user-complaints` describes the number of user complaints that have been received. This generally occurs when a recipient of a message reported it as spam.", - "definitions" : { - "metricdefinition" : { - "properties" : { - "@id" : { - "type" : "string", - "const" : "xdm:userComplaints", - "description" : "The unique identifier of this metric." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/data/metrics/direct-marketing/user-complaints", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "User Complaints", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/data/metricdefinition"], + "description": "The direct-marketing metric `user-complaints` describes the number of user complaints that have been received. This generally occurs when a recipient of a message reported it as spam.", + "definitions": { + "metricdefinition": { + "properties": { + "@id": { + "type": "string", + "const": "xdm:userComplaints", + "description": "The unique identifier of this metric." }, - "schema:name" : { - "type" : "string", - "const" : "direct-marketing metric: userComplaints", - "description" : "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." + "schema:name": { + "type": "string", + "const": "direct-marketing metric: userComplaints", + "description": "The human-readable name of the metric. The name can be used in user interfaces and does not have to be unique." }, - "xdm:measurement" : { - "type" : "string", - "description" : "How to take measures of this metric.", - "const" : "count" + "xdm:measurement": { + "type": "string", + "description": "How to take measures of this metric.", + "const": "count" }, - "xdm:unit" : { - "const" : "" + "xdm:unit": { + "const": "" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/metricdefinition" - }, { - "$ref" : "https://ns.adobe.com/xdm/data/metricdefinition" - } ], - "required" : [ "@id", "schema:name", "xdm:measurement", "xdm:unit" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/metricdefinition" + }, + { + "$ref": "https://ns.adobe.com/xdm/data/metricdefinition" + } + ], + "required": ["@id", "schema:name", "xdm:measurement", "xdm:unit"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/demographic/address.schema.json b/components/datatypes/demographic/address.schema.json index f5f3d2eb7..79652673a 100644 --- a/components/datatypes/demographic/address.schema.json +++ b/components/datatypes/demographic/address.schema.json @@ -1,102 +1,115 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/address", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Postal address", - "type" : "object", - "meta:auditable" : true, - "meta:extends" : [ "http://schema.org/GeoCoordinates", "https://ns.adobe.com/xdm/common/geo" ], - "description" : "A postal address. Address could relate to a person's home, work, or preferred store location.", - "definitions" : { - "address" : { - "properties" : { - "xdm:primary" : { - "title" : "Primary", - "type" : "boolean", - "description" : "Primary address indicator. A profile can have only one `primary` address at a given point of time." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/address", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Postal address", + "type": "object", + "meta:auditable": true, + "meta:extends": [ + "http://schema.org/GeoCoordinates", + "https://ns.adobe.com/xdm/common/geo" + ], + "description": "A postal address. Address could relate to a person's home, work, or preferred store location.", + "definitions": { + "address": { + "properties": { + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "description": "Primary address indicator. A profile can have only one `primary` address at a given point of time." }, - "xdm:label" : { - "title" : "Label", - "type" : "string", - "description" : "Free form name of the address." + "xdm:label": { + "title": "Label", + "type": "string", + "description": "Free form name of the address." }, - "xdm:street1" : { - "title" : "Street 1", - "type" : "string", - "description" : "Primary street level information, apartment number, street number, and street name." + "xdm:street1": { + "title": "Street 1", + "type": "string", + "description": "Primary street level information, apartment number, street number, and street name." }, - "xdm:street2" : { - "title" : "Street 2", - "type" : "string", - "description" : "Optional street information second line." + "xdm:street2": { + "title": "Street 2", + "type": "string", + "description": "Optional street information second line." }, - "xdm:street3" : { - "title" : "Street 3", - "type" : "string", - "description" : "Optional street information third line." + "xdm:street3": { + "title": "Street 3", + "type": "string", + "description": "Optional street information third line." }, - "xdm:street4" : { - "title" : "Street 4", - "type" : "string", - "description" : "Optional street information fourth line." + "xdm:street4": { + "title": "Street 4", + "type": "string", + "description": "Optional street information fourth line." }, - "xdm:region" : { - "title" : "Region", - "type" : "string", - "description" : "The region, county, or district portion of the address." + "xdm:region": { + "title": "Region", + "type": "string", + "description": "The region, county, or district portion of the address." }, - "xdm:postOfficeBox" : { - "title" : "Post office box", - "type" : "string", - "description" : "Post office box of the address.", - "maxLength" : 20 + "xdm:postOfficeBox": { + "title": "Post office box", + "type": "string", + "description": "Post office box of the address.", + "maxLength": 20 }, - "xdm:country" : { - "title" : "Country", - "type" : "string", - "description" : "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language." + "xdm:country": { + "title": "Country", + "type": "string", + "description": "The name of the government-administered territory. Other than `xdm:countryCode`, this is a free-form field that can have the country name in any language." }, - "xdm:state" : { - "title" : "State", - "type" : "string", - "description" : "The name of the State. This is a free-form field." + "xdm:state": { + "title": "State", + "type": "string", + "description": "The name of the State. This is a free-form field." }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "description" : "An indication as to the ability to use the address.", - "default" : "active", - "meta:enum" : { - "active" : "Active", - "incomplete" : "Incomplete", - "pending_verification" : "Pending verification", - "blacklisted" : "Blacklisted", - "blocked" : "Blocked" + "xdm:status": { + "title": "Status", + "type": "string", + "description": "An indication as to the ability to use the address.", + "default": "active", + "meta:enum": { + "active": "Active", + "incomplete": "Incomplete", + "pending_verification": "Pending verification", + "blacklisted": "Blacklisted", + "blocked": "Blocked" } }, - "xdm:statusReason" : { - "title" : "Status reason", - "type" : "string", - "description" : "A description of the current status." + "xdm:statusReason": { + "title": "Status reason", + "type": "string", + "description": "A description of the current status." }, - "xdm:lastVerifiedDate" : { - "title" : "Last verified date", - "type" : "string", - "format" : "date", - "description" : "The date that the address was last verified as still associated to the person." + "xdm:lastVerifiedDate": { + "title": "Last verified date", + "type": "string", + "format": "date", + "description": "The date that the address was last verified as still associated to the person." } } } }, - "allOf" : [ { - "$ref" : "http://schema.org/GeoCoordinates" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/geo" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/auditable" - }, { - "$ref" : "#/definitions/address" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "http://schema.org/GeoCoordinates" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/geo" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + }, + { + "$ref": "#/definitions/address" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/demographic/emailaddress.schema.json b/components/datatypes/demographic/emailaddress.schema.json index c23fe0d3f..eccff3803 100644 --- a/components/datatypes/demographic/emailaddress.schema.json +++ b/components/datatypes/demographic/emailaddress.schema.json @@ -1,67 +1,75 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/emailaddress", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Email address", - "type" : "object", - "meta:extensible" : true, - "description" : "A standard email address.", - "definitions" : { - "emailaddress" : { - "properties" : { - "xdm:primary" : { - "title" : "Primary", - "type" : "boolean", - "description" : "Primary email indicator. A profile can have only one `primary` email address at a given point of time." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/emailaddress", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Email address", + "type": "object", + "meta:extensible": true, + "description": "A standard email address.", + "definitions": { + "emailaddress": { + "properties": { + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "description": "Primary email indicator. A profile can have only one `primary` email address at a given point of time." }, - "xdm:address" : { - "title" : "Address", - "type" : "string", - "format" : "email", - "description" : "The technical address, for example, 'name@domain.com' as commonly defined in RFC2822 and subsequent standards." + "xdm:address": { + "title": "Address", + "type": "string", + "format": "email", + "description": "The technical address, for example, 'name@domain.com' as commonly defined in RFC2822 and subsequent standards." }, - "xdm:label" : { - "title" : "Label", - "type" : "string", - "description" : "Additional display information that maybe available, for example, Microsoft Outlook rich address controls display 'John Smith smithjr@company.uk', 'John Smith' part is data that would be placed in the label." + "xdm:label": { + "title": "Label", + "type": "string", + "description": "Additional display information that maybe available, for example, Microsoft Outlook rich address controls display 'John Smith smithjr@company.uk', 'John Smith' part is data that would be placed in the label." }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "The way the account relates to the person for example 'work' or 'personal'.", - "meta:enum" : { - "unknown" : "Unknown", - "personal" : "Personal", - "work" : "Work", - "education" : "Education" + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The way the account relates to the person for example 'work' or 'personal'.", + "meta:enum": { + "unknown": "Unknown", + "personal": "Personal", + "work": "Work", + "education": "Education" } }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "description" : "An indication as to the ability to use the email address.", - "default" : "active", - "meta:enum" : { - "active" : "Active", - "incomplete" : "Incomplete", - "pending_verification" : "Pending verification", - "blacklisted" : "Blacklisted", - "blocked" : "Blocked" + "xdm:status": { + "title": "Status", + "type": "string", + "description": "An indication as to the ability to use the email address.", + "default": "active", + "meta:enum": { + "active": "Active", + "incomplete": "Incomplete", + "pending_verification": "Pending verification", + "blacklisted": "Blacklisted", + "blocked": "Blocked" } }, - "xdm:statusReason" : { - "title" : "Status reason", - "type" : "string", - "description" : "A description of the current status." + "xdm:statusReason": { + "title": "Status reason", + "type": "string", + "description": "A description of the current status." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/emailaddress" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/emailaddress" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/demographic/geo.schema.json b/components/datatypes/demographic/geo.schema.json index 776718c90..e003b4d25 100644 --- a/components/datatypes/demographic/geo.schema.json +++ b/components/datatypes/demographic/geo.schema.json @@ -1,56 +1,64 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/geo", - "$schema" : "http://json-schema.org/draft-06/schema#", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "http://schema.org/GeoCoordinates" ], - "title" : "Geo", - "description" : "The geographic related data where an event was observed.", - "definitions" : { - "geo" : { - "properties" : { - "xdm:countryCode" : { - "title" : "Country code", - "type" : "string", - "pattern" : "^[A-Z]{2}$", - "description" : "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/geo", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "meta:extends": ["http://schema.org/GeoCoordinates"], + "title": "Geo", + "description": "The geographic related data where an event was observed.", + "definitions": { + "geo": { + "properties": { + "xdm:countryCode": { + "title": "Country code", + "type": "string", + "pattern": "^[A-Z]{2}$", + "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country." }, - "xdm:stateProvince" : { - "title" : "State or province", - "type" : "string", - "description" : "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.", - "examples" : [ "US-CA", "DE-BB", "JP-13" ], - "pattern" : "([A-Z]{2}-[A-Z0-9]{1,3}|)" + "xdm:stateProvince": { + "title": "State or province", + "type": "string", + "description": "The state, or province portion of the observation. The format follows the [ISO 3166-2 (country and subdivision)][http://www.unece.org/cefact/locode/subdivisions.html] standard.", + "examples": ["US-CA", "DE-BB", "JP-13"], + "pattern": "([A-Z]{2}-[A-Z0-9]{1,3}|)" }, - "xdm:city" : { - "title" : "City", - "type" : "string", - "description" : "The name of the city." + "xdm:city": { + "title": "City", + "type": "string", + "description": "The name of the city." }, - "xdm:postalCode" : { - "title" : "Postal code", - "type" : "string", - "description" : "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code." + "xdm:postalCode": { + "title": "Postal code", + "type": "string", + "description": "The postal code of the location. Postal codes are not available for all countries. In some countries, this will only contain part of the postal code." }, - "xdm:dmaID" : { - "title" : "Designated market area", - "type" : "integer", - "description" : "The Nielsen media research designated market area." + "xdm:dmaID": { + "title": "Designated market area", + "type": "integer", + "description": "The Nielsen media research designated market area." }, - "xdm:msaID" : { - "title" : "Metropolitan statistical area", - "type" : "integer", - "description" : "The metropolitan statistical area in the United States where the observation occurred." + "xdm:msaID": { + "title": "Metropolitan statistical area", + "type": "integer", + "description": "The metropolitan statistical area in the United States where the observation occurred." } } } }, - "allOf" : [ { - "$ref" : "http://schema.org/GeoCoordinates" - }, { - "$ref" : "#/definitions/geo" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "http://schema.org/GeoCoordinates" + }, + { + "$ref": "#/definitions/geo" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/demographic/geounit.schema.json b/components/datatypes/demographic/geounit.schema.json index 361bd1342..c18e84008 100644 --- a/components/datatypes/demographic/geounit.schema.json +++ b/components/datatypes/demographic/geounit.schema.json @@ -1,32 +1,39 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/geounit", - "$schema" : "http://json-schema.org/draft-06/schema#", - "type" : "object", - "meta:extensible" : true, - "title" : "Geographical unit", - "description" : "The geographical unit of a parent geographical unit.", - "definitions" : { - "geounit" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "The ID associated with this geographical unit." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/geounit", + "$schema": "http://json-schema.org/draft-06/schema#", + "type": "object", + "meta:extensible": true, + "title": "Geographical unit", + "description": "The geographical unit of a parent geographical unit.", + "definitions": { + "geounit": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The ID associated with this geographical unit." }, - "xdm:label" : { - "title" : "Label of the geographical unit.", - "type" : "string", - "description" : "The user-friendly name for the geographical unit." + "xdm:label": { + "title": "Label of the geographical unit.", + "type": "string", + "description": "The user-friendly name for the geographical unit." } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "#/definitions/geounit" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/geounit" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/demographic/phonenumber.schema.json b/components/datatypes/demographic/phonenumber.schema.json index efdda7548..ba327b661 100644 --- a/components/datatypes/demographic/phonenumber.schema.json +++ b/components/datatypes/demographic/phonenumber.schema.json @@ -1,65 +1,73 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/phonenumber", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Phone number", - "type" : "object", - "meta:extensible" : true, - "description" : "Information that enables the contact of a person with a phone. Typically an alphanumeric number, 1-222-333-4444 in North America, but can have a wide range of formats.", - "definitions" : { - "phonenumber" : { - "properties" : { - "xdm:primary" : { - "title" : "Primary", - "type" : "boolean", - "description" : "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/phonenumber", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Phone number", + "type": "object", + "meta:extensible": true, + "description": "Information that enables the contact of a person with a phone. Typically an alphanumeric number, 1-222-333-4444 in North America, but can have a wide range of formats.", + "definitions": { + "phonenumber": { + "properties": { + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "description": "Primary phone number indicator. Unlike address or email address, there can be multiple primary phone numbers; one per communication channel. The communication channel is defined by the type: `textMessaging`, `mobile`, `phone`, `home`, `work`, `unknown`, and `fax`." }, - "xdm:number" : { - "title" : "Number", - "type" : "string", - "description" : "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." + "xdm:number": { + "title": "Number", + "type": "string", + "description": "The phone number. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." }, - "xdm:extension" : { - "title" : "Extension", - "type" : "string", - "description" : "The internal dialing number used to call from a private exchange, operator, or switchboard." + "xdm:extension": { + "title": "Extension", + "type": "string", + "description": "The internal dialing number used to call from a private exchange, operator, or switchboard." }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "description" : "An indication as to the ability to use the phone number.", - "default" : "active", - "meta:enum" : { - "active" : "Active", - "incomplete" : "Incomplete", - "blacklisted" : "Blacklisted", - "blocked" : "Blocked" + "xdm:status": { + "title": "Status", + "type": "string", + "description": "An indication as to the ability to use the phone number.", + "default": "active", + "meta:enum": { + "active": "Active", + "incomplete": "Incomplete", + "blacklisted": "Blacklisted", + "blocked": "Blocked" } }, - "xdm:statusReason" : { - "title" : "Status reason", - "type" : "string", - "description" : "A description of the current status." + "xdm:statusReason": { + "title": "Status reason", + "type": "string", + "description": "A description of the current status." }, - "xdm:validity" : { - "title" : "Validity", - "type" : "string", - "description" : "A level of technical correctness of the phone number.", - "meta:enum" : { - "consistent" : "Consistent", - "inconsistent" : "Inconsistent", - "incomplete" : "Incomplete", - "successfullyUsed" : "Successfully used" + "xdm:validity": { + "title": "Validity", + "type": "string", + "description": "A level of technical correctness of the phone number.", + "meta:enum": { + "consistent": "Consistent", + "inconsistent": "Inconsistent", + "incomplete": "Incomplete", + "successfullyUsed": "Successfully used" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/phonenumber" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/phonenumber" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/demographic/place.schema.json b/components/datatypes/demographic/place.schema.json index ffe53fb68..fa72731de 100644 --- a/components/datatypes/demographic/place.schema.json +++ b/components/datatypes/demographic/place.schema.json @@ -1,75 +1,83 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/place", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Physical place", - "type" : "object", - "meta:extensible" : true, - "description" : "A place in the real world with a physical location.", - "definitions" : { - "physicallocation" : { - "properties" : { - "@id" : { - "title" : "Place ID", - "type" : "string", - "format" : "uri-reference", - "description" : "The unique identifier of the place." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/place", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Physical place", + "type": "object", + "meta:extensible": true, + "description": "A place in the real world with a physical location.", + "definitions": { + "physicallocation": { + "properties": { + "@id": { + "title": "Place ID", + "type": "string", + "format": "uri-reference", + "description": "The unique identifier of the place." }, - "schema:description" : { - "title" : "Description", - "type" : "string", - "description" : "The description of the physical location." + "schema:description": { + "title": "Description", + "type": "string", + "description": "The description of the physical location." }, - "xdm:address" : { - "title" : "Address", - "$ref" : "https://ns.adobe.com/xdm/common/address", - "description" : "The physical address of the location." + "xdm:address": { + "title": "Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "The physical address of the location." }, - "schema:telephone" : { - "title" : "Phone number", - "type" : "string", - "description" : "The phone number." + "schema:telephone": { + "title": "Phone number", + "type": "string", + "description": "The phone number." }, - "schema:branchCode" : { - "title" : "Location code", - "type" : "string", - "description" : "A short textual code also called \"store code\" that uniquely identifies a place of business. The code is typically assigned by the parent organization and used in structured URLs. For example, in the URL `http://www.starbucks.co.uk/store-locator/etc/detail/3047` the code \"3047\" is a `branchCode` for a particular branch." + "schema:branchCode": { + "title": "Location code", + "type": "string", + "description": "A short textual code also called \"store code\" that uniquely identifies a place of business. The code is typically assigned by the parent organization and used in structured URLs. For example, in the URL `http://www.starbucks.co.uk/store-locator/etc/detail/3047` the code \"3047\" is a `branchCode` for a particular branch." }, - "xdm:shape" : { - "title" : "Geo shape", - "$ref" : "http://schema.org/GeoShape", - "description" : "The geographic shape of the physical location." + "xdm:shape": { + "title": "Geo shape", + "$ref": "http://schema.org/GeoShape", + "description": "The geographic shape of the physical location." }, - "xdm:pointOfInterest" : { - "title" : "Point of interest", - "$ref" : "http://schema.org/GeoCoordinates", - "description" : "The coordinates of the point of interest for this location." + "xdm:pointOfInterest": { + "title": "Point of interest", + "$ref": "http://schema.org/GeoCoordinates", + "description": "The coordinates of the point of interest for this location." }, - "xdm:containedInPlace" : { - "title" : "Contained by location", - "type" : "string", - "format" : "uri", - "description" : "XDM URI of another `Place` that this place is contained in. This property is based on `schema:containedInPlace`, but is using URI references instead of embedding the containing place." + "xdm:containedInPlace": { + "title": "Contained by location", + "type": "string", + "format": "uri", + "description": "XDM URI of another `Place` that this place is contained in. This property is based on `schema:containedInPlace`, but is using URI references instead of embedding the containing place." }, - "xdm:containsPlaces" : { - "title" : "Contains locations", - "type" : "array", - "items" : { - "type" : "string", - "format" : "uri", - "description" : "The XDM URI of another `Place` that this place contains." + "xdm:containsPlaces": { + "title": "Contains locations", + "type": "array", + "items": { + "type": "string", + "format": "uri", + "description": "The XDM URI of another `Place` that this place contains." }, - "description" : "An array of XDM URIs of other `Place` instances that this place is containing. This property is based on `schema:containsPlace`, but is using URI references instead of embedding the containing place. In addition, it is an array, allowing one place to include multiple other places." + "description": "An array of XDM URIs of other `Place` instances that this place is containing. This property is based on `schema:containsPlace`, but is using URI references instead of embedding the containing place. In addition, it is an array, allowing one place to include multiple other places." } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/physicallocation" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/physicallocation" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/deprecated-consentpreferences.schema.json b/components/datatypes/deprecated-consentpreferences.schema.json index b0b937242..3f84acedc 100644 --- a/components/datatypes/deprecated-consentpreferences.schema.json +++ b/components/datatypes/deprecated-consentpreferences.schema.json @@ -1,397 +1,432 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/consent-preferences", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Privacy/Marketing Preferences (Consent)", - "description" : "This schema captures privacy, personalization and marketing preferences (consents).", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "definitions" : { - "choice-value" : { - "title" : "Choice Value", - "description" : "The value specified by the user as their preference", - "type" : "string", - "enum" : [ "yes", "no", "pending", "unknown", "not_applicable" ], - "meta:enum" : { - "yes" : "Yes", - "no" : "No", - "pending" : "Pending verification", - "unknown" : "Unknown", - "not_applicable" : "Not Applicable" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/consent-preferences", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Privacy/Marketing Preferences (Consent)", + "description": "This schema captures privacy, personalization and marketing preferences (consents).", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "definitions": { + "choice-value": { + "title": "Choice Value", + "description": "The value specified by the user as their preference", + "type": "string", + "enum": ["yes", "no", "pending", "unknown", "not_applicable"], + "meta:enum": { + "yes": "Yes", + "no": "No", + "pending": "Pending verification", + "unknown": "Unknown", + "not_applicable": "Not Applicable" } }, - "basis-of-processing" : { - "title" : "Basis Of Processing", - "type" : "string", - "description" : "Legal basis for collecting/processing data: is user consent required?", - "enum" : [ "consent", "legitimate_interest", "contract", "compliance", "vital_interest", "public_interest" ], - "meta:enum" : { - "consent" : "User Consent", - "legitimate_interest" : "Legitimate Interest", - "contract" : "Contract", - "compliance" : "Compliance with a Legal Obligation", - "vital_interest" : "Vital Interest of the Individual", - "public_interest" : "Public Interest" + "basis-of-processing": { + "title": "Basis Of Processing", + "type": "string", + "description": "Legal basis for collecting/processing data: is user consent required?", + "enum": [ + "consent", + "legitimate_interest", + "contract", + "compliance", + "vital_interest", + "public_interest" + ], + "meta:enum": { + "consent": "User Consent", + "legitimate_interest": "Legitimate Interest", + "contract": "Contract", + "compliance": "Compliance with a Legal Obligation", + "vital_interest": "Vital Interest of the Individual", + "public_interest": "Public Interest" } }, - "timestamp" : { - "title" : "Preference timestamp", - "description" : "Time this specific preference was collected.", - "type" : "string", - "format" : "date-time" + "timestamp": { + "title": "Preference timestamp", + "description": "Time this specific preference was collected.", + "type": "string", + "format": "date-time" }, - "source" : { - "title" : "Preference Source", - "description" : "Through which interface did the user provide this preference value", - "type" : "string", - "maxLength" : 20 + "source": { + "title": "Preference Source", + "description": "Through which interface did the user provide this preference value", + "type": "string", + "maxLength": 20 }, - "consent-fields" : { - "type" : "object", - "properties" : { - "xdm:choice" : { - "description" : "The value specified by the user as their consent choice", - "$ref" : "#/definitions/choice-value" + "consent-fields": { + "type": "object", + "properties": { + "xdm:choice": { + "description": "The value specified by the user as their consent choice", + "$ref": "#/definitions/choice-value" }, - "xdm:basisOfProcessing" : { - "$ref" : "#/definitions/basis-of-processing" + "xdm:basisOfProcessing": { + "$ref": "#/definitions/basis-of-processing" }, - "xdm:timestamp" : { - "title" : "Consent timestamp", - "description" : "Time this specific consent was collected.", - "$ref" : "#/definitions/timestamp" + "xdm:timestamp": { + "title": "Consent timestamp", + "description": "Time this specific consent was collected.", + "$ref": "#/definitions/timestamp" }, - "xdm:source" : { - "title" : "Consent Source", - "description" : "Through which interface did the user provide this consent value", - "$ref" : "#/definitions/source" + "xdm:source": { + "title": "Consent Source", + "description": "Through which interface did the user provide this consent value", + "$ref": "#/definitions/source" } } }, - "personalization-fields" : { - "type" : "object", - "properties" : { - "xdm:choice" : { - "$ref" : "#/definitions/choice-value" + "personalization-fields": { + "type": "object", + "properties": { + "xdm:choice": { + "$ref": "#/definitions/choice-value" }, - "xdm:basisOfProcessing" : { - "$ref" : "#/definitions/basis-of-processing" + "xdm:basisOfProcessing": { + "$ref": "#/definitions/basis-of-processing" }, - "xdm:timestamp" : { - "$ref" : "#/definitions/timestamp" + "xdm:timestamp": { + "$ref": "#/definitions/timestamp" }, - "xdm:source" : { - "$ref" : "#/definitions/source" + "xdm:source": { + "$ref": "#/definitions/source" } } }, - "marketing-fields" : { - "type" : "object", - "properties" : { - "xdm:choice" : { - "$ref" : "#/definitions/choice-value" + "marketing-fields": { + "type": "object", + "properties": { + "xdm:choice": { + "$ref": "#/definitions/choice-value" }, - "xdm:basisOfProcessing" : { - "$ref" : "#/definitions/basis-of-processing" + "xdm:basisOfProcessing": { + "$ref": "#/definitions/basis-of-processing" }, - "xdm:timestamp" : { - "$ref" : "#/definitions/timestamp" + "xdm:timestamp": { + "$ref": "#/definitions/timestamp" }, - "xdm:source" : { - "$ref" : "#/definitions/source" + "xdm:source": { + "$ref": "#/definitions/source" }, - "xdm:reason" : { - "title" : "Opt out reason", - "type" : "string", - "description" : "Reason for opting out", - "maxLength" : 20 + "xdm:reason": { + "title": "Opt out reason", + "type": "string", + "description": "Reason for opting out", + "maxLength": 20 } } }, - "choices" : { - "properties" : { - "xdm:consents" : { - "title" : "Consents", - "description" : "Encapsulates user consents.", - "type" : "object", - "properties" : { - "xdm:dataCollection" : { - "title" : "Data Collection", - "description" : "Data collection is permitted", - "$ref" : "#/definitions/consent-fields" - }, - "xdm:sellData" : { - "title" : "Sell Data", - "description" : "Selling of user's Data to 2nd or 3rd parties is permitted", - "$ref" : "#/definitions/consent-fields" - }, - "xdm:shareData" : { - "title" : "Share Data", - "description" : "Sharing of user's Data with 2nd or 3rd parties is permitted", - "$ref" : "#/definitions/consent-fields" - }, - "xdm:pseudonymousAnalysis" : { - "title" : "Pseudonymous Analysis", - "description" : "Data can be used for analysis that may include an ID that may or may not be tied to an actual person", - "$ref" : "#/definitions/consent-fields" - }, - "xdm:deviceLinking" : { - "title" : "Device Linking", - "description" : "Attempts to link multiple devices belonging to an individual or household are permitted", - "$ref" : "#/definitions/consent-fields" + "choices": { + "properties": { + "xdm:consents": { + "title": "Consents", + "description": "Encapsulates user consents.", + "type": "object", + "properties": { + "xdm:dataCollection": { + "title": "Data Collection", + "description": "Data collection is permitted", + "$ref": "#/definitions/consent-fields" + }, + "xdm:sellData": { + "title": "Sell Data", + "description": "Selling of user's Data to 2nd or 3rd parties is permitted", + "$ref": "#/definitions/consent-fields" + }, + "xdm:shareData": { + "title": "Share Data", + "description": "Sharing of user's Data with 2nd or 3rd parties is permitted", + "$ref": "#/definitions/consent-fields" + }, + "xdm:pseudonymousAnalysis": { + "title": "Pseudonymous Analysis", + "description": "Data can be used for analysis that may include an ID that may or may not be tied to an actual person", + "$ref": "#/definitions/consent-fields" + }, + "xdm:deviceLinking": { + "title": "Device Linking", + "description": "Attempts to link multiple devices belonging to an individual or household are permitted", + "$ref": "#/definitions/consent-fields" } } }, - "xdm:personalizationPreferences" : { - "title" : "Personalization Preferences", - "description" : "User's Personalization Preferences", - "type" : "object", - "properties" : { - "xdm:anyPersonalization" : { - "title" : "General Personalization Preference", - "description" : "Is permission granted to perform any type of personalization", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:email" : { - "title" : "Personalize email", - "description" : "Allow personalization of emails sent to the user", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:physicalMail" : { - "title" : "Personalize physical mail", - "description" : "Allow personalization of offers sent via traditional/physical mail", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:pushNotifications" : { - "title" : "Personalize push notifications", - "description" : "Personalization of push notifications is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:sms" : { - "title" : "Personalize SMS", - "description" : "Personalization of text messages is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:phoneCalls" : { - "title" : "Personalize phone calls", - "description" : "Allow phone calls that the brand initiates to be personalized based on the user's interests or behavior", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:iotDevices" : { - "title" : "Personalize IoT Devices", - "description" : "Personalization of interactions with IoT devices is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:socialMedia" : { - "title" : "Personalize Social Media", - "description" : "Personalization of interactions on Social Media sites/apps is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:inAppMessages" : { - "title" : "Personalize in-app messages", - "description" : "Allow personalization of messages displayed within my apps", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:inVehicle" : { - "title" : "Personalize in-vehicle", - "description" : "Personalization of in-vehicle experiences is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:inHome" : { - "title" : "Personalize in-home", - "description" : "Personalization of in-home experiences is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:inStore" : { - "title" : "Personalize in-store", - "description" : "Personalization of in-store experiences is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:content" : { - "title" : "Personalize content", - "description" : "Allow personalization of the content on my site or in my apps", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:offers" : { - "title" : "Personalize Offers", - "description" : "Allow personalization of 1st-party offers displayed on this site or with this app", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:customerSupport" : { - "title" : "Personalize customer support", - "description" : "Allow customer support to personalize responses/suggestions based on user's interests or behavior", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:thirdPartyOffers" : { - "title" : "Personalize ", - "description" : "Personalization of third-party offers/ads displayed on this brand's sites or apps is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:thirdPartyContent" : { - "title" : "Personalize ", - "description" : "Personalization of third-party content displayed on this brand's sites or apps is permitted", - "$ref" : "#/definitions/personalization-fields" - }, - "xdm:advertising" : { - "title" : "Personalize Ads", - "description" : "Personalization of this brand's ads on third-party sites/apps is permitted", - "$ref" : "#/definitions/personalization-fields" + "xdm:personalizationPreferences": { + "title": "Personalization Preferences", + "description": "User's Personalization Preferences", + "type": "object", + "properties": { + "xdm:anyPersonalization": { + "title": "General Personalization Preference", + "description": "Is permission granted to perform any type of personalization", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:email": { + "title": "Personalize email", + "description": "Allow personalization of emails sent to the user", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:physicalMail": { + "title": "Personalize physical mail", + "description": "Allow personalization of offers sent via traditional/physical mail", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:pushNotifications": { + "title": "Personalize push notifications", + "description": "Personalization of push notifications is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:sms": { + "title": "Personalize SMS", + "description": "Personalization of text messages is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:phoneCalls": { + "title": "Personalize phone calls", + "description": "Allow phone calls that the brand initiates to be personalized based on the user's interests or behavior", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:iotDevices": { + "title": "Personalize IoT Devices", + "description": "Personalization of interactions with IoT devices is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:socialMedia": { + "title": "Personalize Social Media", + "description": "Personalization of interactions on Social Media sites/apps is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:inAppMessages": { + "title": "Personalize in-app messages", + "description": "Allow personalization of messages displayed within my apps", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:inVehicle": { + "title": "Personalize in-vehicle", + "description": "Personalization of in-vehicle experiences is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:inHome": { + "title": "Personalize in-home", + "description": "Personalization of in-home experiences is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:inStore": { + "title": "Personalize in-store", + "description": "Personalization of in-store experiences is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:content": { + "title": "Personalize content", + "description": "Allow personalization of the content on my site or in my apps", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:offers": { + "title": "Personalize Offers", + "description": "Allow personalization of 1st-party offers displayed on this site or with this app", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:customerSupport": { + "title": "Personalize customer support", + "description": "Allow customer support to personalize responses/suggestions based on user's interests or behavior", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:thirdPartyOffers": { + "title": "Personalize ", + "description": "Personalization of third-party offers/ads displayed on this brand's sites or apps is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:thirdPartyContent": { + "title": "Personalize ", + "description": "Personalization of third-party content displayed on this brand's sites or apps is permitted", + "$ref": "#/definitions/personalization-fields" + }, + "xdm:advertising": { + "title": "Personalize Ads", + "description": "Personalization of this brand's ads on third-party sites/apps is permitted", + "$ref": "#/definitions/personalization-fields" } } }, - "xdm:marketingPreferences" : { - "title" : "Marketing Preferences", - "description" : "User's Direct Marketing Preferences", - "type" : "object", - "properties" : { - "xdm:preferredChannel" : { - "title" : "Preferred Channel", - "description" : "User's preferred channel for receiving communications", - "type" : "string", - "enum" : [ "email", "push_notifications", "in_app_messages", "sms", "phone_calls", "physical_mail", "inVehicle_messages", "in_home_messages", "iot_messages", "social_media", "other", "none", "unknown" ], - "meta:enum" : { - "email" : "email", - "push_notifications" : "Push Notifications", - "in_app_messages" : "In-app Messages", - "sms" : "SMS (Text Messages)", - "phone_calls" : "Phone Calls", - "physical_mail" : "Physical Mail", - "inVehicle_messages" : "In-vehicle Messages", - "in_home_messages" : "In-home Messages", - "iot" : "IoT Messages", - "social_media" : "Social Media", - "other" : "Other", - "no_preferred" : "No Preferred Channel", - "unknown" : "Unknown" + "xdm:marketingPreferences": { + "title": "Marketing Preferences", + "description": "User's Direct Marketing Preferences", + "type": "object", + "properties": { + "xdm:preferredChannel": { + "title": "Preferred Channel", + "description": "User's preferred channel for receiving communications", + "type": "string", + "enum": [ + "email", + "push_notifications", + "in_app_messages", + "sms", + "phone_calls", + "physical_mail", + "inVehicle_messages", + "in_home_messages", + "iot_messages", + "social_media", + "other", + "none", + "unknown" + ], + "meta:enum": { + "email": "email", + "push_notifications": "Push Notifications", + "in_app_messages": "In-app Messages", + "sms": "SMS (Text Messages)", + "phone_calls": "Phone Calls", + "physical_mail": "Physical Mail", + "inVehicle_messages": "In-vehicle Messages", + "in_home_messages": "In-home Messages", + "iot": "IoT Messages", + "social_media": "Social Media", + "other": "Other", + "no_preferred": "No Preferred Channel", + "unknown": "Unknown" } }, - "xdm:anyMarketing" : { - "title" : "General Direct Marketing Preference", - "description" : "Does user permit any type of direct marketing", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:email" : { - "title" : "Receive email", - "description" : "User agrees to receive email", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:physicalMail" : { - "title" : "Receive physical mail", - "description" : "User agrees to being contacted via traditional/physical mail.", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:pushNotifications" : { - "title" : "Receive push notifications", - "description" : "User permits receiving push notifications", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:sms" : { - "title" : "Receive SMS", - "description" : "User agrees to receive text messages", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:phoneCalls" : { - "title" : "Receive phone calls", - "description" : "The brand may contact the user via phone", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:iotMessages" : { - "title" : "Receive IoT messages", - "description" : "It is okay to interact with the user via IoT devices", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:socialMedia" : { - "title" : "Receive Social Media Messages", - "description" : "It is okay to send messages to the user on their social media accounts", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:inAppMessages" : { - "title" : "Receive in-app messages", - "description" : "User permits messages to be shown within the brands's apps", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:inVehicleMessages" : { - "title" : "Receive in-vehicle messages", - "description" : "It is okay to interact with the user via technology installed in the user's vehicle", - "$ref" : "#/definitions/marketing-fields" - }, - "xdm:inHomeMessages" : { - "title" : "Receive in-home messages", - "description" : "It is okay to interact with the user via technology installed in the user's home", - "$ref" : "#/definitions/marketing-fields" + "xdm:anyMarketing": { + "title": "General Direct Marketing Preference", + "description": "Does user permit any type of direct marketing", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:email": { + "title": "Receive email", + "description": "User agrees to receive email", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:physicalMail": { + "title": "Receive physical mail", + "description": "User agrees to being contacted via traditional/physical mail.", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:pushNotifications": { + "title": "Receive push notifications", + "description": "User permits receiving push notifications", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:sms": { + "title": "Receive SMS", + "description": "User agrees to receive text messages", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:phoneCalls": { + "title": "Receive phone calls", + "description": "The brand may contact the user via phone", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:iotMessages": { + "title": "Receive IoT messages", + "description": "It is okay to interact with the user via IoT devices", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:socialMedia": { + "title": "Receive Social Media Messages", + "description": "It is okay to send messages to the user on their social media accounts", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:inAppMessages": { + "title": "Receive in-app messages", + "description": "User permits messages to be shown within the brands's apps", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:inVehicleMessages": { + "title": "Receive in-vehicle messages", + "description": "It is okay to interact with the user via technology installed in the user's vehicle", + "$ref": "#/definitions/marketing-fields" + }, + "xdm:inHomeMessages": { + "title": "Receive in-home messages", + "description": "It is okay to interact with the user via technology installed in the user's home", + "$ref": "#/definitions/marketing-fields" } } } } }, - "metadata" : { - "properties" : { - "xdm:version" : { - "title" : "Consent Schema Version", - "description" : "Version of the Consents and Preferences Schema", - "type" : "string", - "pattern" : "^[0-9]{1,2}\\.[0-9]{1,2}\\.[0-9]{1,4}$", - "default" : "1.0.0" + "metadata": { + "properties": { + "xdm:version": { + "title": "Consent Schema Version", + "description": "Version of the Consents and Preferences Schema", + "type": "string", + "pattern": "^[0-9]{1,2}\\.[0-9]{1,2}\\.[0-9]{1,4}$", + "default": "1.0.0" }, - "xdm:timestamp" : { - "title" : "Consent/Preferences timestamp", - "description" : "Timestamp of this complete set of user consents and preferences", - "type" : "string", - "format" : "date-time" + "xdm:timestamp": { + "title": "Consent/Preferences timestamp", + "description": "Timestamp of this complete set of user consents and preferences", + "type": "string", + "format": "date-time" }, - "xdm:source" : { - "title" : "Consent/Preferences source", - "description" : "Through which interface did the user provide their choices for this complete set of user consents and preferences", - "$ref" : "#/definitions/source" + "xdm:source": { + "title": "Consent/Preferences source", + "description": "Through which interface did the user provide their choices for this complete set of user consents and preferences", + "$ref": "#/definitions/source" }, - "xdm:userIDfromSource" : { - "title" : "Source's ID for the user", - "description" : "Source's ID for the user", - "type" : "string", - "maxLength" : 20 + "xdm:userIDfromSource": { + "title": "Source's ID for the user", + "description": "Source's ID for the user", + "type": "string", + "maxLength": 20 }, - "xdm:userCountryRegionCode" : { - "title" : "User Country (and optionally Region) Code", - "description" : "ISO 3166 alpha2 country code or ISO 3166-2 country plus state/province code for use in helping to determine how to interpret consent values", - "type" : "string", - "maxLength" : 6, - "pattern" : "^[A-Z]{2}(-[A-Z0-9]{1,3}){0,1}$" + "xdm:userCountryRegionCode": { + "title": "User Country (and optionally Region) Code", + "description": "ISO 3166 alpha2 country code or ISO 3166-2 country plus state/province code for use in helping to determine how to interpret consent values", + "type": "string", + "maxLength": 6, + "pattern": "^[A-Z]{2}(-[A-Z0-9]{1,3}){0,1}$" }, - "xdm:countryRegionSource" : { - "title" : "Country/Region Source", - "description" : "Method used to determine the user's country/region", - "type" : "string", - "enum" : [ "ip", "gps", "user_provided", "website_location", "inferred", "other" ], - "meta:enum" : { - "ip" : "IP Address", - "gps" : "Device GPS", - "user_provided" : "User Provided", - "website_location" : "Website location or eTLD", - "inferred" : "Inferred", - "other" : "Other" + "xdm:countryRegionSource": { + "title": "Country/Region Source", + "description": "Method used to determine the user's country/region", + "type": "string", + "enum": [ + "ip", + "gps", + "user_provided", + "website_location", + "inferred", + "other" + ], + "meta:enum": { + "ip": "IP Address", + "gps": "Device GPS", + "user_provided": "User Provided", + "website_location": "Website location or eTLD", + "inferred": "Inferred", + "other": "Other" } } } }, - "consent-preferences" : { - "properties" : { - "xdm:choices" : { - "title" : "Consent and Preference Choices", - "description" : "Specific Consent and Preference Options", - "$ref" : "#/definitions/choices" + "consent-preferences": { + "properties": { + "xdm:choices": { + "title": "Consent and Preference Choices", + "description": "Specific Consent and Preference Options", + "$ref": "#/definitions/choices" }, - "xdm:choicesMetadata" : { - "title" : "Consent and Preference Metadata", - "description" : "Metadata that applies to all consents and preferences that don't specify a different value", - "$ref" : "#/definitions/metadata" + "xdm:choicesMetadata": { + "title": "Consent and Preference Metadata", + "description": "Metadata that applies to all consents and preferences that don't specify a different value", + "$ref": "#/definitions/metadata" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/consent-preferences" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/consent-preferences" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/device.schema.json b/components/datatypes/device.schema.json index 12757c0a2..1154bdfdc 100644 --- a/components/datatypes/device.schema.json +++ b/components/datatypes/device.schema.json @@ -1,115 +1,129 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/device", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Device", - "type" : "object", - "meta:extensible" : true, - "description" : "An identified device that is an application or browser instance that is trackable across sessions, normally by cookies.", - "definitions" : { - "device" : { - "properties" : { - "xdm:typeID" : { - "title" : "Type identifier", - "type" : "string", - "description" : "An identifier for the device. This may be an identifier from 'DeviceAtlas' or another service that identifies the hardware that is being used." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/device", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Device", + "type": "object", + "meta:extensible": true, + "description": "An identified device that is an application or browser instance that is trackable across sessions, normally by cookies.", + "definitions": { + "device": { + "properties": { + "xdm:typeID": { + "title": "Type identifier", + "type": "string", + "description": "An identifier for the device. This may be an identifier from 'DeviceAtlas' or another service that identifies the hardware that is being used." }, - "xdm:typeIDService" : { - "title" : "Type identifier service", - "type" : "string", - "format" : "uri", - "description" : "The namespace of the service that is used to identify the device type.", - "meta:enum" : { - "https://ns.adobe.com/xdm/external/deviceatlas" : "DeviceAtlas", - "https://ns.adobe.com/xdm/external/adobecampaign" : "Adobe Campaign" + "xdm:typeIDService": { + "title": "Type identifier service", + "type": "string", + "format": "uri", + "description": "The namespace of the service that is used to identify the device type.", + "meta:enum": { + "https://ns.adobe.com/xdm/external/deviceatlas": "DeviceAtlas", + "https://ns.adobe.com/xdm/external/adobecampaign": "Adobe Campaign" } }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "Type of device being tracked.", - "meta:enum" : { - "mobile" : "Mobile", - "tablet" : "Tablet", - "desktop" : "Desktop", - "ereader" : "E-reader", - "gaming" : "Gaming console", - "television" : "Television", - "settop" : "Set-top box", - "mediaplayer" : "Media player", - "computers" : "Computers", - "tv screens" : "TV screens" + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Type of device being tracked.", + "meta:enum": { + "mobile": "Mobile", + "tablet": "Tablet", + "desktop": "Desktop", + "ereader": "E-reader", + "gaming": "Gaming console", + "television": "Television", + "settop": "Set-top box", + "mediaplayer": "Media player", + "computers": "Computers", + "tv screens": "TV screens" } }, - "xdm:manufacturer" : { - "title" : "Manufacturer", - "type" : "string", - "description" : "The name of the organization who owns the design and creation of the device, for example, 'Apple' is the manufacturer of the iPhone." + "xdm:manufacturer": { + "title": "Manufacturer", + "type": "string", + "description": "The name of the organization who owns the design and creation of the device, for example, 'Apple' is the manufacturer of the iPhone." }, - "xdm:model" : { - "title" : "Model", - "type" : "string", - "description" : "The name of the model for the device. This is the common, human-readable, or marketing name for the device. For example, the 'iPhone 6S' is a particular model of mobile phone." + "xdm:model": { + "title": "Model", + "type": "string", + "description": "The name of the model for the device. This is the common, human-readable, or marketing name for the device. For example, the 'iPhone 6S' is a particular model of mobile phone." }, - "xdm:modelNumber" : { - "title" : "Model number", - "type" : "string", - "description" : "The unique model number designation assigned by the manufacturer for this device. Model numbers are not versions, but unique identifiers that identify a particular model configuration. While the model for a particular phone might be 'iPhone 6S' the model number would be 'A1633', or 'A1634' based on configuration at the time of sale." + "xdm:modelNumber": { + "title": "Model number", + "type": "string", + "description": "The unique model number designation assigned by the manufacturer for this device. Model numbers are not versions, but unique identifiers that identify a particular model configuration. While the model for a particular phone might be 'iPhone 6S' the model number would be 'A1633', or 'A1634' based on configuration at the time of sale." }, - "xdm:screenHeight" : { - "title" : "Screen height", - "type" : "integer", - "description" : "The number of vertical pixels of the device's active display in the default orientation." + "xdm:screenHeight": { + "title": "Screen height", + "type": "integer", + "description": "The number of vertical pixels of the device's active display in the default orientation." }, - "xdm:screenWidth" : { - "title" : "Screen width", - "type" : "integer", - "description" : "The number of horizontal pixels of the device's active display in the default orientation." + "xdm:screenWidth": { + "title": "Screen width", + "type": "integer", + "description": "The number of horizontal pixels of the device's active display in the default orientation." }, - "xdm:colorDepth" : { - "title" : "Color depth", - "type" : "integer", - "description" : "The number of colors the display is able to represent." + "xdm:colorDepth": { + "title": "Color depth", + "type": "integer", + "description": "The number of colors the display is able to represent." }, - "xdm:screenOrientation" : { - "title" : "Screen orientation", - "type" : "string", - "description" : "The current screen orientation such as \"portrait\" or \"landscape\".", - "enum" : [ "portrait", "landscape" ], - "meta:enum" : { - "portrait" : "Portrait", - "landscape" : "Landscape" + "xdm:screenOrientation": { + "title": "Screen orientation", + "type": "string", + "description": "The current screen orientation such as \"portrait\" or \"landscape\".", + "enum": ["portrait", "landscape"], + "meta:enum": { + "portrait": "Portrait", + "landscape": "Landscape" } }, - "xdm:isBackgroundPushEnabled" : { - "title" : "Background Push Enabled Flag", - "type" : "boolean", - "description" : "For devices like mobile , this tracks the system background push enabled permision status." + "xdm:isBackgroundPushEnabled": { + "title": "Background Push Enabled Flag", + "type": "boolean", + "description": "For devices like mobile , this tracks the system background push enabled permision status." }, - "xdm:isLocationEnabled" : { - "title" : "Location Enabled Flag", - "type" : "boolean", - "description" : "Indicates whether or not the device has location services enabled." + "xdm:isLocationEnabled": { + "title": "Location Enabled Flag", + "type": "boolean", + "description": "Indicates whether or not the device has location services enabled." }, - "xdm:locationPermission" : { - "title" : "Location Permission", - "type" : "string", - "description" : "Tracks the device location permision attribute setting.", - "enum" : [ "SYSTEM_LOCATION_DISABLED", "NOT_ALLOWED", "ALWAYS_ALLOWED", "FOREGROUND_ALLOWED", "UNPROMPTED" ] + "xdm:locationPermission": { + "title": "Location Permission", + "type": "string", + "description": "Tracks the device location permision attribute setting.", + "enum": [ + "SYSTEM_LOCATION_DISABLED", + "NOT_ALLOWED", + "ALWAYS_ALLOWED", + "FOREGROUND_ALLOWED", + "UNPROMPTED" + ] }, - "xdm:isPushOptIn" : { - "title" : "Push Opt In Flag", - "type" : "boolean", - "description" : "Indicates whether or not the device opted-in to receive push notifications." + "xdm:isPushOptIn": { + "title": "Push Opt In Flag", + "type": "boolean", + "description": "Indicates whether or not the device opted-in to receive push notifications." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/device" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/device" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/enduserids.schema.json b/components/datatypes/enduserids.schema.json index 33941bf9f..29cc61604 100644 --- a/components/datatypes/enduserids.schema.json +++ b/components/datatypes/enduserids.schema.json @@ -1,80 +1,88 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/enduserids", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "End user IDs", - "type" : "object", - "meta:extensible" : true, - "description" : "Condensed, normalized encapsulation of all end user identifiers. At least one of the fields is required.", - "minProperties" : 1, - "definitions" : { - "enduserids" : { - "properties" : { - "https://ns.adobe.com/experience/mcid" : { - "title" : "Adobe Marketing Cloud ID", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "A unique identifier from Adobe Marketing Cloud." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/enduserids", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "End user IDs", + "type": "object", + "meta:extensible": true, + "description": "Condensed, normalized encapsulation of all end user identifiers. At least one of the fields is required.", + "minProperties": 1, + "definitions": { + "enduserids": { + "properties": { + "https://ns.adobe.com/experience/mcid": { + "title": "Adobe Marketing Cloud ID", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "A unique identifier from Adobe Marketing Cloud." }, - "https://ns.adobe.com/experience/aaid" : { - "title" : "Adobe Analytics Cloud end user IDs", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "Adobe Analytics Cloud extension to end user IDs." + "https://ns.adobe.com/experience/aaid": { + "title": "Adobe Analytics Cloud end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Analytics Cloud extension to end user IDs." }, - "https://ns.adobe.com/experience/aacustomid" : { - "title" : "Adobe Analytics Cloud Custom end user IDs", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "An Adobe Analytics custom identifier passed in on a hit." + "https://ns.adobe.com/experience/aacustomid": { + "title": "Adobe Analytics Cloud Custom end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "An Adobe Analytics custom identifier passed in on a hit." }, - "https://ns.adobe.com/experience/acid" : { - "title" : "Adobe Campaign end user IDs", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "Adobe Campaign extension to end user IDs." + "https://ns.adobe.com/experience/acid": { + "title": "Adobe Campaign end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Campaign extension to end user IDs." }, - "https://ns.adobe.com/experience/tntid" : { - "title" : "Adobe Target end user IDs", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "Adobe Target extension to end user IDs." + "https://ns.adobe.com/experience/tntid": { + "title": "Adobe Target end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Target extension to end user IDs." }, - "https://ns.adobe.com/experience/adcloud" : { - "title" : "Adobe Advertising Cloud end user IDs", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "Adobe Advertising Cloud extension to end user IDs." + "https://ns.adobe.com/experience/adcloud": { + "title": "Adobe Advertising Cloud end user IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Adobe Advertising Cloud extension to end user IDs." }, - "https://ns.adobe.com/experience/emailid" : { - "title" : "Email address IDs", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "Email addresses used as IDs." + "https://ns.adobe.com/experience/emailid": { + "title": "Email address IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Email addresses used as IDs." }, - "https://ns.adobe.com/experience/phonenumberid" : { - "title" : "Phone number IDs", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "Phone numbers used as IDs." + "https://ns.adobe.com/experience/phonenumberid": { + "title": "Phone number IDs", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "Phone numbers used as IDs." } }, - "patternProperties" : { - ".+://.+" : { - "description" : "The identifier, including data source, foreign ID, and confidence. Note, `@id` must be identical to the property value.", - "type" : "object", - "$ref" : "https://ns.adobe.com/xdm/context/identity" + "patternProperties": { + ".+://.+": { + "description": "The identifier, including data source, foreign ID, and confidence. Note, `@id` must be identical to the property value.", + "type": "object", + "$ref": "https://ns.adobe.com/xdm/context/identity" } } } }, - "meta:keys" : { - "https://ns.adobe.com/experience/adcloud" : "Adobe Advertising Cloud", - "https://ns.adobe.com/experience/tntid" : "Adobe Target", - "https://ns.adobe.com/experience/acid" : "Adobe Campaign", - "https://ns.adobe.com/experience/aaid" : "Adobe Analytics", - "https://ns.adobe.com/experience/aacustomid" : "Adobe Analytics custom", - "https://ns.adobe.com/experience/mcid" : "Marketing Cloud identity core service", - "https://ns.adobe.com/experience/emailid" : "Email address", - "https://ns.adobe.com/experience/phonenumberid" : "Phone number" + "meta:keys": { + "https://ns.adobe.com/experience/adcloud": "Adobe Advertising Cloud", + "https://ns.adobe.com/experience/tntid": "Adobe Target", + "https://ns.adobe.com/experience/acid": "Adobe Campaign", + "https://ns.adobe.com/experience/aaid": "Adobe Analytics", + "https://ns.adobe.com/experience/aacustomid": "Adobe Analytics custom", + "https://ns.adobe.com/experience/mcid": "Marketing Cloud identity core service", + "https://ns.adobe.com/experience/emailid": "Email address", + "https://ns.adobe.com/experience/phonenumberid": "Phone number" }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/enduserids" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/enduserids" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/environment.schema.json b/components/datatypes/environment.schema.json index d3e4a5d81..96e709864 100644 --- a/components/datatypes/environment.schema.json +++ b/components/datatypes/environment.schema.json @@ -1,161 +1,188 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/environment", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Environment", - "type" : "object", - "meta:extensible" : true, - "description" : "Information about the surrounding situation the event observation occurred, specifically detailing transitory information such as the network or software versions. IMPORTANT: All values should be aligned with the [DeviceAtlas](https://deviceatlas.com) database licensed by Adobe. ", - "definitions" : { - "environment" : { - "properties" : { - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "The type of the application environment.", - "enum" : [ "browser", "application", "iot", "external", "widget" ], - "meta:enum" : { - "browser" : "Browser", - "application" : "Application", - "iot" : "Internet of things", - "external" : "External system", - "widget" : "Application extension" + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/environment", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Environment", + "type": "object", + "meta:extensible": true, + "description": "Information about the surrounding situation the event observation occurred, specifically detailing transitory information such as the network or software versions. IMPORTANT: All values should be aligned with the [DeviceAtlas](https://deviceatlas.com) database licensed by Adobe. ", + "definitions": { + "environment": { + "properties": { + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The type of the application environment.", + "enum": ["browser", "application", "iot", "external", "widget"], + "meta:enum": { + "browser": "Browser", + "application": "Application", + "iot": "Internet of things", + "external": "External system", + "widget": "Application extension" } }, - "xdm:browserDetails" : { - "title" : "Browser details", - "$ref" : "https://ns.adobe.com/xdm/context/browserdetails", - "description" : "The browser specific details such as browser name, version, javascript version, user agent string, and accept language." + "xdm:browserDetails": { + "title": "Browser details", + "$ref": "https://ns.adobe.com/xdm/context/browserdetails", + "description": "The browser specific details such as browser name, version, javascript version, user agent string, and accept language." }, - "xdm:operatingSystem" : { - "title" : "Operating system", - "type" : "string", - "description" : "The name of the operating system used when the observation was made. The attribute should not contain any version information such as '10.5.3', but instead contain 'edition' designations such as 'Ultimate' or 'Professional'." + "xdm:operatingSystem": { + "title": "Operating system", + "type": "string", + "description": "The name of the operating system used when the observation was made. The attribute should not contain any version information such as '10.5.3', but instead contain 'edition' designations such as 'Ultimate' or 'Professional'." }, - "xdm:operatingSystemVersion" : { - "title" : "Operating system version", - "type" : "string", - "description" : "The full version identifier for the operating system used when the observation was made. Versions are generally numerically composed but may be in a vendor defined format." + "xdm:operatingSystemVersion": { + "title": "Operating system version", + "type": "string", + "description": "The full version identifier for the operating system used when the observation was made. Versions are generally numerically composed but may be in a vendor defined format." }, - "xdm:operatingSystemVendor" : { - "title" : "Operating system vendor", - "type" : "string", - "description" : "The name of the operating system vendor used when the observation was made." + "xdm:operatingSystemVendor": { + "title": "Operating system vendor", + "type": "string", + "description": "The name of the operating system vendor used when the observation was made." }, - "xdm:colorDepth" : { - "title" : "Color depth", - "type" : "integer", - "description" : "The number of bits used for each color component of a single pixel.", - "minimum" : 0 + "xdm:colorDepth": { + "title": "Color depth", + "type": "integer", + "description": "The number of bits used for each color component of a single pixel.", + "minimum": 0 }, - "xdm:viewportHeight" : { - "title" : "Viewport height", - "type" : "integer", - "description" : "The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height.", - "minimum" : 0 + "xdm:viewportHeight": { + "title": "Viewport height", + "type": "integer", + "description": "The vertical size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport height.", + "minimum": 0 }, - "xdm:viewportWidth" : { - "title" : "Viewport width", - "type" : "integer", - "description" : "The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width.", - "minimum" : 0 + "xdm:viewportWidth": { + "title": "Viewport width", + "type": "integer", + "description": "The horizontal size in pixels of the window the experience was displayed inside. For a web view event, the browser viewport width.", + "minimum": 0 }, - "xdm:duration" : { - "title" : "Duration", - "type" : "integer", - "description" : "The number of milliseconds that the user was on the screen.", - "minimum" : 0 + "xdm:duration": { + "title": "Duration", + "type": "integer", + "description": "The number of milliseconds that the user was on the screen.", + "minimum": 0 }, - "xdm:viewedScreen" : { - "title" : "Viewed Screen", - "type" : "string", - "description" : "The friendly name assigned to the screen that the user was on." + "xdm:viewedScreen": { + "title": "Viewed Screen", + "type": "string", + "description": "The friendly name assigned to the screen that the user was on." }, - "xdm:previousScreen" : { - "title" : "Previous Screen", - "type" : "string", - "description" : "The frinedly name assigned to the screen the user was on prior to the viewedScreen." + "xdm:previousScreen": { + "title": "Previous Screen", + "type": "string", + "description": "The frinedly name assigned to the screen the user was on prior to the viewedScreen." }, - "xdm:connectionType" : { - "title" : "Connection type", - "type" : "string", - "description" : "Internet connection type.", - "enum" : [ "dialup", "isdn", "bisdn", "dsl", "cable", "wireless_wifi", "mobile", "mobile_edge", "mobile_2g", "mobile_3g", "mobile_lte", "t1", "t3", "oc3", "lan", "modem" ], - "meta:enum" : { - "dialup" : "Dial-up", - "isdn" : "ISDN", - "bisdn" : "BISDN", - "dsl" : "DSL", - "cable" : "Cable", - "wireless_wifi" : "Wireless wifi", - "mobile" : "Mobile", - "mobile_edge" : "Mobile Edge", - "mobile_gprs" : "Mobile GPRS", - "mobile_2g" : "Mobile 2G", - "mobile_3g" : "Mobile 3G", - "mobile_lte" : "Mobile LTE", - "t1" : "T1", - "t3" : "T3", - "oc3" : "OC3", - "lan" : "LAN", - "modem" : "Modem" + "xdm:connectionType": { + "title": "Connection type", + "type": "string", + "description": "Internet connection type.", + "enum": [ + "dialup", + "isdn", + "bisdn", + "dsl", + "cable", + "wireless_wifi", + "mobile", + "mobile_edge", + "mobile_2g", + "mobile_3g", + "mobile_lte", + "t1", + "t3", + "oc3", + "lan", + "modem" + ], + "meta:enum": { + "dialup": "Dial-up", + "isdn": "ISDN", + "bisdn": "BISDN", + "dsl": "DSL", + "cable": "Cable", + "wireless_wifi": "Wireless wifi", + "mobile": "Mobile", + "mobile_edge": "Mobile Edge", + "mobile_gprs": "Mobile GPRS", + "mobile_2g": "Mobile 2G", + "mobile_3g": "Mobile 3G", + "mobile_lte": "Mobile LTE", + "t1": "T1", + "t3": "T3", + "oc3": "OC3", + "lan": "LAN", + "modem": "Modem" } }, - "xdm:carrier" : { - "title" : "Mobile network carrier", - "type" : "string", - "description" : "A mobile network carrier or MNO, also known as a wireless service provider, wireless carrier, cellular company, or mobile network carrier, is a provider of services wireless communications that owns or controls all the elements necessary to sell and deliver services to an end user." + "xdm:carrier": { + "title": "Mobile network carrier", + "type": "string", + "description": "A mobile network carrier or MNO, also known as a wireless service provider, wireless carrier, cellular company, or mobile network carrier, is a provider of services wireless communications that owns or controls all the elements necessary to sell and deliver services to an end user." }, - "xdm:domain" : { - "title" : "Domain", - "type" : "string", - "description" : "The domain of the users ISP." + "xdm:domain": { + "title": "Domain", + "type": "string", + "description": "The domain of the users ISP." }, - "xdm:ISP" : { - "title" : "Internet service provider", - "type" : "string", - "description" : "The name of the user's internet service provider." + "xdm:ISP": { + "title": "Internet service provider", + "type": "string", + "description": "The name of the user's internet service provider." }, - "dc:language" : { - "meta:usereditable" : false, - "title" : "Language", - "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" : "The language of the environment to represent the user's linguistic, geographical, or cultural preferences for data presentation.\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" : [ "en-US", "pt-BR", "es-ES" ] + "dc:language": { + "meta:usereditable": false, + "title": "Language", + "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": "The language of the environment to represent the user's linguistic, geographical, or cultural preferences for data presentation.\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": ["en-US", "pt-BR", "es-ES"] } } }, - "ipv4" : { - "properties" : { - "xdm:ipV4" : { - "title" : "IPv4", - "type" : "string", - "format" : "ipv4", - "description" : "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. " + "ipv4": { + "properties": { + "xdm:ipV4": { + "title": "IPv4", + "type": "string", + "format": "ipv4", + "description": "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. " } } }, - "ipv6" : { - "properties" : { - "xdm:ipV6" : { - "title" : "IPv6", - "type" : "string", - "format" : "ipv6", - "description" : "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. " + "ipv6": { + "properties": { + "xdm:ipV6": { + "title": "IPv6", + "type": "string", + "format": "ipv6", + "description": "The numerical label assigned to a device participating in a computer network that uses the Internet Protocol for communication. " } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/environment" - }, { - "$ref" : "#/definitions/ipv4" - }, { - "$ref" : "#/definitions/ipv6" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/environment" + }, + { + "$ref": "#/definitions/ipv4" + }, + { + "$ref": "#/definitions/ipv6" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/extensible.schema.json b/components/datatypes/extensible.schema.json index 83e8e2d84..890071794 100644 --- a/components/datatypes/extensible.schema.json +++ b/components/datatypes/extensible.schema.json @@ -1,300 +1,310 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$schema" : "http://json-schema.org/draft-06/schema#", - "$id" : "https://ns.adobe.com/xdm/common/extensible", - "type" : "object", - "title" : "Extensibility base schema", - "description" : "", - "definitions" : { - "@context" : { - "oneOf" : [ { - "type" : "object", - "patternProperties" : { - "@type" : { }, - "@id" : { }, - "^xdm:.*$" : { }, - "^core:.*$" : { }, - "^meta:.*$" : { }, - "^xmpMM:.*$" : { }, - "^xmpDM:.*$" : { }, - "^xmpRights:.*$" : { }, - "^xmpTPg:.*$" : { }, - "^xmp:.*$" : { }, - "^stDim:.*$" : { }, - "^dc:.*$" : { }, - "^skos:.*$" : { }, - "^rdf:.*$" : { }, - "^rdfs:.*$" : { }, - "^owl:.*$" : { }, - "^xsd:.*$" : { }, - "^xml:.*$" : { }, - "^photoshop:.*$" : { }, - "^tiff:.*$" : { }, - "^plus:.*$" : { }, - "^cc:.*$" : { }, - "^stEvt:.*$" : { }, - "^stFnt:.*$" : { }, - "^stLayerGroup:.*$" : { }, - "^stArtboard:.*$" : { }, - "^exif:.*$" : { }, - "^activitystreams:.*$" : { }, - "^schema:.*$" : { }, - "^repo:.*$" : { }, - "^iptc4xmpExt:.*$" : { }, - "^dsp:.*$" : { }, - "^searchads:.*$" : { }, - "^adcloud:.*$" : { }, - "^id3:.*$" : { }, - "^dataDotCom:.*$" : { }, - "^marketo:.*$" : { }, - "^bizible:.*$" : { }, - ".+://.+" : { }, - "@.*" : { } + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/extensible", + "type": "object", + "title": "Extensibility base schema", + "description": "", + "definitions": { + "@context": { + "oneOf": [ + { + "type": "object", + "patternProperties": { + "@type": {}, + "@id": {}, + "^xdm:.*$": {}, + "^core:.*$": {}, + "^meta:.*$": {}, + "^xmpMM:.*$": {}, + "^xmpDM:.*$": {}, + "^xmpRights:.*$": {}, + "^xmpTPg:.*$": {}, + "^xmp:.*$": {}, + "^stDim:.*$": {}, + "^dc:.*$": {}, + "^skos:.*$": {}, + "^rdf:.*$": {}, + "^rdfs:.*$": {}, + "^owl:.*$": {}, + "^xsd:.*$": {}, + "^xml:.*$": {}, + "^photoshop:.*$": {}, + "^tiff:.*$": {}, + "^plus:.*$": {}, + "^cc:.*$": {}, + "^stEvt:.*$": {}, + "^stFnt:.*$": {}, + "^stLayerGroup:.*$": {}, + "^stArtboard:.*$": {}, + "^exif:.*$": {}, + "^activitystreams:.*$": {}, + "^schema:.*$": {}, + "^repo:.*$": {}, + "^iptc4xmpExt:.*$": {}, + "^dsp:.*$": {}, + "^searchads:.*$": {}, + "^adcloud:.*$": {}, + "^id3:.*$": {}, + "^dataDotCom:.*$": {}, + "^marketo:.*$": {}, + "^bizible:.*$": {}, + ".+://.+": {}, + "@.*": {} + }, + "additionalProperties": false }, - "additionalProperties" : false - }, { - "type" : "object", - "properties" : { - "@context" : { - "type" : "object", - "properties" : { - "xdm" : { - "type" : "string", - "format" : "url", - "const" : "https://ns.adobe.com/xdm/" - }, - "xdm:descriptorOneToOne" : { - "type" : "string", - "format" : "url", - "const" : "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne" - }, - "core" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/adobecloud/core/1.0/" - }, - "meta" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/adobecloud/meta/1.0/" - }, - "xmpMM" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xap/1.0/mm/" - }, - "xmpDM" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xmp/1.0/DynamicMedia/" - }, - "xmpRights" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xap/1.0/rights/" - }, - "xmpTPg" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xap/1.0/t/pg/" - }, - "xmp" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xap/1.0/" - }, - "stDim" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xap/1.0/sType/Dimensions#" - }, - "dc" : { - "type" : "string", - "format" : "url", - "const" : "http://purl.org/dc/elements/1.1/" - }, - "skos" : { - "type" : "string", - "format" : "url", - "const" : "http://www.w3.org/2004/02/skos/core#" - }, - "rdf" : { - "type" : "string", - "format" : "url", - "const" : "http://www.w3.org/1999/02/22-rdf-syntax-ns#" - }, - "rdfs" : { - "type" : "string", - "format" : "url", - "const" : "http://www.w3.org/2000/01/rdf-schema#" - }, - "owl" : { - "type" : "string", - "format" : "url", - "const" : "http://www.w3.org/2002/07/owl#" - }, - "xsd" : { - "type" : "string", - "format" : "url", - "const" : "http://www.w3.org/2001/XMLSchema#" - }, - "xml" : { - "type" : "string", - "format" : "url", - "const" : "http://www.w3.org/XML/1998/namespace/" - }, - "photoshop" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/photoshop/1.0/" - }, - "tiff" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/tiff/1.0/" - }, - "plus" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.useplus.org/ldf/xmp/1.0/" - }, - "cc" : { - "type" : "string", - "format" : "url", - "const" : "http://creativecommons.org/ns#" - }, - "stEvt" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xap/1.0/sType/ResourceEvent#" - }, - "stFnt" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/xap/1.0/sType/Font#" - }, - "stLayerGroup" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/core/1.0/sType/LayerGroup#" - }, - "stArtboard" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/core/1.0/sType/Artboard#" - }, - "exif" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/exif/1.0/#" - }, - "activitystreams" : { - "type" : "string", - "format" : "url", - "const" : "https://www.w3.org/ns/activitystreams" - }, - "schema" : { - "type" : "string", - "format" : "url", - "const" : "http://schema.org/" - }, - "repo" : { - "type" : "string", - "format" : "url", - "const" : "http://ns.adobe.com/adobecloud/core/1.0/" - }, - "iptc4xmpExt" : { - "type" : "string", - "format" : "url", - "const" : "http://iptc.org/std/Iptc4xmpExt/1.1/" - }, - "dsp" : { - "type" : "string", - "format" : "url", - "const" : "https://ns.adobe.com/adcloud/dsp/" - }, - "searchads" : { - "type" : "string", - "format" : "url", - "const" : "https://ns.adobe.com/adcloud/searchads/" - }, - "adcloud" : { - "type" : "string", - "format" : "url", - "const" : "https://ns.adobe.com/adcloud/" - }, - "id3" : { - "type" : "string", - "format" : "url", - "const" : "http://id3.org/ns/2.4/" - }, - "dataDotCom" : { - "type" : "string", - "format" : "url", - "const" : "https://www.data.com/" - }, - "marketo" : { - "type" : "string", - "format" : "url", - "const" : "https://ns.adobe.com/marketo/" - }, - "bizible" : { - "type" : "string", - "format" : "url", - "const" : "https://ns.adobe.com/bizible/" - } - }, - "additionalProperties" : false, - "required" : [ "xdm" ] - } - }, - "patternProperties" : { - "^xdm:.*$" : { }, - "^core:.*$" : { }, - "^meta:.*$" : { }, - "^xmpMM:.*$" : { }, - "^xmpDM:.*$" : { }, - "^xmpRights:.*$" : { }, - "^xmpTPg:.*$" : { }, - "^xmp:.*$" : { }, - "^stDim:.*$" : { }, - "^dc:.*$" : { }, - "^skos:.*$" : { }, - "^rdf:.*$" : { }, - "^rdfs:.*$" : { }, - "^owl:.*$" : { }, - "^xsd:.*$" : { }, - "^xml:.*$" : { }, - "^photoshop:.*$" : { }, - "^tiff:.*$" : { }, - "^plus:.*$" : { }, - "^cc:.*$" : { }, - "^stEvt:.*$" : { }, - "^stFnt:.*$" : { }, - "^stLayerGroup:.*$" : { }, - "^stArtboard:.*$" : { }, - "^exif:.*$" : { }, - "^activitystreams:.*$" : { }, - "^schema:.*$" : { }, - "^repo:.*$" : { }, - "^iptc4xmpExt:.*$" : { }, - "^dsp:.*$" : { }, - "^searchads:.*$" : { }, - "^adcloud:.*$" : { }, - "^id3:.*$" : { }, - "^dataDotCom:.*$" : { }, - "^marketo:.*$" : { }, - "^bizible:.*$" : { }, - ".+://.+" : { } - }, - "required" : [ "@context" ], - "additionalProperties" : false - } ] + { + "type": "object", + "properties": { + "@context": { + "type": "object", + "properties": { + "xdm": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/xdm/" + }, + "xdm:descriptorOneToOne": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne" + }, + "core": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/adobecloud/core/1.0/" + }, + "meta": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/adobecloud/meta/1.0/" + }, + "xmpMM": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/mm/" + }, + "xmpDM": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xmp/1.0/DynamicMedia/" + }, + "xmpRights": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/rights/" + }, + "xmpTPg": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/t/pg/" + }, + "xmp": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/" + }, + "stDim": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/sType/Dimensions#" + }, + "dc": { + "type": "string", + "format": "url", + "const": "http://purl.org/dc/elements/1.1/" + }, + "skos": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2004/02/skos/core#" + }, + "rdf": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/1999/02/22-rdf-syntax-ns#" + }, + "rdfs": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2000/01/rdf-schema#" + }, + "owl": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2002/07/owl#" + }, + "xsd": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/2001/XMLSchema#" + }, + "xml": { + "type": "string", + "format": "url", + "const": "http://www.w3.org/XML/1998/namespace/" + }, + "photoshop": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/photoshop/1.0/" + }, + "tiff": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/tiff/1.0/" + }, + "plus": { + "type": "string", + "format": "url", + "const": "http://ns.useplus.org/ldf/xmp/1.0/" + }, + "cc": { + "type": "string", + "format": "url", + "const": "http://creativecommons.org/ns#" + }, + "stEvt": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/sType/ResourceEvent#" + }, + "stFnt": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/xap/1.0/sType/Font#" + }, + "stLayerGroup": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/core/1.0/sType/LayerGroup#" + }, + "stArtboard": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/core/1.0/sType/Artboard#" + }, + "exif": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/exif/1.0/#" + }, + "activitystreams": { + "type": "string", + "format": "url", + "const": "https://www.w3.org/ns/activitystreams" + }, + "schema": { + "type": "string", + "format": "url", + "const": "http://schema.org/" + }, + "repo": { + "type": "string", + "format": "url", + "const": "http://ns.adobe.com/adobecloud/core/1.0/" + }, + "iptc4xmpExt": { + "type": "string", + "format": "url", + "const": "http://iptc.org/std/Iptc4xmpExt/1.1/" + }, + "dsp": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/adcloud/dsp/" + }, + "searchads": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/adcloud/searchads/" + }, + "adcloud": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/adcloud/" + }, + "id3": { + "type": "string", + "format": "url", + "const": "http://id3.org/ns/2.4/" + }, + "dataDotCom": { + "type": "string", + "format": "url", + "const": "https://www.data.com/" + }, + "marketo": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/marketo/" + }, + "bizible": { + "type": "string", + "format": "url", + "const": "https://ns.adobe.com/bizible/" + } + }, + "additionalProperties": false, + "required": ["xdm"] + } + }, + "patternProperties": { + "^xdm:.*$": {}, + "^core:.*$": {}, + "^meta:.*$": {}, + "^xmpMM:.*$": {}, + "^xmpDM:.*$": {}, + "^xmpRights:.*$": {}, + "^xmpTPg:.*$": {}, + "^xmp:.*$": {}, + "^stDim:.*$": {}, + "^dc:.*$": {}, + "^skos:.*$": {}, + "^rdf:.*$": {}, + "^rdfs:.*$": {}, + "^owl:.*$": {}, + "^xsd:.*$": {}, + "^xml:.*$": {}, + "^photoshop:.*$": {}, + "^tiff:.*$": {}, + "^plus:.*$": {}, + "^cc:.*$": {}, + "^stEvt:.*$": {}, + "^stFnt:.*$": {}, + "^stLayerGroup:.*$": {}, + "^stArtboard:.*$": {}, + "^exif:.*$": {}, + "^activitystreams:.*$": {}, + "^schema:.*$": {}, + "^repo:.*$": {}, + "^iptc4xmpExt:.*$": {}, + "^dsp:.*$": {}, + "^searchads:.*$": {}, + "^adcloud:.*$": {}, + "^id3:.*$": {}, + "^dataDotCom:.*$": {}, + "^marketo:.*$": {}, + "^bizible:.*$": {}, + ".+://.+": {} + }, + "required": ["@context"], + "additionalProperties": false + } + ] } }, - "allOf" : [ { - "$ref" : "#/definitions/@context" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/@context" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/geo-interaction-details.schema.json b/components/datatypes/geo-interaction-details.schema.json index 5907045d8..216f61a8e 100644 --- a/components/datatypes/geo-interaction-details.schema.json +++ b/components/datatypes/geo-interaction-details.schema.json @@ -1,37 +1,45 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/geo-interaction-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Geo interaction details", - "type" : "object", - "meta:extensible" : true, - "description" : "The geo details relating to the current state of inclusion in a geo defined area.", - "definitions" : { - "geo-interaction-detail" : { - "properties" : { - "xdm:distanceToCenter" : { - "title" : "Distance to center", - "type" : "number", - "description" : "Distance to center of geo in, case of a geo circle, measured in meters." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/geo-interaction-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Geo interaction details", + "type": "object", + "meta:extensible": true, + "description": "The geo details relating to the current state of inclusion in a geo defined area.", + "definitions": { + "geo-interaction-detail": { + "properties": { + "xdm:distanceToCenter": { + "title": "Distance to center", + "type": "number", + "description": "Distance to center of geo in, case of a geo circle, measured in meters." }, - "xdm:deviceGeoAccuracy" : { - "title" : "Geo device accuracy", - "type" : "number", - "description" : "The accuracy of the geo measuring device or mechanism, measured in meters." + "xdm:deviceGeoAccuracy": { + "title": "Geo device accuracy", + "type": "number", + "description": "The accuracy of the geo measuring device or mechanism, measured in meters." }, - "xdm:geoShape" : { - "title" : "Geo shape", - "$ref" : "http://schema.org/GeoShape", - "description" : "Geo shape of the geo being interacted with." + "xdm:geoShape": { + "title": "Geo shape", + "$ref": "http://schema.org/GeoShape", + "description": "Geo shape of the geo being interacted with." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/geo-interaction-detail" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/geo-interaction-detail" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/identity-provider.schema.json b/components/datatypes/identity-provider.schema.json index 4a30b3453..1353c4d3b 100644 --- a/components/datatypes/identity-provider.schema.json +++ b/components/datatypes/identity-provider.schema.json @@ -1,26 +1,33 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$schema" : "http://json-schema.org/draft-06/schema#", - "$id" : "https://ns.adobe.com/xdm/common/identity-provider", - "title" : "Identity Provider", - "meta:extensible" : true, - "description" : "An identity provider (abbreviated IdP) is a system entity that creates, maintains, and manages identity information for principals while providing authentication services to relying party applications within a federation or distributed network. An identity provider offers subject authentication as a service.", - "definitions" : { - "name" : { - "properties" : { - "@id" : { - "type" : "string", - "format" : "uri-reference", - "description" : "A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the identity provider. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986)." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/identity-provider", + "title": "Identity Provider", + "meta:extensible": true, + "description": "An identity provider (abbreviated IdP) is a system entity that creates, maintains, and manages identity information for principals while providing authentication services to relying party applications within a federation or distributed network. An identity provider offers subject authentication as a service.", + "definitions": { + "name": { + "properties": { + "@id": { + "type": "string", + "format": "uri-reference", + "description": "A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the identity provider. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986)." } } } }, - "type" : "object", - "allOf" : [ { - "$ref" : "#/definitions/name" - } ], - "required" : [ "@id" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/name" + } + ], + "required": ["@id"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/identity.schema.json b/components/datatypes/identity.schema.json index d8bddc88a..714f99907 100644 --- a/components/datatypes/identity.schema.json +++ b/components/datatypes/identity.schema.json @@ -1,35 +1,44 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/identity", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Identity", - "type" : "object", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/context/identityitem" ], - "description" : "Identity is used to clearly distinguish people that are interacting with digital experiences. Identity is established by an identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the identity is unique.", - "definitions" : { - "identity" : { - "properties" : { - "xdm:namespace" : { - "title" : "Namespace", - "$ref" : "https://ns.adobe.com/xdm/context/namespace", - "description" : "The namespace associated with the `xid` attribute and matched up with the AAM data source integration code." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/identity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity", + "type": "object", + "meta:extensible": true, + "meta:extends": ["https://ns.adobe.com/xdm/context/identityitem"], + "description": "Identity is used to clearly distinguish people that are interacting with digital experiences. Identity is established by an identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the identity is unique.", + "definitions": { + "identity": { + "properties": { + "xdm:namespace": { + "title": "Namespace", + "$ref": "https://ns.adobe.com/xdm/context/namespace", + "description": "The namespace associated with the `xid` attribute and matched up with the AAM data source integration code." }, - "xdm:xid" : { - "title" : "Experience identifier", - "type" : "string", - "description" : "When present, experience identifier value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." + "xdm:xid": { + "title": "Experience identifier", + "type": "string", + "description": "When present, experience identifier value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/identityitem#/definitions/identityitem" - }, { - "$ref" : "#/definitions/identity" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identityitem#/definitions/identityitem" + }, + { + "$ref": "#/definitions/identity" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/identityitem.schema.json b/components/datatypes/identityitem.schema.json index 5c5ece55c..df038564f 100644 --- a/components/datatypes/identityitem.schema.json +++ b/components/datatypes/identityitem.schema.json @@ -1,44 +1,52 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/identityitem", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Identity item", - "type" : "object", - "meta:extensible" : true, - "description" : "An end user identity item, to be included in an instance of `context/identitymap`.", - "definitions" : { - "identityitem" : { - "properties" : { - "xdm:id" : { - "title" : "Identifier", - "type" : "string", - "description" : "Identity of the consumer in the related namespace." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/identityitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity item", + "type": "object", + "meta:extensible": true, + "description": "An end user identity item, to be included in an instance of `context/identitymap`.", + "definitions": { + "identityitem": { + "properties": { + "xdm:id": { + "title": "Identifier", + "type": "string", + "description": "Identity of the consumer in the related namespace." }, - "xdm:authenticatedState" : { - "description" : "The state this identity is authenticated as for this observed ExperienceEvent.", - "type" : "string", - "default" : "ambiguous", - "enum" : [ "ambiguous", "authenticated", "loggedOut" ], - "meta:enum" : { - "ambiguous" : "Ambiguous", - "authenticated" : "User identified by a login or similar action that was valid at the time of the event observation.", - "loggedOut" : "User was identified by a login action at some point of time previously, but is not currently logged in." + "xdm:authenticatedState": { + "description": "The state this identity is authenticated as for this observed ExperienceEvent.", + "type": "string", + "default": "ambiguous", + "enum": ["ambiguous", "authenticated", "loggedOut"], + "meta:enum": { + "ambiguous": "Ambiguous", + "authenticated": "User identified by a login or similar action that was valid at the time of the event observation.", + "loggedOut": "User was identified by a login action at some point of time previously, but is not currently logged in." } }, - "xdm:primary" : { - "title" : "Primary", - "type" : "boolean", - "default" : false, - "description" : "Indicates this identity is the preferred identity. Is used as a hint to help systems better organize how identities are queried." + "xdm:primary": { + "title": "Primary", + "type": "boolean", + "default": false, + "description": "Indicates this identity is the preferred identity. Is used as a hint to help systems better organize how identities are queried." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/identityitem" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/identityitem" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/industry-verticals/comparisons.schema.json b/components/datatypes/industry-verticals/comparisons.schema.json index 5d602d092..1c217d2c4 100644 --- a/components/datatypes/industry-verticals/comparisons.schema.json +++ b/components/datatypes/industry-verticals/comparisons.schema.json @@ -1,58 +1,65 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/comparisons", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Comparisons", - "type" : "object", - "meta:extensible" : true, - "description" : "Used for site comparisons, such as products, cards, rooms, flights, etc.", - "definitions" : { - "comparisons" : { - "properties" : { - "xdm:addition" : { - "title" : "Addition", - "type" : "integer", - "description" : "Tracked when an item is added to a comparison." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/comparisons", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Comparisons", + "type": "object", + "meta:extensible": true, + "description": "Used for site comparisons, such as products, cards, rooms, flights, etc.", + "definitions": { + "comparisons": { + "properties": { + "xdm:addition": { + "title": "Addition", + "type": "integer", + "description": "Tracked when an item is added to a comparison." }, - "xdm:count" : { - "title" : "Count", - "type" : "integer", - "description" : "Count of the total number of items being compared." + "xdm:count": { + "title": "Count", + "type": "integer", + "description": "Count of the total number of items being compared." }, - "xdm:items" : { - "title" : "Items", - "type" : "array", - "items" : { - "type" : "string" + "xdm:items": { + "title": "Items", + "type": "array", + "items": { + "type": "string" }, - "description" : "An array of all item IDs/SKUs in the list of products. " + "description": "An array of all item IDs/SKUs in the list of products. " }, - "xdm:removal" : { - "title" : "Removal", - "type" : "integer", - "description" : "Tracked when an item is removed from a comparison." + "xdm:removal": { + "title": "Removal", + "type": "integer", + "description": "Tracked when an item is removed from a comparison." }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "Type of comparison tool in use." + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Type of comparison tool in use." }, - "xdm:view" : { - "title" : "View", - "type" : "integer", - "description" : "Tracked when a comparison page is viewed." + "xdm:view": { + "title": "View", + "type": "integer", + "description": "Tracked when a comparison page is viewed." }, - "xdm:impressions" : { - "title" : "Impressions", - "$ref" : "https://ns.adobe.com/xdm/datatypes/impressions", - "description" : "Extension of the impressions data type." + "xdm:impressions": { + "title": "Impressions", + "$ref": "https://ns.adobe.com/xdm/datatypes/impressions", + "description": "Extension of the impressions data type." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/comparisons" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/comparisons" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/file-transfer.schema.json b/components/datatypes/industry-verticals/file-transfer.schema.json index 347852899..fa411d684 100644 --- a/components/datatypes/industry-verticals/file-transfer.schema.json +++ b/components/datatypes/industry-verticals/file-transfer.schema.json @@ -1,61 +1,68 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/file-transfer", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "File Transfer", - "type" : "object", - "meta:extensible" : true, - "description" : "", - "definitions" : { - "file-transfer" : { - "properties" : { - "xdm:fileName" : { - "title" : "File Name", - "type" : "string", - "description" : "Friendly name of the file being up/downloaded by the visitor." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/file-transfer", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "File Transfer", + "type": "object", + "meta:extensible": true, + "description": "", + "definitions": { + "file-transfer": { + "properties": { + "xdm:fileName": { + "title": "File Name", + "type": "string", + "description": "Friendly name of the file being up/downloaded by the visitor." }, - "xdm:fileSize" : { - "title" : "File Size", - "type" : "number", - "description" : "File size of file being up/downloaded by the visitor." + "xdm:fileSize": { + "title": "File Size", + "type": "number", + "description": "File size of file being up/downloaded by the visitor." }, - "xdm:fileTransferComplete" : { - "title" : "File Transfer Complete", - "type" : "integer", - "description" : "Captured when a file transfer is successfully completed." + "xdm:fileTransferComplete": { + "title": "File Transfer Complete", + "type": "integer", + "description": "Captured when a file transfer is successfully completed." }, - "xdm:fileTransferStart" : { - "title" : "File Transfer Start", - "type" : "integer", - "description" : "Captured when a file transfer is initiated." + "xdm:fileTransferStart": { + "title": "File Transfer Start", + "type": "integer", + "description": "Captured when a file transfer is initiated." }, - "xdm:fileTransferError" : { - "title" : "File Transfer Error", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Captured when an error occurs during the file transfer process." + "xdm:fileTransferError": { + "title": "File Transfer Error", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Captured when an error occurs during the file transfer process." }, - "xdm:fileTransferType" : { - "title" : "File Transfer Type", - "type" : "string", - "description" : "Type of the file transfer, if applicable." + "xdm:fileTransferType": { + "title": "File Transfer Type", + "type": "string", + "description": "Type of the file transfer, if applicable." }, - "xdm:fileType" : { - "title" : "File Type", - "type" : "string", - "description" : "Type or category of file being up/downloaded by the visitor." + "xdm:fileType": { + "title": "File Type", + "type": "string", + "description": "Type or category of file being up/downloaded by the visitor." }, - "xdm:fileURL" : { - "title" : "File URL", - "format" : "uri", - "type" : "string", - "description" : "URL of file being up/downloaded by the visitor." + "xdm:fileURL": { + "title": "File URL", + "format": "uri", + "type": "string", + "description": "URL of file being up/downloaded by the visitor." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/file-transfer" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/file-transfer" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/financial-account.schema.json b/components/datatypes/industry-verticals/financial-account.schema.json index 25ef2ca02..254c38b4c 100644 --- a/components/datatypes/industry-verticals/financial-account.schema.json +++ b/components/datatypes/industry-verticals/financial-account.schema.json @@ -1,55 +1,62 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/financial-account", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Financial Account", - "type" : "object", - "meta:extensible" : true, - "description" : "Financial account details, such as owners, balances, and types.", - "definitions" : { - "financial-account" : { - "properties" : { - "xdm:currentAccountBalance" : { - "title" : "Current Financial Account Balance", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "Balance in the account." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/financial-account", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Financial Account", + "type": "object", + "meta:extensible": true, + "description": "Financial account details, such as owners, balances, and types.", + "definitions": { + "financial-account": { + "properties": { + "xdm:currentAccountBalance": { + "title": "Current Financial Account Balance", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "Balance in the account." }, - "xdm:financialAccountID" : { - "title" : "Financial Account ID", - "type" : "string", - "description" : "Current account balance for a single user account." + "xdm:financialAccountID": { + "title": "Financial Account ID", + "type": "string", + "description": "Current account balance for a single user account." }, - "xdm:financialAccountName" : { - "title" : "Financial Account Name", - "type" : "string", - "description" : "Name assigned to the financial account." + "xdm:financialAccountName": { + "title": "Financial Account Name", + "type": "string", + "description": "Name assigned to the financial account." }, - "xdm:financialAccountOwner" : { - "title" : "Financial Account Owners", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/profile-personal-details" + "xdm:financialAccountOwner": { + "title": "Financial Account Owners", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details" }, - "description" : "Array of the owner(s) of the selected financial account. Extension of the personal profile details data type." + "description": "Array of the owner(s) of the selected financial account. Extension of the personal profile details data type." }, - "xdm:financialAccountType" : { - "title" : "Financial Account Type", - "type" : "string", - "enum" : [ "checking", "savings", "retirement", "investment" ], - "description" : "Describes the type of finanical account, such as checking, savings, or retirement." + "xdm:financialAccountType": { + "title": "Financial Account Type", + "type": "string", + "enum": ["checking", "savings", "retirement", "investment"], + "description": "Describes the type of finanical account, such as checking, savings, or retirement." }, - "xdm:openedDate" : { - "title" : "Financial Account Open Date", - "type" : "string", - "format" : "date-time", - "description" : "Date which the account was opened." + "xdm:openedDate": { + "title": "Financial Account Open Date", + "type": "string", + "format": "date-time", + "description": "Date which the account was opened." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/financial-account" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/financial-account" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/form-applications.schema.json b/components/datatypes/industry-verticals/form-applications.schema.json index 2ac6251c1..b8664760d 100644 --- a/components/datatypes/industry-verticals/form-applications.schema.json +++ b/components/datatypes/industry-verticals/form-applications.schema.json @@ -1,72 +1,79 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/form-applications", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Form Applications", - "type" : "object", - "meta:extensible" : true, - "description" : "Used when any application process is started, such as financing, limit changes, or educational programs.", - "definitions" : { - "form-applications" : { - "properties" : { - "xdm:approved" : { - "title" : "Form Application Approved", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Captured when a visitor application has been approved." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/form-applications", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Form Applications", + "type": "object", + "meta:extensible": true, + "description": "Used when any application process is started, such as financing, limit changes, or educational programs.", + "definitions": { + "form-applications": { + "properties": { + "xdm:approved": { + "title": "Form Application Approved", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Captured when a visitor application has been approved." }, - "xdm:declined" : { - "title" : "Form Application Declined", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Captured when a visitor application has been declined." + "xdm:declined": { + "title": "Form Application Declined", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Captured when a visitor application has been declined." }, - "xdm:applicationFee" : { - "title" : "Application Fee", - "$ref" : "https://ns.adobe.com/xdm/datatypes/transaction", - "description" : "Extension of Transaction Data Type" + "xdm:applicationFee": { + "title": "Application Fee", + "$ref": "https://ns.adobe.com/xdm/datatypes/transaction", + "description": "Extension of Transaction Data Type" }, - "xdm:ID" : { - "title" : "ID", - "type" : "string", - "description" : "Identifier used during an application process." + "xdm:ID": { + "title": "ID", + "type": "string", + "description": "Identifier used during an application process." }, - "xdm:requestedAmount" : { - "title" : "Requested Amount", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "Tracks the monetary value of the application." + "xdm:requestedAmount": { + "title": "Requested Amount", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "Tracks the monetary value of the application." }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "enum" : [ "initiated", "in progress", "approved", "declined" ], - "description" : "Captures the status of the application for any given point in the application process." + "xdm:status": { + "title": "Status", + "type": "string", + "enum": ["initiated", "in progress", "approved", "declined"], + "description": "Captures the status of the application for any given point in the application process." }, - "xdm:statusUpdate" : { - "title" : "Status Update", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Captured when the status for an application changes, either from an online or offline update." + "xdm:statusUpdate": { + "title": "Status Update", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Captured when the status for an application changes, either from an online or offline update." }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "Type of the application process." + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Type of the application process." }, - "xdm:underReview" : { - "title" : "Under Review", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Captured when a visitor application has been placed under review." + "xdm:underReview": { + "title": "Under Review", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Captured when a visitor application has been placed under review." }, - "xdm:steps" : { - "title" : "steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type.", - "meta:status" : "deprecated" + "xdm:steps": { + "title": "steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type.", + "meta:status": "deprecated" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/form-applications" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/form-applications" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/implementationdetails.schema.json b/components/datatypes/industry-verticals/implementationdetails.schema.json index b18010842..c569883bb 100644 --- a/components/datatypes/industry-verticals/implementationdetails.schema.json +++ b/components/datatypes/industry-verticals/implementationdetails.schema.json @@ -1,54 +1,62 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/implementationdetails", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Implementation details", - "type" : "object", - "meta:extensible" : true, - "meta:status" : "stable", - "description" : "Details about the SDK, library, or service used in an application or web page implementation of a service.", - "definitions" : { - "implementationdetails" : { - "properties" : { - "xdm:name" : { - "title" : "Name", - "type" : "string", - "format" : "uri", - "description" : "SDK or endpoint identifier. All SDKs or endpoints are identified through a URI, including extensions.", - "meta:enum" : { - "https://ns.adobe.com/experience/analytics/scode" : "Adobe Analytics sCode", - "https://ns.adobe.com/experience/analytics/appmeasurement" : "Adobe app measurement", - "https://ns.adobe.com/experience/analytics/mbox" : "Adobe Target mBox", - "https://ns.adobe.com/experience/visitorapi" : "Adobe Visitor service", - "https://ns.adobe.com/experience/adcloud/viewability" : "Adobe Advertising Cloud viewability", - "https://ns.adobe.com/experience/alloy" : "Adobe Experience Platform Web SDK", - "https://ns.adobe.com/experience/alloy/reactor" : "Adobe Experience Platform Web SDK Launch Extension" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/implementationdetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Implementation details", + "type": "object", + "meta:extensible": true, + "meta:status": "stable", + "description": "Details about the SDK, library, or service used in an application or web page implementation of a service.", + "definitions": { + "implementationdetails": { + "properties": { + "xdm:name": { + "title": "Name", + "type": "string", + "format": "uri", + "description": "SDK or endpoint identifier. All SDKs or endpoints are identified through a URI, including extensions.", + "meta:enum": { + "https://ns.adobe.com/experience/analytics/scode": "Adobe Analytics sCode", + "https://ns.adobe.com/experience/analytics/appmeasurement": "Adobe app measurement", + "https://ns.adobe.com/experience/analytics/mbox": "Adobe Target mBox", + "https://ns.adobe.com/experience/visitorapi": "Adobe Visitor service", + "https://ns.adobe.com/experience/adcloud/viewability": "Adobe Advertising Cloud viewability", + "https://ns.adobe.com/experience/alloy": "Adobe Experience Platform Web SDK", + "https://ns.adobe.com/experience/alloy/reactor": "Adobe Experience Platform Web SDK Launch Extension" } }, - "xdm:version" : { - "title" : "Version", - "type" : "string", - "description" : "The version identifier of the API, e.g h.18." + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The version identifier of the API, e.g h.18." }, - "xdm:environment" : { - "title" : "Environment", - "type" : "string", - "description" : "The environment of the implementation", - "enum" : [ "browser", "app", "server", "iot" ], - "meta:enum" : { - "browser" : "Web Browser", - "app" : "Application", - "server" : "Server", - "iot" : "Internet of Things Device" + "xdm:environment": { + "title": "Environment", + "type": "string", + "description": "The environment of the implementation", + "enum": ["browser", "app", "server", "iot"], + "meta:enum": { + "browser": "Web Browser", + "app": "Application", + "server": "Server", + "iot": "Internet of Things Device" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/implementationdetails" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/implementationdetails" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/impressions.schema.json b/components/datatypes/industry-verticals/impressions.schema.json index 719dd1ed7..828fd4cbd 100644 --- a/components/datatypes/industry-verticals/impressions.schema.json +++ b/components/datatypes/industry-verticals/impressions.schema.json @@ -1,40 +1,47 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/impressions", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Impressions", - "type" : "object", - "meta:extensible" : true, - "description" : "Tracks when impressions are presented on a site, along with names, types, and counts.", - "definitions" : { - "impressions" : { - "properties" : { - "xdm:displays" : { - "title" : "Displays", - "type" : "integer", - "description" : "Counts the number of times an impression item has been displayed to a visitor." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/impressions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Impressions", + "type": "object", + "meta:extensible": true, + "description": "Tracks when impressions are presented on a site, along with names, types, and counts.", + "definitions": { + "impressions": { + "properties": { + "xdm:displays": { + "title": "Displays", + "type": "integer", + "description": "Counts the number of times an impression item has been displayed to a visitor." }, - "xdm:ID" : { - "title" : "ID", - "type" : "string", - "description" : "Tracks the ID of an item in an impression array." + "xdm:ID": { + "title": "ID", + "type": "string", + "description": "Tracks the ID of an item in an impression array." }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "Tracks the type of impression in an impression array." + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Tracks the type of impression in an impression array." }, - "xdm:selected" : { - "title" : "Selected", - "type" : "integer", - "description" : "Tracks when a given item in an impression array has been selected or clicked." + "xdm:selected": { + "title": "Selected", + "type": "integer", + "description": "Tracks when a given item in an impression array has been selected or clicked." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/impressions" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/impressions" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/internal-site-search.schema.json b/components/datatypes/industry-verticals/internal-site-search.schema.json index db99b0f71..398f25ad3 100644 --- a/components/datatypes/industry-verticals/internal-site-search.schema.json +++ b/components/datatypes/industry-verticals/internal-site-search.schema.json @@ -1,126 +1,141 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/internal-site-search", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Internal Site Search", - "type" : "object", - "meta:extensible" : true, - "description" : "Used for internal site searches and includes all related search behaviors and details.", - "definitions" : { - "internal-site-search" : { - "properties" : { - "xdm:numberOfResults" : { - "title" : "Number of Results", - "type" : "integer", - "description" : "Count of the total number of search results returned." - }, - "xdm:productFindingMethods" : { - "title" : "Product Finding Method", - "type" : "string", - "description" : "The internal site search term value with merchandising binding. Will show what term was searched for immediately before viewing a product." - }, - "xdm:refinementValue" : { - "title" : "Refinement Value", - "type" : "string", - "description" : "Number of times an internal site search refinement has occurred." - }, - "xdm:refinementType" : { - "title" : "Refinement Type", - "type" : "array", - "items" : { - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/internal-site-search", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Internal Site Search", + "type": "object", + "meta:extensible": true, + "description": "Used for internal site searches and includes all related search behaviors and details.", + "definitions": { + "internal-site-search": { + "properties": { + "xdm:numberOfResults": { + "title": "Number of Results", + "type": "integer", + "description": "Count of the total number of search results returned." + }, + "xdm:productFindingMethods": { + "title": "Product Finding Method", + "type": "string", + "description": "The internal site search term value with merchandising binding. Will show what term was searched for immediately before viewing a product." + }, + "xdm:refinementValue": { + "title": "Refinement Value", + "type": "string", + "description": "Number of times an internal site search refinement has occurred." + }, + "xdm:refinementType": { + "title": "Refinement Type", + "type": "array", + "items": { + "type": "string" }, - "description" : "Captures the refinement type(s) applied to the search results (i.e. department, brand, price, in-store, review rating, color, material, etc.)" - }, - "xdm:refinementInstances" : { - "title" : "Refinement Instances", - "type" : "integer", - "description" : "Captures when a search refinement action occurs." - }, - "xdm:resultsPageNumber" : { - "title" : "Results Page Number", - "type" : "integer", - "description" : "For paginated search results, tracks the page of results the visitor is viewing." - }, - "xdm:resultsPerPage" : { - "title" : "Results Per Page", - "type" : "integer", - "description" : "For paginated search results, tracks the number of search results displayed per page." - }, - "xdm:instances" : { - "title" : "Instances", - "type" : "integer", - "description" : "Number of times an internal site search has occurred." - }, - "xdm:locationInPage" : { - "title" : "Location in Page", - "type" : "string", - "description" : "When multiple search boxes exist on the page, this value should be used to identify the specific location the user used to search" - }, - "xdm:nullInstances" : { - "title" : "Null Instances", - "type" : "integer", - "description" : "Number of times an internal site search has occurred that provided zero results." - }, - "xdm:postalCode" : { - "title" : "Postal Code", - "type" : "string", - "description" : "Captures the zip code used for a search, if applicable" - }, - "xdm:radiusDistance" : { - "title" : "Radius Distance", - "type" : "integer", - "description" : "Captures the selected distance of the search radius." - }, - "xdm:radiusType" : { - "title" : "Radius Type", - "type" : "string", - "enum" : [ "miles", "kilometers" ], - "description" : "Captures the selected distance type of the search radius in either miles or kilometers." - }, - "xdm:term" : { - "title" : "Term", - "type" : "string", - "description" : "Tracks the internal site search term entered by the visitor." - }, - "xdm:autoCompleteClicked" : { - "title" : "Auto Complete Clicked", - "type" : "boolean", - "description" : "Indicates when a visitor uses a suggested/autocompleted search value to execute the search" - }, - "xdm:autoCompleteValue" : { - "title" : "Auto Complete Value", - "type" : "string", - "description" : "For autocomplete scenarios, users sometimes abandon their search and click a specific term from the drop down. This value is used to track the specific terms clicked" - }, - "xdm:autoCompleteTypedValue" : { - "title" : "Auto Complete Typed Value", - "type" : "string", - "description" : "For autocomplete scenarios, users sometimes abandon their search and click a specific term from the drop down. This value tracks what the user started to type in order to generate the specific set of suggested search terms" - }, - "xdm:searchType" : { - "title" : "Search Type", - "type" : "string", - "description" : "Captures the method of search being executed, if applicable. Examples could include a type-ahead search, directly-typed search, or any other type of custom search functionality a site might have." - }, - "xdm:sortOrder" : { - "title" : "Sort Order", - "type" : "string", - "enum" : [ "ascending", "descending" ], - "description" : "ascending/descending" - }, - "xdm:sortType" : { - "title" : "Sort Type", - "type" : "string", - "enum" : [ "price: low to high", "price: high to low", "featured", "best match", "average customer review", "discount", "new items" ], - "description" : "Captures the type of sort applied to search results, i.e. best match, price, rating, etc." + "description": "Captures the refinement type(s) applied to the search results (i.e. department, brand, price, in-store, review rating, color, material, etc.)" + }, + "xdm:refinementInstances": { + "title": "Refinement Instances", + "type": "integer", + "description": "Captures when a search refinement action occurs." + }, + "xdm:resultsPageNumber": { + "title": "Results Page Number", + "type": "integer", + "description": "For paginated search results, tracks the page of results the visitor is viewing." + }, + "xdm:resultsPerPage": { + "title": "Results Per Page", + "type": "integer", + "description": "For paginated search results, tracks the number of search results displayed per page." + }, + "xdm:instances": { + "title": "Instances", + "type": "integer", + "description": "Number of times an internal site search has occurred." + }, + "xdm:locationInPage": { + "title": "Location in Page", + "type": "string", + "description": "When multiple search boxes exist on the page, this value should be used to identify the specific location the user used to search" + }, + "xdm:nullInstances": { + "title": "Null Instances", + "type": "integer", + "description": "Number of times an internal site search has occurred that provided zero results." + }, + "xdm:postalCode": { + "title": "Postal Code", + "type": "string", + "description": "Captures the zip code used for a search, if applicable" + }, + "xdm:radiusDistance": { + "title": "Radius Distance", + "type": "integer", + "description": "Captures the selected distance of the search radius." + }, + "xdm:radiusType": { + "title": "Radius Type", + "type": "string", + "enum": ["miles", "kilometers"], + "description": "Captures the selected distance type of the search radius in either miles or kilometers." + }, + "xdm:term": { + "title": "Term", + "type": "string", + "description": "Tracks the internal site search term entered by the visitor." + }, + "xdm:autoCompleteClicked": { + "title": "Auto Complete Clicked", + "type": "boolean", + "description": "Indicates when a visitor uses a suggested/autocompleted search value to execute the search" + }, + "xdm:autoCompleteValue": { + "title": "Auto Complete Value", + "type": "string", + "description": "For autocomplete scenarios, users sometimes abandon their search and click a specific term from the drop down. This value is used to track the specific terms clicked" + }, + "xdm:autoCompleteTypedValue": { + "title": "Auto Complete Typed Value", + "type": "string", + "description": "For autocomplete scenarios, users sometimes abandon their search and click a specific term from the drop down. This value tracks what the user started to type in order to generate the specific set of suggested search terms" + }, + "xdm:searchType": { + "title": "Search Type", + "type": "string", + "description": "Captures the method of search being executed, if applicable. Examples could include a type-ahead search, directly-typed search, or any other type of custom search functionality a site might have." + }, + "xdm:sortOrder": { + "title": "Sort Order", + "type": "string", + "enum": ["ascending", "descending"], + "description": "ascending/descending" + }, + "xdm:sortType": { + "title": "Sort Type", + "type": "string", + "enum": [ + "price: low to high", + "price: high to low", + "featured", + "best match", + "average customer review", + "discount", + "new items" + ], + "description": "Captures the type of sort applied to search results, i.e. best match, price, rating, etc." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/internal-site-search" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/internal-site-search" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/policy-details.schema.json b/components/datatypes/industry-verticals/policy-details.schema.json index ccbb6e2a0..c4cd910bf 100644 --- a/components/datatypes/industry-verticals/policy-details.schema.json +++ b/components/datatypes/industry-verticals/policy-details.schema.json @@ -1,76 +1,83 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/policy-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Policy Details", - "type" : "object", - "meta:extensible" : true, - "description" : "Details for the insurance policy such as type, start date, and ID.", - "definitions" : { - "policy-details" : { - "properties" : { - "xdm:endDate" : { - "title" : "End Date", - "type" : "string", - "format" : "date-time", - "description" : "Date which the insurance policy coverage ended." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/policy-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Policy Details", + "type": "object", + "meta:extensible": true, + "description": "Details for the insurance policy such as type, start date, and ID.", + "definitions": { + "policy-details": { + "properties": { + "xdm:endDate": { + "title": "End Date", + "type": "string", + "format": "date-time", + "description": "Date which the insurance policy coverage ended." }, - "xdm:ID" : { - "title" : "ID", - "type" : "string", - "description" : "Unique insurance policy identifier." + "xdm:ID": { + "title": "ID", + "type": "string", + "description": "Unique insurance policy identifier." }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "Insurance policy name." + "xdm:name": { + "title": "Name", + "type": "string", + "description": "Insurance policy name." }, - "xdm:startDate" : { - "title" : "Start Date", - "type" : "string", - "format" : "date-time", - "description" : "Date which the insurance policy coverage started." + "xdm:startDate": { + "title": "Start Date", + "type": "string", + "format": "date-time", + "description": "Date which the insurance policy coverage started." }, - "xdm:location" : { - "title" : "Location", - "$ref" : "https://ns.adobe.com/xdm/common/address", - "description" : "Location in which the insurance policy is issued." + "xdm:location": { + "title": "Location", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "Location in which the insurance policy is issued." }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "enum" : [ "home", "automobile", "renter", "boat" ], - "description" : "Type of insurance policy, such as home, automobile, renter, or boat." + "xdm:type": { + "title": "Type", + "type": "string", + "enum": ["home", "automobile", "renter", "boat"], + "description": "Type of insurance policy, such as home, automobile, renter, or boat." }, - "xdm:assignedBeneficiary" : { - "title" : "Assigned Beneficiaries", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/profile-person-details" + "xdm:assignedBeneficiary": { + "title": "Assigned Beneficiaries", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/profile-person-details" }, - "description" : "Captures the beneficiary(s) assigned to the policy." + "description": "Captures the beneficiary(s) assigned to the policy." }, - "xdm:hasAssignedBeneficiary" : { - "title" : "Has Assigned Beneficiary", - "type" : "boolean", - "description" : "Flag determining if the account has a beneficiary assigned." + "xdm:hasAssignedBeneficiary": { + "title": "Has Assigned Beneficiary", + "type": "boolean", + "description": "Flag determining if the account has a beneficiary assigned." }, - "xdm:owner" : { - "title" : "Owner", - "$ref" : "https://ns.adobe.com/xdm/context/profile-personal-details", - "description" : "Stores the policyholder's profile information. Extension of the personal profile details data type." + "xdm:owner": { + "title": "Owner", + "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details", + "description": "Stores the policyholder's profile information. Extension of the personal profile details data type." }, - "xdm:benefitAmount" : { - "title" : "Benefit Amount", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "The amount to be paid per the policy terms." + "xdm:benefitAmount": { + "title": "Benefit Amount", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "The amount to be paid per the policy terms." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/policy-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/policy-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/selfservice.schema.json b/components/datatypes/industry-verticals/selfservice.schema.json index bfb09ccb3..970de3d84 100644 --- a/components/datatypes/industry-verticals/selfservice.schema.json +++ b/components/datatypes/industry-verticals/selfservice.schema.json @@ -1,140 +1,147 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$schema" : "http://json-schema.org/draft-06/schema#", - "$id" : "https://ns.adobe.com/xdm/common/selfservice", - "title" : "Customer Managed Environment", - "description" : "A customer managed environment is an environment that allows a system integration or deployer to manage applications. This is also known as self service.", - "type" : "object", - "definitions" : { - "selfservice" : { - "properties" : { - "xdm:tenant" : { - "name" : "Tenant", - "description" : "A description of a customer having a agreement to use a specific set of services (see `xdm:service`). A tenant will typically have a URI which can be used to reference the tenant, and should be resolvable by an identity provider.", - "type" : "string", - "format" : "uri" - }, - "xdm:applicationOwner" : { - "name" : "Application Owner", - "description" : "An application owner, distinct from a tenant (`xdm:tenant`), owns an application (see `xdm:application`) and manages its state. The application owner may be a individual user or roll. Typically the application owner will be a member of the tenant, however that is not a requirement.", - "type" : "string", - "format" : "uri" - }, - "xdm:application" : { - "name" : "Application", - "description" : "A set of code, content, and data that together implement an experience. Some applications do not allow a system integrator, partner or customer to perform customization. Other applications may allow customization on a per instance basis. These may be applications managed by the system integrator, partner or customer. An application be defined by a URI referencing the definition of the application.", - "type" : "string", - "format" : "uri" - }, - "xdm:environment" : { - "name" : "Environment", - "description" : "A tenant (see `xdm:tenant`) may work with 1..n environments where the application (see `xdm:application`) runs. Each environment serves a purpose in the CI/CD chain providing a structure whereby changes to the application can be rolled out. Typically the owner of the application manages transitions between environments. A system integrator, partner or customer may be the owner of the application especially where the application has been extended and customized. An environment may have a URI referencing the definition of the environment. ", - "type" : "string", - "meta:enum" : { - "dev" : "A development environment for engineering teams to develop and test against prior to releasing to the QE teams.", - "qe" : "A deployment provisioned to satisfy the quality engineering process.", - "stage" : "A final deployment environment before production. Typically used to perform final testing and give a reference deployment to the last production deployment.", - "beta" : "A production deployment environment used to introduce end-users of the `application` to new features.", - "prod" : "The production deployment environment." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/selfservice", + "title": "Customer Managed Environment", + "description": "A customer managed environment is an environment that allows a system integration or deployer to manage applications. This is also known as self service.", + "type": "object", + "definitions": { + "selfservice": { + "properties": { + "xdm:tenant": { + "name": "Tenant", + "description": "A description of a customer having a agreement to use a specific set of services (see `xdm:service`). A tenant will typically have a URI which can be used to reference the tenant, and should be resolvable by an identity provider.", + "type": "string", + "format": "uri" + }, + "xdm:applicationOwner": { + "name": "Application Owner", + "description": "An application owner, distinct from a tenant (`xdm:tenant`), owns an application (see `xdm:application`) and manages its state. The application owner may be a individual user or roll. Typically the application owner will be a member of the tenant, however that is not a requirement.", + "type": "string", + "format": "uri" + }, + "xdm:application": { + "name": "Application", + "description": "A set of code, content, and data that together implement an experience. Some applications do not allow a system integrator, partner or customer to perform customization. Other applications may allow customization on a per instance basis. These may be applications managed by the system integrator, partner or customer. An application be defined by a URI referencing the definition of the application.", + "type": "string", + "format": "uri" + }, + "xdm:environment": { + "name": "Environment", + "description": "A tenant (see `xdm:tenant`) may work with 1..n environments where the application (see `xdm:application`) runs. Each environment serves a purpose in the CI/CD chain providing a structure whereby changes to the application can be rolled out. Typically the owner of the application manages transitions between environments. A system integrator, partner or customer may be the owner of the application especially where the application has been extended and customized. An environment may have a URI referencing the definition of the environment. ", + "type": "string", + "meta:enum": { + "dev": "A development environment for engineering teams to develop and test against prior to releasing to the QE teams.", + "qe": "A deployment provisioned to satisfy the quality engineering process.", + "stage": "A final deployment environment before production. Typically used to perform final testing and give a reference deployment to the last production deployment.", + "beta": "A production deployment environment used to introduce end-users of the `application` to new features.", + "prod": "The production deployment environment." } }, - "xdm:cluster" : { - "name" : "Cluster", - "description" : "A group of instances deployed within a environment (see `xdm:environment` ) as part of a topology (see `xdm:topology`) that deliver a service within an application (see `xdm:application`) often using a single source of persistence. A topology may have one or more clusters (see `xdm:cluster`). A service (see `xdm:service`) is typically delivered by a single cluster. Members of the cluster are typically stateless and disposable, meaning they are created and destroyed to maintain a suitable cluster size to deliver the service against the agreed SLA. A cluster will have a URI referencing the definition of the cluster, including parameters defining its scaling behavior.", - "type" : "string", - "format" : "uri" - }, - "xdm:CICDPipeline" : { - "name" : "CI/CD Pipeline", - "description" : "A continuous deployment continuous integration pipeline (xdm:CICDPipeline) is used to deploy an application (see `xdm:application`) conforming to a defined topology (see `xdm:topology`) into an environment (see `xdm:environment`). The pipeline runs a standard process that understands the defining of the topology, environment and application. The pipeline is a shared resource used by many applications and tenants (see `xdm:tenant`), although special tenants may have customized pipelines. A pipeline will have a URI which defines the API.", - "type" : "string", - "format" : "uri" - }, - "xdm:service" : { - "name" : "Service", - "description" : "An application (see `xdm:application`) consists of one or more services, deployed into a topology (see `xdm:topology`) and implemented as a cluster (see `xdm:cluster`). The service will generally expose an API to consumers however that service may be private to the application. The implementation of a service my be changed without changing the specification of the service. A service will have a URI defining it.", - "type" : "string", - "format" : "uri" - }, - "xdm:topology" : { - "name" : "Topology", - "description" : "A topology is a logical group of services (see `xdm:service`) and their implementations that together form an application (see `xdm:application`). The topology may consist of services and service implementations at different layers throughout an application. Some services within a topology may be satisfied by shared components, for instance many applications may share an edge traffic load balancer. A service will have a URI defining it.", - "type" : "string", - "format" : "uri" - }, - "xdm:codeRepository" : { - "name" : "Code Repository", - "description" : "A code repository stores the application (see `xdm:application`) code and any definitions for topologies (see `xdm:topology`), services (see `xdm:service`), clusters (see `xdm:cluster`) and environments (see `(see `xdm:environment`). The CI/CD Pipeline (see `xdm:CICDPipeline`) will read the Code repository to perform integration and deploy the application.", - "type" : "string", - "format" : "uri" - }, - "xdm:provisioning" : { - "name" : "Provisioning", - "description" : "Provisioning is the operation which sets up everything required to allow a tenant (see `xdm:tenant`) to deploy an application (see `xdm:application`). This includes setting up the Code Repository (see `xdm:codeRepository`), and allocating any resources that the CI/CD pipeline (see `xdm:CICDPipeline`) might require to deploy the application. Provisioning will ensure that any costs or charges are appropriately registered as being related to the tenant so that billing systems can ensure the tenant is billed. Where the infrastructure is dedicated to the tenant, provisioning will ensure that sufficient infrastructure is available when the first deployment (see `xdm:deployment`) is being performed. If the infrastructure is to be provisioned from a pool, provisioning will ensure that the pool is notified of the level of future demand. Provisioning will understand any legal or jurisdictional requirements and constraints that the tenant may have expressed in the contract and ensure that those requirements and constraints are satisfied.", - "type" : "string", - "format" : "uri" - }, - "xdm:deployment" : { - "name" : "Deployment", - "description" : "Deployment is the final act of deploying an application (see `xdm:application`) into an environment (see `xdm:environment`) prior to going live in that environment. This should be achieved via an automated process working from specification and configuration stored in the codeRepository (see `xdm:codeRepository`). Some applications may require the installation of packages directly into a service (see `xdm:service`) or API provided by the application. Where this is the case the deployment process must be capable of supporting that style of deployment and must not make the application or any of its parts available to serve requests while the deployment is incomplete. The deployment process should include steps to validate that the deployment was successful. Deployment is not the same as provisioning (see `xdm:provisioning`), which is a pre-requisite for deployment. Typically a deployment will be performed every time changes in the code repository needs to be made available in the environment` Typically the deployment process is implemented by the CICDPipeline (see `xdm:CICDPipeline`).", - "type" : "string", - "format" : "uri" - }, - "xdm:artifact" : { - "name" : "Artifact", - "description" : "An artifact is a package forming the implementation of a service (see `xdm:service`). It is is stored in the artifactRepository (see `xdm:artifactRepository`) published to the artifactRepository by the CICDPipeline (see `xdm:CICDPipeline`). An artifact has a version. Once an artifact with a version is published it becomes immutable. A version may be a unique string such as a SHA identifying a commit in a Git repository, or a semantic version number. Which is chosen depends on the preferred versioning mechanism.", - "type" : "string", - "format" : "uri" - }, - "xdm:artifactRepository" : { - "name" : "Artifact Repository", - "description" : "An artifact repository stores released binaries including artifacts (see `xdm:artifact`) either from vendors or created by the CICDPipeline (see `xdm:CICDPipeline`). These artifacts are used by the deployment pipeline to deploy an application (see `xdm:application`) into an environment (see `xdm:environment`). The artifactRepository will allow many versions of an artifact to exist and will be organized in a way that will allow artifacts specific to a tenant (see `xdm:tenant`), application, topology (see `xdm:topology`) and environment to be stored. The artifact repository must not be used to store any sensitive data.", - "type" : "string", - "format" : "uri" - }, - "xdm:selfServiceAPI" : { - "name" : "Self Service API", - "description" : "The self service API is a well defined API that will, using the model defined in XDM expose to a suitably authorized client a service implementation that allows that client to one or more applications (see `xdm:application`) within a tenant (see `xdm:tenant`). The API must maintain tenant boundaries, as defined and controlled by an identity provider.", - "type" : "string", - "format" : "uri" - }, - "xdm:selfServiceUI" : { - "name" : "Self Service UI", - "description" : "A user interface or portal containing all the functionality of the selfServiceAPI (see `xdm:selfServiceAPI`) presented for use by a human in a web browser interface. Typically this UI will use the selfServiceAPI and be implemented as a browser application or SPA.", - "type" : "string", - "format" : "uri" - }, - "xdm:selfServiceBuild" : { - "name" : "Build", - "description" : "The process by which the CICDPipeline (see `xdm:CICDPipeline`) creates a artifact (see `xdm:artifact`). How the build is performed and what the build creates depends on the source code stored in the codeRepository , which will also contain instructions to perform the build. In the case of a java artifact, the build would typically be performed by maven or gradle. In the case of a docker image, the build might be performed by make.", - "type" : "string", - "format" : "uri" - }, - "xdm:runningInstance" : { - "name" : "Instance", - "description" : "An instance is 1 copy of a service (see `xdm:service`) implementation running within a cluster (see `xdm:cluster`) within a topology (see `xdm:topology`) deployed to an environment (see `xdm:environment`) as an application (see `xdm:application`) for a tenant (see `xdm:tenant`). Where the application is a java application, deployed to a provisioned virtual machine, the instance will be the java process, however where the application has been deployed as part of a container based application the instance will be the running container.", - "type" : "string", - "format" : "uri" - }, - "xdm:qualityGateState" : { - "name" : "Quality Gate", - "description" : "The customer CICDPipeline (see `xdm:CICDPipeline`) defines a number of quality gates that will determine the success or fail of the entire process. If any Pass property being false indicates the quality gate has failed.", - "type" : "object", - "properties" : { - "*Pass" : { - "type" : "boolean", - "name" : "*Pass", - "description" : "A quality gate test, false means it failed, true means it passed." + "xdm:cluster": { + "name": "Cluster", + "description": "A group of instances deployed within a environment (see `xdm:environment` ) as part of a topology (see `xdm:topology`) that deliver a service within an application (see `xdm:application`) often using a single source of persistence. A topology may have one or more clusters (see `xdm:cluster`). A service (see `xdm:service`) is typically delivered by a single cluster. Members of the cluster are typically stateless and disposable, meaning they are created and destroyed to maintain a suitable cluster size to deliver the service against the agreed SLA. A cluster will have a URI referencing the definition of the cluster, including parameters defining its scaling behavior.", + "type": "string", + "format": "uri" + }, + "xdm:CICDPipeline": { + "name": "CI/CD Pipeline", + "description": "A continuous deployment continuous integration pipeline (xdm:CICDPipeline) is used to deploy an application (see `xdm:application`) conforming to a defined topology (see `xdm:topology`) into an environment (see `xdm:environment`). The pipeline runs a standard process that understands the defining of the topology, environment and application. The pipeline is a shared resource used by many applications and tenants (see `xdm:tenant`), although special tenants may have customized pipelines. A pipeline will have a URI which defines the API.", + "type": "string", + "format": "uri" + }, + "xdm:service": { + "name": "Service", + "description": "An application (see `xdm:application`) consists of one or more services, deployed into a topology (see `xdm:topology`) and implemented as a cluster (see `xdm:cluster`). The service will generally expose an API to consumers however that service may be private to the application. The implementation of a service my be changed without changing the specification of the service. A service will have a URI defining it.", + "type": "string", + "format": "uri" + }, + "xdm:topology": { + "name": "Topology", + "description": "A topology is a logical group of services (see `xdm:service`) and their implementations that together form an application (see `xdm:application`). The topology may consist of services and service implementations at different layers throughout an application. Some services within a topology may be satisfied by shared components, for instance many applications may share an edge traffic load balancer. A service will have a URI defining it.", + "type": "string", + "format": "uri" + }, + "xdm:codeRepository": { + "name": "Code Repository", + "description": "A code repository stores the application (see `xdm:application`) code and any definitions for topologies (see `xdm:topology`), services (see `xdm:service`), clusters (see `xdm:cluster`) and environments (see `(see `xdm:environment`). The CI/CD Pipeline (see `xdm:CICDPipeline`) will read the Code repository to perform integration and deploy the application.", + "type": "string", + "format": "uri" + }, + "xdm:provisioning": { + "name": "Provisioning", + "description": "Provisioning is the operation which sets up everything required to allow a tenant (see `xdm:tenant`) to deploy an application (see `xdm:application`). This includes setting up the Code Repository (see `xdm:codeRepository`), and allocating any resources that the CI/CD pipeline (see `xdm:CICDPipeline`) might require to deploy the application. Provisioning will ensure that any costs or charges are appropriately registered as being related to the tenant so that billing systems can ensure the tenant is billed. Where the infrastructure is dedicated to the tenant, provisioning will ensure that sufficient infrastructure is available when the first deployment (see `xdm:deployment`) is being performed. If the infrastructure is to be provisioned from a pool, provisioning will ensure that the pool is notified of the level of future demand. Provisioning will understand any legal or jurisdictional requirements and constraints that the tenant may have expressed in the contract and ensure that those requirements and constraints are satisfied.", + "type": "string", + "format": "uri" + }, + "xdm:deployment": { + "name": "Deployment", + "description": "Deployment is the final act of deploying an application (see `xdm:application`) into an environment (see `xdm:environment`) prior to going live in that environment. This should be achieved via an automated process working from specification and configuration stored in the codeRepository (see `xdm:codeRepository`). Some applications may require the installation of packages directly into a service (see `xdm:service`) or API provided by the application. Where this is the case the deployment process must be capable of supporting that style of deployment and must not make the application or any of its parts available to serve requests while the deployment is incomplete. The deployment process should include steps to validate that the deployment was successful. Deployment is not the same as provisioning (see `xdm:provisioning`), which is a pre-requisite for deployment. Typically a deployment will be performed every time changes in the code repository needs to be made available in the environment` Typically the deployment process is implemented by the CICDPipeline (see `xdm:CICDPipeline`).", + "type": "string", + "format": "uri" + }, + "xdm:artifact": { + "name": "Artifact", + "description": "An artifact is a package forming the implementation of a service (see `xdm:service`). It is is stored in the artifactRepository (see `xdm:artifactRepository`) published to the artifactRepository by the CICDPipeline (see `xdm:CICDPipeline`). An artifact has a version. Once an artifact with a version is published it becomes immutable. A version may be a unique string such as a SHA identifying a commit in a Git repository, or a semantic version number. Which is chosen depends on the preferred versioning mechanism.", + "type": "string", + "format": "uri" + }, + "xdm:artifactRepository": { + "name": "Artifact Repository", + "description": "An artifact repository stores released binaries including artifacts (see `xdm:artifact`) either from vendors or created by the CICDPipeline (see `xdm:CICDPipeline`). These artifacts are used by the deployment pipeline to deploy an application (see `xdm:application`) into an environment (see `xdm:environment`). The artifactRepository will allow many versions of an artifact to exist and will be organized in a way that will allow artifacts specific to a tenant (see `xdm:tenant`), application, topology (see `xdm:topology`) and environment to be stored. The artifact repository must not be used to store any sensitive data.", + "type": "string", + "format": "uri" + }, + "xdm:selfServiceAPI": { + "name": "Self Service API", + "description": "The self service API is a well defined API that will, using the model defined in XDM expose to a suitably authorized client a service implementation that allows that client to one or more applications (see `xdm:application`) within a tenant (see `xdm:tenant`). The API must maintain tenant boundaries, as defined and controlled by an identity provider.", + "type": "string", + "format": "uri" + }, + "xdm:selfServiceUI": { + "name": "Self Service UI", + "description": "A user interface or portal containing all the functionality of the selfServiceAPI (see `xdm:selfServiceAPI`) presented for use by a human in a web browser interface. Typically this UI will use the selfServiceAPI and be implemented as a browser application or SPA.", + "type": "string", + "format": "uri" + }, + "xdm:selfServiceBuild": { + "name": "Build", + "description": "The process by which the CICDPipeline (see `xdm:CICDPipeline`) creates a artifact (see `xdm:artifact`). How the build is performed and what the build creates depends on the source code stored in the codeRepository , which will also contain instructions to perform the build. In the case of a java artifact, the build would typically be performed by maven or gradle. In the case of a docker image, the build might be performed by make.", + "type": "string", + "format": "uri" + }, + "xdm:runningInstance": { + "name": "Instance", + "description": "An instance is 1 copy of a service (see `xdm:service`) implementation running within a cluster (see `xdm:cluster`) within a topology (see `xdm:topology`) deployed to an environment (see `xdm:environment`) as an application (see `xdm:application`) for a tenant (see `xdm:tenant`). Where the application is a java application, deployed to a provisioned virtual machine, the instance will be the java process, however where the application has been deployed as part of a container based application the instance will be the running container.", + "type": "string", + "format": "uri" + }, + "xdm:qualityGateState": { + "name": "Quality Gate", + "description": "The customer CICDPipeline (see `xdm:CICDPipeline`) defines a number of quality gates that will determine the success or fail of the entire process. If any Pass property being false indicates the quality gate has failed.", + "type": "object", + "properties": { + "*Pass": { + "type": "boolean", + "name": "*Pass", + "description": "A quality gate test, false means it failed, true means it passed." } } } }, - "required" : [ "xdm:tenant", "xdm:application", "xdm:environment" ] + "required": ["xdm:tenant", "xdm:application", "xdm:environment"] } }, - "allOf" : [ { - "$ref" : "#/definitions/selfservice" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/selfservice" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/subscription.schema.json b/components/datatypes/industry-verticals/subscription.schema.json index 4f1665f05..6c0964ec4 100644 --- a/components/datatypes/industry-verticals/subscription.schema.json +++ b/components/datatypes/industry-verticals/subscription.schema.json @@ -1,150 +1,158 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/subscription", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Subscription", - "type" : "object", - "meta:extensible" : true, - "description" : "Subscriptions are licensed entitlements to software, services, or goods that are utilized in a time or usage based way.", - "definitions" : { - "subscription" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "description" : "Unique identifier for the subscription instance." - }, - "xdm:subscriber" : { - "title" : "Subscriber", - "$ref" : "https://ns.adobe.com/xdm/context/person", - "description" : "The owner of the subscription." - }, - "xdm:device" : { - "title" : "Device", - "$ref" : "https://ns.adobe.com/xdm/context/device", - "description" : "The device linked to the subscription." - }, - "xdm:environment" : { - "title" : "Environment", - "$ref" : "https://ns.adobe.com/xdm/context/environment", - "description" : "Environment of the subscription. This can be either then known environment at the time of the subscription or the environment of the application for subscriptions related to an application." - }, - "xdm:SKU" : { - "title" : "SKU", - "type" : "string", - "description" : "Stock keeping unit (SKU), a generally unique identifier for a product." - }, - "xdm:planName" : { - "title" : "Plan name", - "type" : "string", - "description" : "The human readable name for the subscription." - }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "The scope of entitlement in relation to how many people are covered by the subscription." - }, - "xdm:country" : { - "title" : "Country", - "type" : "string", - "description" : "The country that the subscription contractual and agreement terms are rooted in." - }, - "xdm:startDate" : { - "title" : "Start date", - "type" : "string", - "format" : "date", - "description" : "The date the subscription begins." - }, - "xdm:endDate" : { - "title" : "End date", - "type" : "string", - "format" : "date", - "description" : "The date the current subscription term ends." - }, - "xdm:term" : { - "title" : "Term", - "type" : "integer", - "description" : "The numeric value of the term." - }, - "xdm:termUnitOfTime" : { - "title" : "Term unit of time", - "type" : "string", - "description" : "The unit of time for the term period." - }, - "xdm:renew" : { - "title" : "Renew", - "type" : "string", - "description" : "The agreed way that the subscription may continue after the end date." - }, - "xdm:topUp" : { - "title" : "Top up", - "type" : "string", - "description" : "Agreed terms for how consumable aspects of a subscription are repurchased during a billing period." - }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "description" : "The current status of the subscription." - }, - "xdm:contractID" : { - "title" : "Contract ID", - "type" : "string", - "description" : "Unique ID for the contract that governs this subscription." - }, - "xdm:paymentMethod" : { - "title" : "Payment method", - "type" : "string", - "description" : "The payment method for recurring payments." - }, - "xdm:billingPeriod" : { - "title" : "Billing period", - "type" : "string", - "description" : "The duration between billings." - }, - "xdm:billingStartDate" : { - "title" : "Billing start date", - "type" : "string", - "format" : "date", - "description" : "The date when the first bill is due." - }, - "xdm:chargeMethod" : { - "title" : "Charge method", - "type" : "string", - "description" : "The way the billing is setup to charge the customer." - }, - "xdm:paymentStatus" : { - "title" : "Payment status", - "type" : "string", - "description" : "The standing of the account." - }, - "xdm:category" : { - "title" : "Category", - "type" : "string", - "description" : "The main, top level categorization of this type of subscription." - }, - "xdm:subCategory" : { - "title" : "Sub category", - "type" : "string", - "description" : "The specific sub categorization of the subscription." - }, - "xdm:revision" : { - "title" : "Revision", - "type" : "string", - "description" : "The identification between subscriptions of the same name and category hierarchy." - }, - "xdm:reason" : { - "title" : "Reason", - "type" : "string", - "description" : "The general intent the member has for the use of the subscription." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/subscription", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Subscription", + "type": "object", + "meta:extensible": true, + "description": "Subscriptions are licensed entitlements to software, services, or goods that are utilized in a time or usage based way.", + "definitions": { + "subscription": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "description": "Unique identifier for the subscription instance." + }, + "xdm:subscriber": { + "title": "Subscriber", + "$ref": "https://ns.adobe.com/xdm/context/person", + "description": "The owner of the subscription." + }, + "xdm:device": { + "title": "Device", + "$ref": "https://ns.adobe.com/xdm/context/device", + "description": "The device linked to the subscription." + }, + "xdm:environment": { + "title": "Environment", + "$ref": "https://ns.adobe.com/xdm/context/environment", + "description": "Environment of the subscription. This can be either then known environment at the time of the subscription or the environment of the application for subscriptions related to an application." + }, + "xdm:SKU": { + "title": "SKU", + "type": "string", + "description": "Stock keeping unit (SKU), a generally unique identifier for a product." + }, + "xdm:planName": { + "title": "Plan name", + "type": "string", + "description": "The human readable name for the subscription." + }, + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The scope of entitlement in relation to how many people are covered by the subscription." + }, + "xdm:country": { + "title": "Country", + "type": "string", + "description": "The country that the subscription contractual and agreement terms are rooted in." + }, + "xdm:startDate": { + "title": "Start date", + "type": "string", + "format": "date", + "description": "The date the subscription begins." + }, + "xdm:endDate": { + "title": "End date", + "type": "string", + "format": "date", + "description": "The date the current subscription term ends." + }, + "xdm:term": { + "title": "Term", + "type": "integer", + "description": "The numeric value of the term." + }, + "xdm:termUnitOfTime": { + "title": "Term unit of time", + "type": "string", + "description": "The unit of time for the term period." + }, + "xdm:renew": { + "title": "Renew", + "type": "string", + "description": "The agreed way that the subscription may continue after the end date." + }, + "xdm:topUp": { + "title": "Top up", + "type": "string", + "description": "Agreed terms for how consumable aspects of a subscription are repurchased during a billing period." + }, + "xdm:status": { + "title": "Status", + "type": "string", + "description": "The current status of the subscription." + }, + "xdm:contractID": { + "title": "Contract ID", + "type": "string", + "description": "Unique ID for the contract that governs this subscription." + }, + "xdm:paymentMethod": { + "title": "Payment method", + "type": "string", + "description": "The payment method for recurring payments." + }, + "xdm:billingPeriod": { + "title": "Billing period", + "type": "string", + "description": "The duration between billings." + }, + "xdm:billingStartDate": { + "title": "Billing start date", + "type": "string", + "format": "date", + "description": "The date when the first bill is due." + }, + "xdm:chargeMethod": { + "title": "Charge method", + "type": "string", + "description": "The way the billing is setup to charge the customer." + }, + "xdm:paymentStatus": { + "title": "Payment status", + "type": "string", + "description": "The standing of the account." + }, + "xdm:category": { + "title": "Category", + "type": "string", + "description": "The main, top level categorization of this type of subscription." + }, + "xdm:subCategory": { + "title": "Sub category", + "type": "string", + "description": "The specific sub categorization of the subscription." + }, + "xdm:revision": { + "title": "Revision", + "type": "string", + "description": "The identification between subscriptions of the same name and category hierarchy." + }, + "xdm:reason": { + "title": "Reason", + "type": "string", + "description": "The general intent the member has for the use of the subscription." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/subscription" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/subscription" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/tool-usage.schema.json b/components/datatypes/industry-verticals/tool-usage.schema.json index 1d2cab423..4189d5698 100644 --- a/components/datatypes/industry-verticals/tool-usage.schema.json +++ b/components/datatypes/industry-verticals/tool-usage.schema.json @@ -1,80 +1,87 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Tool Usage", - "type" : "object", - "meta:extensible" : true, - "description" : "Tool usage comprises the most common steps used in a site tool or utility, such as calculators, registrations, and requests for more information.", - "definitions" : { - "tool-usage" : { - "properties" : { - "xdm:cancelled" : { - "title" : "Cancelled", - "type" : "integer", - "description" : "Captured when a visitor cancels out of a tool usage process." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Tool Usage", + "type": "object", + "meta:extensible": true, + "description": "Tool usage comprises the most common steps used in a site tool or utility, such as calculators, registrations, and requests for more information.", + "definitions": { + "tool-usage": { + "properties": { + "xdm:cancelled": { + "title": "Cancelled", + "type": "integer", + "description": "Captured when a visitor cancels out of a tool usage process." }, - "xdm:complete" : { - "title" : "Complete", - "type" : "integer", - "description" : "Captured when a visitor successfully finishes using any type of tool or utility on the site/app." + "xdm:complete": { + "title": "Complete", + "type": "integer", + "description": "Captured when a visitor successfully finishes using any type of tool or utility on the site/app." }, - "xdm:failure" : { - "title" : "Failed", - "type" : "integer", - "description" : "Captured when a step in the tool usage process fails." + "xdm:failure": { + "title": "Failed", + "type": "integer", + "description": "Captured when a step in the tool usage process fails." }, - "xdm:ID" : { - "title" : "ID", - "type" : "string", - "description" : "Captures the ID of the tool process utilized, if applicable. For example, this could be a claim, application, or booking ID, etc." + "xdm:ID": { + "title": "ID", + "type": "string", + "description": "Captures the ID of the tool process utilized, if applicable. For example, this could be a claim, application, or booking ID, etc." }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "Tracks the name of the tool in use." + "xdm:name": { + "title": "Name", + "type": "string", + "description": "Tracks the name of the tool in use." }, - "xdm:saved" : { - "title" : "Saved", - "type" : "integer", - "description" : "Captured when a visitor saves and exits a tool usage process." + "xdm:saved": { + "title": "Saved", + "type": "integer", + "description": "Captured when a visitor saves and exits a tool usage process." }, - "xdm:start" : { - "title" : "Start", - "type" : "integer", - "description" : "Captured when a visitor initializes using any type of tool or utility on the site/app." + "xdm:start": { + "title": "Start", + "type": "integer", + "description": "Captured when a visitor initializes using any type of tool or utility on the site/app." }, - "xdm:step" : { - "title" : "Step", - "type" : "integer", - "description" : "Captured when any intermediary tool step is started on the site/app." + "xdm:step": { + "title": "Step", + "type": "integer", + "description": "Captured when any intermediary tool step is started on the site/app." }, - "xdm:stepName" : { - "title" : "Step Name", - "type" : "string", - "description" : "Tracks the name of the tool step in use." + "xdm:stepName": { + "title": "Step Name", + "type": "string", + "description": "Tracks the name of the tool step in use." }, - "xdm:submitted" : { - "title" : "Submitted", - "type" : "integer", - "description" : "Captured when a visitor submits data during a tool step. Not necessarily synonymous with a successful event." + "xdm:submitted": { + "title": "Submitted", + "type": "integer", + "description": "Captured when a visitor submits data during a tool step. Not necessarily synonymous with a successful event." }, - "xdm:transaction" : { - "title" : "Transaction", - "$ref" : "https://ns.adobe.com/xdm/datatypes/transaction", - "description" : "Extension of Transaction Data Type" + "xdm:transaction": { + "title": "Transaction", + "$ref": "https://ns.adobe.com/xdm/datatypes/transaction", + "description": "Extension of Transaction Data Type" }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "Tracks the type or category of the tool in use." + "xdm:type": { + "title": "Type", + "type": "string", + "description": "Tracks the type or category of the tool in use." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/tool-usage" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/tool-usage" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/industry-verticals/transaction.schema.json b/components/datatypes/industry-verticals/transaction.schema.json index caf2d3c99..66413dc96 100644 --- a/components/datatypes/industry-verticals/transaction.schema.json +++ b/components/datatypes/industry-verticals/transaction.schema.json @@ -1,41 +1,48 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/datatypes/transaction", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Transaction", - "type" : "object", - "meta:extensible" : true, - "description" : "Transactions capture when non-order transactions occur, such as balance transfers or applied payments.", - "definitions" : { - "transaction" : { - "properties" : { - "xdm:transactionAmount" : { - "title" : "Transaction Amount", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "Captures the amount of the transaction." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/datatypes/transaction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Transaction", + "type": "object", + "meta:extensible": true, + "description": "Transactions capture when non-order transactions occur, such as balance transfers or applied payments.", + "definitions": { + "transaction": { + "properties": { + "xdm:transactionAmount": { + "title": "Transaction Amount", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "Captures the amount of the transaction." }, - "xdm:transactionID" : { - "title" : "Transaction ID", - "type" : "string", - "description" : "Identifier for the transaction." + "xdm:transactionID": { + "title": "Transaction ID", + "type": "string", + "description": "Identifier for the transaction." }, - "xdm:transactionDate" : { - "title" : "Transaction Date", - "type" : "string", - "format" : "date-time", - "description" : "Records the date/time of the transaction." + "xdm:transactionDate": { + "title": "Transaction Date", + "type": "string", + "format": "date-time", + "description": "Records the date/time of the transaction." }, - "xdm:transactionType" : { - "title" : "Transaction Type", - "type" : "string", - "description" : "Records the type of transaction utilized by the visitor." + "xdm:transactionType": { + "title": "Transaction Type", + "type": "string", + "description": "Records the type of transaction utilized by the visitor." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/transaction" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/transaction" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/interactions/beacon-interaction-details.schema.json b/components/datatypes/interactions/beacon-interaction-details.schema.json index 798330c55..11bfec60a 100644 --- a/components/datatypes/interactions/beacon-interaction-details.schema.json +++ b/components/datatypes/interactions/beacon-interaction-details.schema.json @@ -1,49 +1,57 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/beacon-interaction-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Beacon", - "type" : "object", - "meta:extensible" : true, - "description" : "Beacon is a wireless device that communicates identity information to mobile applications as mobile devices come within range.", - "definitions" : { - "beacon-interaction-detail" : { - "properties" : { - "xdm:proximityUUID" : { - "title" : "Proximity UUID", - "type" : "string", - "description" : "A proximity UUID (Universally Unique IDentifier) is a special type of identifier used to distinguish beacons in your network from all other beacons in networks outside your control. The proximity UUID is configured into a beacon, to be transmitted to mobile devices in range to identify an organizations beacons." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/beacon-interaction-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Beacon", + "type": "object", + "meta:extensible": true, + "description": "Beacon is a wireless device that communicates identity information to mobile applications as mobile devices come within range.", + "definitions": { + "beacon-interaction-detail": { + "properties": { + "xdm:proximityUUID": { + "title": "Proximity UUID", + "type": "string", + "description": "A proximity UUID (Universally Unique IDentifier) is a special type of identifier used to distinguish beacons in your network from all other beacons in networks outside your control. The proximity UUID is configured into a beacon, to be transmitted to mobile devices in range to identify an organizations beacons." }, - "xdm:beaconMajor" : { - "title" : "Beacon major", - "type" : "number", - "description" : "Major values identify and distinguish a group and unsigned integer values between 1 and 65,535." + "xdm:beaconMajor": { + "title": "Beacon major", + "type": "number", + "description": "Major values identify and distinguish a group and unsigned integer values between 1 and 65,535." }, - "xdm:beaconMinor" : { - "title" : "Beacon Minor", - "type" : "number", - "description" : "Minor values identify and distinguish an individual and unsigned integer values between 1 and 65,535." + "xdm:beaconMinor": { + "title": "Beacon Minor", + "type": "number", + "description": "Minor values identify and distinguish an individual and unsigned integer values between 1 and 65,535." }, - "xdm:proximity" : { - "title" : "Proximity to beacon", - "type" : "string", - "description" : "Estimated distance from the beacon.", - "enum" : [ "immediate", "near", "far", "unknown" ], - "meta:enum" : { - "immediate" : "Within a few centimeter.", - "near" : "Within a couple of meters.", - "far" : "Greater than 10 meters away.", - "unknown" : "Not able to ascertain distance, signal likely very weak." + "xdm:proximity": { + "title": "Proximity to beacon", + "type": "string", + "description": "Estimated distance from the beacon.", + "enum": ["immediate", "near", "far", "unknown"], + "meta:enum": { + "immediate": "Within a few centimeter.", + "near": "Within a couple of meters.", + "far": "Greater than 10 meters away.", + "unknown": "Not able to ascertain distance, signal likely very weak." } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/beacon-interaction-detail" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/beacon-interaction-detail" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/interactions/email-interaction.schema.json b/components/datatypes/interactions/email-interaction.schema.json index 9e9ebcf1b..616ba1d7c 100644 --- a/components/datatypes/interactions/email-interaction.schema.json +++ b/components/datatypes/interactions/email-interaction.schema.json @@ -1,129 +1,137 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/emailinteraction", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Email Interaction", - "type" : "object", - "meta:extensible" : true, - "description" : "Captures information in the context of an email correspondence between persons", - "definitions" : { - "emailinteraction" : { - "properties" : { - "xdm:priority" : { - "title" : "Email's priority", - "type" : "string", - "description" : "Captures the priority set by the person who sent the email" - }, - "xdm:sentDateTime" : { - "title" : "Date and time the email was sent", - "type" : "string", - "format" : "date-time", - "description" : "Captures the date and time the email correspondence was sent to an individual or a group of people" - }, - "xdm:receivedDateTime" : { - "title" : "Date and time the email was received", - "type" : "string", - "format" : "date-time", - "description" : "Captures the date and time when the email was received" - }, - "xdm:body" : { - "title" : "Body of the mail", - "type" : "string", - "description" : "The contents of the email after substitution of the placeholders in the template" - }, - "xdm:hasAttachments" : { - "title" : "Email has attachments", - "type" : "boolean", - "description" : "A flag represent whether any attachment is part of the email message" - }, - "xdm:isQuarantined" : { - "title" : "quarantine message", - "type" : "boolean", - "description" : "A flag to represent whether the email message is a spam" - }, - "xdm:sizeInBytes" : { - "title" : "Email message size", - "type" : "number", - "description" : "Record the size of the email message in bytes" - }, - "xdm:failureReasonCode" : { - "title" : "Reason code for failure", - "type" : "string", - "description" : "Indicates the error code for not able to deliver the email message" - }, - "xdm:failureReasonMessage" : { - "title" : "Reason Message for failure", - "type" : "string", - "description" : "Indicates the full message for the error code, for not able to deliver the message" - }, - "xdm:fromAddress" : { - "title" : "Person sending the email communication", - "type" : "string", - "format" : "email", - "description" : "Person who is sender of the email message" - }, - "xdm:toAddress" : { - "type" : "array", - "title" : "An array of email addresses for the To list", - "description" : "Person or list of people who are in the To list of the email message", - "items" : { - "type" : "string", - "format" : "email" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/emailinteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Email Interaction", + "type": "object", + "meta:extensible": true, + "description": "Captures information in the context of an email correspondence between persons", + "definitions": { + "emailinteraction": { + "properties": { + "xdm:priority": { + "title": "Email's priority", + "type": "string", + "description": "Captures the priority set by the person who sent the email" + }, + "xdm:sentDateTime": { + "title": "Date and time the email was sent", + "type": "string", + "format": "date-time", + "description": "Captures the date and time the email correspondence was sent to an individual or a group of people" + }, + "xdm:receivedDateTime": { + "title": "Date and time the email was received", + "type": "string", + "format": "date-time", + "description": "Captures the date and time when the email was received" + }, + "xdm:body": { + "title": "Body of the mail", + "type": "string", + "description": "The contents of the email after substitution of the placeholders in the template" + }, + "xdm:hasAttachments": { + "title": "Email has attachments", + "type": "boolean", + "description": "A flag represent whether any attachment is part of the email message" + }, + "xdm:isQuarantined": { + "title": "quarantine message", + "type": "boolean", + "description": "A flag to represent whether the email message is a spam" + }, + "xdm:sizeInBytes": { + "title": "Email message size", + "type": "number", + "description": "Record the size of the email message in bytes" + }, + "xdm:failureReasonCode": { + "title": "Reason code for failure", + "type": "string", + "description": "Indicates the error code for not able to deliver the email message" + }, + "xdm:failureReasonMessage": { + "title": "Reason Message for failure", + "type": "string", + "description": "Indicates the full message for the error code, for not able to deliver the message" + }, + "xdm:fromAddress": { + "title": "Person sending the email communication", + "type": "string", + "format": "email", + "description": "Person who is sender of the email message" + }, + "xdm:toAddress": { + "type": "array", + "title": "An array of email addresses for the To list", + "description": "Person or list of people who are in the To list of the email message", + "items": { + "type": "string", + "format": "email" } }, - "xdm:ccAddress" : { - "type" : "array", - "title" : "An array of email addresses for the cc list", - "description" : "Person or list of people who are in the cc list of the email message", - "items" : { - "type" : "string", - "format" : "email" + "xdm:ccAddress": { + "type": "array", + "title": "An array of email addresses for the cc list", + "description": "Person or list of people who are in the cc list of the email message", + "items": { + "type": "string", + "format": "email" } }, - "xdm:bccAddress" : { - "type" : "array", - "title" : "An array of email addresses for the bcc list", - "description" : "Person or list of people who are in the bcc list of the email message", - "items" : { - "type" : "string", - "format" : "email" + "xdm:bccAddress": { + "type": "array", + "title": "An array of email addresses for the bcc list", + "description": "Person or list of people who are in the bcc list of the email message", + "items": { + "type": "string", + "format": "email" } }, - "xdm:headers" : { - "title" : "Email headers", - "type" : "string", - "description" : "Captures the headers of the email for diagnosis" - }, - "xdm:incomingMessage" : { - "title" : "Inbound or Outbound Message ", - "type" : "boolean", - "description" : "A flag to represent whether a message was sent or recieved" - }, - "xdm:firstOpenDate" : { - "title" : "First time the email was opened by the receiver", - "type" : "string", - "format" : "date-time", - "description" : "First date and time when the receiver took the action to open the email" - }, - "xdm:lastOpenDate" : { - "title" : "Last time when the email was opened by the receiver", - "type" : "string", - "format" : "date-time", - "description" : "Last time the email was opened, by any receiver" - }, - "xdm:isTracked" : { - "title" : "Email Tracking flag", - "type" : "boolean", - "description" : "A flag to capture whether the email was tracked by the sender" + "xdm:headers": { + "title": "Email headers", + "type": "string", + "description": "Captures the headers of the email for diagnosis" + }, + "xdm:incomingMessage": { + "title": "Inbound or Outbound Message ", + "type": "boolean", + "description": "A flag to represent whether a message was sent or recieved" + }, + "xdm:firstOpenDate": { + "title": "First time the email was opened by the receiver", + "type": "string", + "format": "date-time", + "description": "First date and time when the receiver took the action to open the email" + }, + "xdm:lastOpenDate": { + "title": "Last time when the email was opened by the receiver", + "type": "string", + "format": "date-time", + "description": "Last time the email was opened, by any receiver" + }, + "xdm:isTracked": { + "title": "Email Tracking flag", + "type": "boolean", + "description": "A flag to capture whether the email was tracked by the sender" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/emailinteraction" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/emailinteraction" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/interactions/meeting-interaction.schema.json b/components/datatypes/interactions/meeting-interaction.schema.json index 7c21df124..26abfc0a6 100644 --- a/components/datatypes/interactions/meeting-interaction.schema.json +++ b/components/datatypes/interactions/meeting-interaction.schema.json @@ -1,60 +1,68 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/meetinginteraction", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Meeting Interaction", - "type" : "object", - "meta:extensible" : true, - "description" : "Captures information in the context of a meeting between people online or at a specified location", - "definitions" : { - "meetinginteraction" : { - "properties" : { - "xdm:isAllDay" : { - "title" : "All Day meeting/event", - "type" : "boolean", - "description" : "A flag to represent whether the meeting is all day long" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/meetinginteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Meeting Interaction", + "type": "object", + "meta:extensible": true, + "description": "Captures information in the context of a meeting between people online or at a specified location", + "definitions": { + "meetinginteraction": { + "properties": { + "xdm:isAllDay": { + "title": "All Day meeting/event", + "type": "boolean", + "description": "A flag to represent whether the meeting is all day long" }, - "xdm:isOnline" : { - "title" : "Meeting online/offline", - "type" : "boolean", - "description" : "A flag indicating whether the neeting is online of offline" + "xdm:isOnline": { + "title": "Meeting online/offline", + "type": "boolean", + "description": "A flag indicating whether the neeting is online of offline" }, - "xdm:isReminderSet" : { - "title" : "Reminder Set for the meeting", - "type" : "boolean", - "description" : "A flag indicating whether a reminder has been in place for the meeting" + "xdm:isReminderSet": { + "title": "Reminder Set for the meeting", + "type": "boolean", + "description": "A flag indicating whether a reminder has been in place for the meeting" }, - "xdm:reminderDateTime" : { - "title" : "Date and time at which the reminder is set", - "type" : "string", - "format" : "date-time", - "description" : "The date and time for which the reminder is set, if the flag for reminder set has been set to true" + "xdm:reminderDateTime": { + "title": "Date and time at which the reminder is set", + "type": "string", + "format": "date-time", + "description": "The date and time for which the reminder is set, if the flag for reminder set has been set to true" }, - "xdm:scheduledStartDateTime" : { - "title" : "Time at which the meeting has been schedued to start", - "type" : "string", - "format" : "date-time", - "description" : "Scheduled time at which the meeting will start" + "xdm:scheduledStartDateTime": { + "title": "Time at which the meeting has been schedued to start", + "type": "string", + "format": "date-time", + "description": "Scheduled time at which the meeting will start" }, - "xdm:scheduledEndDateTime" : { - "title" : "Scheduled time for the meeting to end", - "type" : "string", - "format" : "date-time", - "description" : "Scheduled time by which the meeting should end" + "xdm:scheduledEndDateTime": { + "title": "Scheduled time for the meeting to end", + "type": "string", + "format": "date-time", + "description": "Scheduled time by which the meeting should end" }, - "xdm:organizerID" : { - "title" : "Person organizing the meeting", - "type" : "string", - "description" : "Person who is responsible to control and manage the meeting" + "xdm:organizerID": { + "title": "Person organizing the meeting", + "type": "string", + "description": "Person who is responsible to control and manage the meeting" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/meetinginteraction" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/meetinginteraction" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/interactions/phone-interaction.schema.json b/components/datatypes/interactions/phone-interaction.schema.json index 7e539c592..88f5ef7ba 100644 --- a/components/datatypes/interactions/phone-interaction.schema.json +++ b/components/datatypes/interactions/phone-interaction.schema.json @@ -1,72 +1,80 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/phoneinteraction", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Phone Interaction", - "type" : "object", - "meta:extensible" : true, - "description" : "Captures information in the context of a phone call conversation ", - "definitions" : { - "phoneinteraction" : { - "properties" : { - "xdm:ID" : { - "title" : "ID of the call conversation", - "type" : "string", - "description" : "A unique identifier to represent the phone call conversation" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/phoneinteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Phone Interaction", + "type": "object", + "meta:extensible": true, + "description": "Captures information in the context of a phone call conversation ", + "definitions": { + "phoneinteraction": { + "properties": { + "xdm:ID": { + "title": "ID of the call conversation", + "type": "string", + "description": "A unique identifier to represent the phone call conversation" }, - "xdm:fromWhoID" : { - "title" : "Initiator of the call", - "type" : "string", - "description" : "Person ID who initiated the call of the conversation" + "xdm:fromWhoID": { + "title": "Initiator of the call", + "type": "string", + "description": "Person ID who initiated the call of the conversation" }, - "xdm:toWhoID" : { - "title" : "Call reciever", - "type" : "string", - "description" : "Person ID who recieved the call" + "xdm:toWhoID": { + "title": "Call reciever", + "type": "string", + "description": "Person ID who recieved the call" }, - "xdm:disposition" : { - "title" : "Label the outcome of the phone call", - "type" : "string", - "description" : "The outcome of the call as next triggering actions such as 'demo scheduled','left voicemail', etc." + "xdm:disposition": { + "title": "Label the outcome of the phone call", + "type": "string", + "description": "The outcome of the call as next triggering actions such as 'demo scheduled','left voicemail', etc." }, - "xdm:duration" : { - "title" : "Time Spent during the call", - "type" : "number", - "description" : "Record the length of the phone conversation in seconds" + "xdm:duration": { + "title": "Time Spent during the call", + "type": "number", + "description": "Record the length of the phone conversation in seconds" }, - "xdm:type" : { - "title" : "Type of the phone call", - "type" : "string", - "description" : "A way to represent the nature of the call", - "meta:enum" : { - "internal" : "Internal", - "inbound" : "Inbound", - "outbound" : "Outbound" + "xdm:type": { + "title": "Type of the phone call", + "type": "string", + "description": "A way to represent the nature of the call", + "meta:enum": { + "internal": "Internal", + "inbound": "Inbound", + "outbound": "Outbound" } }, - "xdm:fromNumber" : { - "title" : "Phone Number of the initiator of the call", - "type" : "string", - "description" : "Person's phone number who initiated the conversation. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." + "xdm:fromNumber": { + "title": "Phone Number of the initiator of the call", + "type": "string", + "description": "Person's phone number who initiated the conversation. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." }, - "xdm:toNumber" : { - "title" : "Phone number of the call reciever", - "type" : "string", - "description" : "Person's phone number who is the reciever of the call. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." + "xdm:toNumber": { + "title": "Phone number of the call reciever", + "type": "string", + "description": "Person's phone number who is the reciever of the call. Note the phone number is a string and may include meaningful characters such as brackets '()', hyphens '-', or characters to indicate sub-dialing identifiers like extensions 'x' for example, 1-353(0)18391111 or +613 9403600x1234." }, - "xdm:hasLeftVoiceMail" : { - "title" : "Has the initiator of the call left any Voice Mail message", - "type" : "boolean", - "description" : "A boolean flag to represent whether a voice mail has been left for the reciever" + "xdm:hasLeftVoiceMail": { + "title": "Has the initiator of the call left any Voice Mail message", + "type": "boolean", + "description": "A boolean flag to represent whether a voice mail has been left for the reciever" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/phoneinteraction" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/phoneinteraction" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/interactions/poi-interaction.schema.json b/components/datatypes/interactions/poi-interaction.schema.json index 06efc8dba..a17296e0a 100644 --- a/components/datatypes/interactions/poi-interaction.schema.json +++ b/components/datatypes/interactions/poi-interaction.schema.json @@ -1,41 +1,49 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/poi-interaction", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Point of interest interaction", - "type" : "object", - "meta:extensible" : true, - "description" : "A point or place of interest (POI) interaction used to capture triggered engagement activities when users enter, leave, or come within range of a POI.", - "definitions" : { - "poi-interaction" : { - "properties" : { - "xdm:POIDetail" : { - "title" : "POI detail", - "meta:status" : "deprecated", - "description" : "Detail of the POI that cause the event.", - "$ref" : "https://ns.adobe.com/xdm/context/poi-detail" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/poi-interaction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of interest interaction", + "type": "object", + "meta:extensible": true, + "description": "A point or place of interest (POI) interaction used to capture triggered engagement activities when users enter, leave, or come within range of a POI.", + "definitions": { + "poi-interaction": { + "properties": { + "xdm:POIDetail": { + "title": "POI detail", + "meta:status": "deprecated", + "description": "Detail of the POI that cause the event.", + "$ref": "https://ns.adobe.com/xdm/context/poi-detail" }, - "xdm:poiDetail" : { - "title" : "POI detail", - "description" : "Detail of the POI that cause the event.", - "$ref" : "https://ns.adobe.com/xdm/context/poi-detail" + "xdm:poiDetail": { + "title": "POI detail", + "description": "Detail of the POI that cause the event.", + "$ref": "https://ns.adobe.com/xdm/context/poi-detail" }, - "xdm:poiEntries" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of times a person has entered the point of interest (POI)." + "xdm:poiEntries": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of times a person has entered the point of interest (POI)." }, - "xdm:poiExits" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of times a person has exited the point of interest (POI)." + "xdm:poiExits": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of times a person has exited the point of interest (POI)." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/poi-interaction" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/poi-interaction" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/advertising-break.schema.json b/components/datatypes/marketing/advertising-break.schema.json index 08e9a77d1..484b041ab 100644 --- a/components/datatypes/marketing/advertising-break.schema.json +++ b/components/datatypes/marketing/advertising-break.schema.json @@ -1,37 +1,44 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/advertising-break", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Ad break", - "type" : "object", - "description" : "An ad break is an advertisement inserted into media content. Ad break describes how a timed advertising is inserted into a timed media.", - "meta:extensible" : true, - "definitions" : { - "adBreak" : { - "properties" : { - "@id" : { - "title" : "Ad Pod ID", - "format" : "uri-reference", - "type" : "string", - "description" : "Identifier of the ad break." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising-break", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad break", + "type": "object", + "description": "An ad break is an advertisement inserted into media content. Ad break describes how a timed advertising is inserted into a timed media.", + "meta:extensible": true, + "definitions": { + "adBreak": { + "properties": { + "@id": { + "title": "Ad Pod ID", + "format": "uri-reference", + "type": "string", + "description": "Identifier of the ad break." }, - "dc:title" : { - "title" : "Pod name", - "type" : "string", - "description" : "The friendly name of the ad break." + "dc:title": { + "title": "Pod name", + "type": "string", + "description": "The friendly name of the ad break." }, - "xdm:offset" : { - "title" : "Pod position", - "type" : "integer", - "description" : "The offset, in seconds, of the ad break from the start of the primary content." + "xdm:offset": { + "title": "Pod position", + "type": "integer", + "description": "The offset, in seconds, of the ad break from the start of the primary content." } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "#/definitions/adBreak" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/adBreak" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/advertising-timed-asset-reference.schema.json b/components/datatypes/marketing/advertising-timed-asset-reference.schema.json index ae3841bf4..3b53e9cae 100644 --- a/components/datatypes/marketing/advertising-timed-asset-reference.schema.json +++ b/components/datatypes/marketing/advertising-timed-asset-reference.schema.json @@ -1,69 +1,77 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Ad asset reference", - "type" : "object", - "description" : "Ad asset reference is info about the ad captured by the experience event.", - "meta:extensible" : true, - "definitions" : { - "adAssetReference" : { - "properties" : { - "@id" : { - "title" : "Ad ID", - "type" : "string", - "format" : "uri-reference", - "description" : "Identifier of the ad asset provided by media analytics customers. Following the Ad-ID standard [https://www.ad-id.org]." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad asset reference", + "type": "object", + "description": "Ad asset reference is info about the ad captured by the experience event.", + "meta:extensible": true, + "definitions": { + "adAssetReference": { + "properties": { + "@id": { + "title": "Ad ID", + "type": "string", + "format": "uri-reference", + "description": "Identifier of the ad asset provided by media analytics customers. Following the Ad-ID standard [https://www.ad-id.org]." }, - "xdm:creativeID" : { - "title" : "Ad creative ID", - "type" : "string", - "description" : "The ID of the ad creative." + "xdm:creativeID": { + "title": "Ad creative ID", + "type": "string", + "description": "The ID of the ad creative." }, - "xdm:creativeURL" : { - "title" : "Ad creative URL", - "type" : "string", - "description" : "The URL of the ad creative." + "xdm:creativeURL": { + "title": "Ad creative URL", + "type": "string", + "description": "The URL of the ad creative." }, - "xdm:siteID" : { - "title" : "Ad site ID", - "type" : "string", - "description" : "ID of the ad site." + "xdm:siteID": { + "title": "Ad site ID", + "type": "string", + "description": "ID of the ad site." }, - "xdm:placementID" : { - "title" : "Ad placement ID", - "type" : "string", - "description" : "Placement ID of the ad." + "xdm:placementID": { + "title": "Ad placement ID", + "type": "string", + "description": "Placement ID of the ad." }, - "dc:title" : { - "title" : "Ad name", - "type" : "string", - "description" : "The friendly and human-readable name of the ad asset." + "dc:title": { + "title": "Ad name", + "type": "string", + "description": "The friendly and human-readable name of the ad asset." }, - "xdm:advertiser" : { - "title" : "Ad advertiser", - "type" : "string", - "description" : "Company/Brand whose product is featured in the ad." + "xdm:advertiser": { + "title": "Ad advertiser", + "type": "string", + "description": "Company/Brand whose product is featured in the ad." }, - "xdm:campaign" : { - "title" : "Ad campaign", - "type" : "string", - "description" : "ID of the ad campaign." + "xdm:campaign": { + "title": "Ad campaign", + "type": "string", + "description": "ID of the ad campaign." }, - "xmpDM:duration" : { - "title" : "Ad length or duration", - "type" : "integer", - "description" : "Length or duration of ad asset in seconds." + "xmpDM:duration": { + "title": "Ad length or duration", + "type": "integer", + "description": "Length or duration of ad asset in seconds." } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/adAssetReference" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/adAssetReference" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/advertising-timed-asset-view-details.schema.json b/components/datatypes/marketing/advertising-timed-asset-view-details.schema.json index 706366208..1485bd043 100644 --- a/components/datatypes/marketing/advertising-timed-asset-view-details.schema.json +++ b/components/datatypes/marketing/advertising-timed-asset-view-details.schema.json @@ -1,37 +1,45 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Ad asset view details", - "type" : "object", - "description" : "View details for the ad playback captured by the experience event.", - "meta:extensible" : true, - "definitions" : { - "adAssetViewDetails" : { - "properties" : { - "xdm:playerName" : { - "title" : "Ad player name", - "type" : "string", - "description" : "The name of the player responsible for rendering the ad." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Ad asset view details", + "type": "object", + "description": "View details for the ad playback captured by the experience event.", + "meta:extensible": true, + "definitions": { + "adAssetViewDetails": { + "properties": { + "xdm:playerName": { + "title": "Ad player name", + "type": "string", + "description": "The name of the player responsible for rendering the ad." }, - "xdm:index" : { - "title" : "Ad In Pod Position", - "type" : "integer", - "description" : "The index of the ad inside the parent ad break, for example, the first ad has index 0 and the second ad has index 1." + "xdm:index": { + "title": "Ad In Pod Position", + "type": "integer", + "description": "The index of the ad inside the parent ad break, for example, the first ad has index 0 and the second ad has index 1." }, - "xdm:adBreak" : { - "title" : "Ad break", - "description" : "Details about how a timed advertising is inserted into a timed media.", - "$ref" : "https://ns.adobe.com/xdm/context/advertising-break" + "xdm:adBreak": { + "title": "Ad break", + "description": "Details about how a timed advertising is inserted into a timed media.", + "$ref": "https://ns.adobe.com/xdm/context/advertising-break" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/adAssetViewDetails" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/adAssetViewDetails" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/advertising.schema.json b/components/datatypes/marketing/advertising.schema.json index 2a843fed3..28721e13f 100644 --- a/components/datatypes/marketing/advertising.schema.json +++ b/components/datatypes/marketing/advertising.schema.json @@ -1,86 +1,94 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/advertising", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Advertising", - "type" : "object", - "description" : "The information related to advertising activity in relationship to the experience event.", - "meta:extensible" : true, - "definitions" : { - "advertising" : { - "properties" : { - "xdm:adViewability" : { - "title" : "MRC viewability", - "$ref" : "https://ns.adobe.com/xdm/context/adviewability", - "description" : "Media Rating Council (MRC) defines viewability as an online advertising metric that indicates the number of impressions that are actually “seen” by end-users. Viewability captures specific details such as player volume, library version, window status, and viewport ad measured dimensions." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/advertising", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Advertising", + "type": "object", + "description": "The information related to advertising activity in relationship to the experience event.", + "meta:extensible": true, + "definitions": { + "advertising": { + "properties": { + "xdm:adViewability": { + "title": "MRC viewability", + "$ref": "https://ns.adobe.com/xdm/context/adviewability", + "description": "Media Rating Council (MRC) defines viewability as an online advertising metric that indicates the number of impressions that are actually “seen” by end-users. Viewability captures specific details such as player volume, library version, window status, and viewport ad measured dimensions." }, - "xdm:adAssetReference" : { - "title" : "Ad asset reference", - "description" : "Asset information about the ad captured by the experience event.", - "$ref" : "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference" + "xdm:adAssetReference": { + "title": "Ad asset reference", + "description": "Asset information about the ad captured by the experience event.", + "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-reference" }, - "xdm:adAssetViewDetails" : { - "title" : "Ad asset view details", - "description" : "View details for the ad playback captured by the experience event.", - "$ref" : "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details" + "xdm:adAssetViewDetails": { + "title": "Ad asset view details", + "description": "View details for the ad playback captured by the experience event.", + "$ref": "https://ns.adobe.com/xdm/context/advertising-timed-asset-view-details" }, - "xdm:completes" : { - "title" : "Ad completes", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates if a timed media asset was watched to completion but doesn't necessarily mean the end-user watched the whole video as the they could have skipped ahead." + "xdm:completes": { + "title": "Ad completes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if a timed media asset was watched to completion but doesn't necessarily mean the end-user watched the whole video as the they could have skipped ahead." }, - "xdm:timePlayed" : { - "title" : "Ad time spent", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the amount of time spent by an end-user on a specific timed media asset." + "xdm:timePlayed": { + "title": "Ad time spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the amount of time spent by an end-user on a specific timed media asset." }, - "xdm:federated" : { - "title" : "Ad federated", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates if an experience event was created through data federation such as data sharing between customers." + "xdm:federated": { + "title": "Ad federated", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if an experience event was created through data federation such as data sharing between customers." }, - "xdm:downloadedPlayback" : { - "title" : "Ad downloaded flag", - "type" : "boolean", - "description" : "Set to true when the hit is generated due to playing a downloaded ad session." + "xdm:downloadedPlayback": { + "title": "Ad downloaded flag", + "type": "boolean", + "description": "Set to true when the hit is generated due to playing a downloaded ad session." }, - "xdm:clicks" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Click actions on an advertisement." + "xdm:clicks": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click actions on an advertisement." }, - "xdm:conversions" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A customer pre-defined action or actions which triggers an event for performance evaluation." + "xdm:conversions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A customer pre-defined action or actions which triggers an event for performance evaluation." }, - "xdm:firstQuartiles" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A digital video ad that has played through 25% of its duration at normal speed." + "xdm:firstQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad that has played through 25% of its duration at normal speed." }, - "xdm:impressions" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Impression of an advertisement to a end-user with the potential of being viewed." + "xdm:impressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Impression of an advertisement to a end-user with the potential of being viewed." }, - "xdm:midpoints" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A digital video ad has played through 50% of its duration at normal speed." + "xdm:midpoints": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad has played through 50% of its duration at normal speed." }, - "xdm:starts" : { - "title" : "Ad starts", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A digital video ad has started playing." + "xdm:starts": { + "title": "Ad starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad has started playing." }, - "xdm:thirdQuartiles" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A digital video ad has played through 75% of its duration at normal speed." + "xdm:thirdQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A digital video ad has played through 75% of its duration at normal speed." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/advertising" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/advertising" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/adviewability.schema.json b/components/datatypes/marketing/adviewability.schema.json index 6472d7765..ea3cda101 100644 --- a/components/datatypes/marketing/adviewability.schema.json +++ b/components/datatypes/marketing/adviewability.schema.json @@ -1,130 +1,138 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/adviewability", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "MRC Viewability", - "type" : "object", - "meta:extensible" : true, - "description" : "Browser or app settings measured at runtime describing the viewability of an advertisement associated with each page load.", - "definitions" : { - "adviewability" : { - "properties" : { - "xdm:adUnitDepth" : { - "title" : "Ad Unit Depth", - "type" : "integer", - "description" : "Publishers may embed ad units inside containers/iFrames in order limit the ad's access solely to the code of the page. This describes how many 'containers' or iFrames the ad unit is displayed inside of.", - "minimum" : 0 - }, - "xdm:viewportHeight" : { - "title" : "Viewport Height", - "type" : "integer", - "description" : "The vertical size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport height.", - "minimum" : 0 - }, - "xdm:viewportWidth" : { - "title" : "Viewport Width", - "type" : "integer", - "description" : "The horizontal size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport width.", - "minimum" : 0 - }, - "xdm:adHeight" : { - "title" : "Ad Height", - "type" : "integer", - "description" : "The number of vertical pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.", - "minimum" : 0 - }, - "xdm:adWidth" : { - "title" : "Ad Width", - "type" : "integer", - "description" : "The number of horizontal pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.", - "minimum" : 0 - }, - "xdm:playerVolume" : { - "title" : "Player Volume Percentage", - "type" : "integer", - "description" : "The player volume percentage, measured at runtime where 0 is muted and 100 is maximum volume.", - "minimum" : 0, - "maximum" : 100 - }, - "xdm:measurementEligible" : { - "title" : "Viewability Measurement Eligible", - "type" : "boolean", - "description" : "Whether or not the ad was eligible to viewability measurement. An ad is eligible if the unit has a supported creative format and tag type." - }, - "xdm:implementationDetails" : { - "title" : "Viewabiltity Implementation Details", - "$ref" : "https://ns.adobe.com/xdm/context/implementationdetails", - "description" : "The name and version of the library instrumented to measure viewability metrics." - }, - "xdm:viewable" : { - "title" : "Viewable Ad", - "type" : "boolean", - "description" : "Display ads are considered viewable when at least 50% of the ad is visible for at least 1 second. Video ads are considered viewable when at least 50% of the ad is visible while the video is playing for at least 2 consecutive seconds. All viewable ads are measurable, because you can't confirm that an ad has met the criteria for viewability unless it can be measured." - }, - "xdm:activeWindow" : { - "title" : "Active Window", - "type" : "boolean", - "description" : "Indicates whether ad was shown on active window on users' device." - }, - "xdm:percentViewable" : { - "title" : "Percent Viewable", - "type" : "integer", - "description" : "Percent of pixels in the ad deemed viewable at measurement time.", - "minimum" : 0, - "maximum" : 100 - }, - "xdm:viewabilityEligibleImpressions" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Impression(s) of an advertisement to an end-user with viewablility library instrumented." - }, - "xdm:measuredAdNotVisible" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicator of ad not being visible as measured by a viewability library at impression time." - }, - "xdm:measuredMuted" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicator of ad being muted as measured by a viewability library at impression time." - }, - "xdm:measuredWindowInactive" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicator of ad being displayed in an inactive window as measured by a viewability library at impression time." - }, - "xdm:unmeasurableIframe" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicator of viewability library not being able to properly execute measurements due to ad being displayed inside an iframe." - }, - "xdm:unmeasurableOther" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicator of viewability library not being able to properly execute measurements due to non-predefined error." - }, - "xdm:viewableCompletes" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Completion(s) of an advertisement to an end-user deemed viewable at completion time by a viewability library." - }, - "xdm:viewableFirstQuartiles" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "First quartile(s) of an advertisement to an end-user deemed viewable at first quartile of play by a viewability library." - }, - "xdm:viewableImpressions" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Impressions of an advertisement to an end-user deemed viewable after two seconds of play by a viewability library." - }, - "xdm:viewableMidpoints" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Midpoint(s) of an advertisement to an end-user deemed viewable at midpoint of play by a viewability library." - }, - "xdm:viewableThirdQuartiles" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Third quartile(s) of an advertisement to an end-user deemed viewable at third quartile of play by a viewability library." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/adviewability", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "MRC Viewability", + "type": "object", + "meta:extensible": true, + "description": "Browser or app settings measured at runtime describing the viewability of an advertisement associated with each page load.", + "definitions": { + "adviewability": { + "properties": { + "xdm:adUnitDepth": { + "title": "Ad Unit Depth", + "type": "integer", + "description": "Publishers may embed ad units inside containers/iFrames in order limit the ad's access solely to the code of the page. This describes how many 'containers' or iFrames the ad unit is displayed inside of.", + "minimum": 0 + }, + "xdm:viewportHeight": { + "title": "Viewport Height", + "type": "integer", + "description": "The vertical size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport height.", + "minimum": 0 + }, + "xdm:viewportWidth": { + "title": "Viewport Width", + "type": "integer", + "description": "The horizontal size (in pixels) of the window the experience was displayed inside measured at runtime. For a web view event, the browser viewport width.", + "minimum": 0 + }, + "xdm:adHeight": { + "title": "Ad Height", + "type": "integer", + "description": "The number of vertical pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.", + "minimum": 0 + }, + "xdm:adWidth": { + "title": "Ad Width", + "type": "integer", + "description": "The number of horizontal pixels of the player, measured at runtime. This can be larger than the size of the ad if the player has extra controls or thumbnails.", + "minimum": 0 + }, + "xdm:playerVolume": { + "title": "Player Volume Percentage", + "type": "integer", + "description": "The player volume percentage, measured at runtime where 0 is muted and 100 is maximum volume.", + "minimum": 0, + "maximum": 100 + }, + "xdm:measurementEligible": { + "title": "Viewability Measurement Eligible", + "type": "boolean", + "description": "Whether or not the ad was eligible to viewability measurement. An ad is eligible if the unit has a supported creative format and tag type." + }, + "xdm:implementationDetails": { + "title": "Viewabiltity Implementation Details", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "The name and version of the library instrumented to measure viewability metrics." + }, + "xdm:viewable": { + "title": "Viewable Ad", + "type": "boolean", + "description": "Display ads are considered viewable when at least 50% of the ad is visible for at least 1 second. Video ads are considered viewable when at least 50% of the ad is visible while the video is playing for at least 2 consecutive seconds. All viewable ads are measurable, because you can't confirm that an ad has met the criteria for viewability unless it can be measured." + }, + "xdm:activeWindow": { + "title": "Active Window", + "type": "boolean", + "description": "Indicates whether ad was shown on active window on users' device." + }, + "xdm:percentViewable": { + "title": "Percent Viewable", + "type": "integer", + "description": "Percent of pixels in the ad deemed viewable at measurement time.", + "minimum": 0, + "maximum": 100 + }, + "xdm:viewabilityEligibleImpressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Impression(s) of an advertisement to an end-user with viewablility library instrumented." + }, + "xdm:measuredAdNotVisible": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of ad not being visible as measured by a viewability library at impression time." + }, + "xdm:measuredMuted": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of ad being muted as measured by a viewability library at impression time." + }, + "xdm:measuredWindowInactive": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of ad being displayed in an inactive window as measured by a viewability library at impression time." + }, + "xdm:unmeasurableIframe": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of viewability library not being able to properly execute measurements due to ad being displayed inside an iframe." + }, + "xdm:unmeasurableOther": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicator of viewability library not being able to properly execute measurements due to non-predefined error." + }, + "xdm:viewableCompletes": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Completion(s) of an advertisement to an end-user deemed viewable at completion time by a viewability library." + }, + "xdm:viewableFirstQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "First quartile(s) of an advertisement to an end-user deemed viewable at first quartile of play by a viewability library." + }, + "xdm:viewableImpressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Impressions of an advertisement to an end-user deemed viewable after two seconds of play by a viewability library." + }, + "xdm:viewableMidpoints": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Midpoint(s) of an advertisement to an end-user deemed viewable at midpoint of play by a viewability library." + }, + "xdm:viewableThirdQuartiles": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Third quartile(s) of an advertisement to an end-user deemed viewable at third quartile of play by a viewability library." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/adviewability" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/adviewability" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/commerce.schema.json b/components/datatypes/marketing/commerce.schema.json index 3ff2624d7..b93f9063f 100644 --- a/components/datatypes/marketing/commerce.schema.json +++ b/components/datatypes/marketing/commerce.schema.json @@ -1,71 +1,79 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/commerce", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Commerce", - "type" : "object", - "meta:extensible" : true, - "description" : "The records related to buying and selling activity.", - "definitions" : { - "commerce" : { - "properties" : { - "xdm:order" : { - "title" : "Order", - "$ref" : "https://ns.adobe.com/xdm/data/order", - "description" : "The placed order for one or more products." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/commerce", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Commerce", + "type": "object", + "meta:extensible": true, + "description": "The records related to buying and selling activity.", + "definitions": { + "commerce": { + "properties": { + "xdm:order": { + "title": "Order", + "$ref": "https://ns.adobe.com/xdm/data/order", + "description": "The placed order for one or more products." }, - "xdm:cartAbandons" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A product list has been identified as no longer accessible or purchasable by the user." + "xdm:cartAbandons": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A product list has been identified as no longer accessible or purchasable by the user." }, - "xdm:checkouts" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order." + "xdm:checkouts": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "An action during a checkout process of a product list, there can be more than one checkout event if there are multiple steps in a checkout process. If there are multiple steps the event time information and referenced page or experience is used to identify the step individual events represent in order." }, - "xdm:productListAdds" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Addition of a product to the product list, for example a product is added to a shopping cart." + "xdm:productListAdds": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Addition of a product to the product list, for example a product is added to a shopping cart." }, - "xdm:productListOpens" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Initializations of a new product list, for example a shopping cart is created." + "xdm:productListOpens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Initializations of a new product list, for example a shopping cart is created." }, - "xdm:productListRemovals" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Removal or removals of a product entry from a product list, for example a product is removed from a shopping cart." + "xdm:productListRemovals": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Removal or removals of a product entry from a product list, for example a product is removed from a shopping cart." }, - "xdm:productListReopens" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A product list that was no longer accessible (abandoned) has been re-activated by the user. Example via a re-marketing activity." + "xdm:productListReopens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A product list that was no longer accessible (abandoned) has been re-activated by the user. Example via a re-marketing activity." }, - "xdm:productListViews" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "View or views of a product-list has occurred." + "xdm:productListViews": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "View or views of a product-list has occurred." }, - "xdm:productViews" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "View or views of a product have occurred." + "xdm:productViews": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "View or views of a product have occurred." }, - "xdm:purchases" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced." + "xdm:purchases": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "An order has been accepted. Purchase is the only required action in a commerce conversion. Purchase must have a product list referenced." }, - "xdm:saveForLaters" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Product list is saved for future use, for example a product wish list." + "xdm:saveForLaters": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Product list is saved for future use, for example a product wish list." }, - "xdm:inStorePurchase" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "'inStore' purchase is saved for analytics use." + "xdm:inStorePurchase": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "'inStore' purchase is saved for analytics use." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/commerce" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/commerce" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/direct-marketing.schema.json b/components/datatypes/marketing/direct-marketing.schema.json index cbc0a600c..62d1d2b4b 100644 --- a/components/datatypes/marketing/direct-marketing.schema.json +++ b/components/datatypes/marketing/direct-marketing.schema.json @@ -1,102 +1,110 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/direct-marketing", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Direct marketing", - "type" : "object", - "description" : "The events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications.", - "meta:extensible" : true, - "definitions" : { - "direct-marketing" : { - "properties" : { - "xdm:bounces" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Asynchronous messages that have been returned as temporarily undeliverable the receiving system." - }, - "xdm:clicks" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Click actions on a message." - }, - "xdm:mirrorPages" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Click on a link in a message to a web hosted mirror page." - }, - "xdm:nonDeliverables" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Asynchronous messages failed to deliver in a way that indicates that no future delivery attempts will be successful to the address." - }, - "xdm:sends" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Asynchronous messages such as email, SMS, and MMS that have been dispatched to a person's account, address, or device." - }, - "xdm:userComplaints" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "User complaint or complaints have been received. This generally occurs when a recipient of a message reports it as spam." - }, - "xdm:opens" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The direct marketing message such as email, SMS, and push notifications has been opened, swiped, or touched by the recipient." - }, - "xdm:unsubscriptions" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The recipient of the direct marketing message such as email or newsletters has opted out from receiving them." - }, - "xdm:notSent" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Asynchronous message such as email, SMS, or MMS was not dispatched due to cancellation or expiration of the marketing activity." - }, - "xdm:offerOpens" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Offer in a marketing message such as email, SMS, or push notifications has been opened, swiped, touched or otherwise interacted with by the recipient." - }, - "xdm:impressions" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The direct marketing message such as push notifications or in-app message has been seen by the end user." - }, - "xdm:excludes" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The recipient of the direct marketing message such as email or push has been excluded due to some typology rules configured like fatigue/blacklisted." - }, - "xdm:customActions" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Action(s) that users can take on custom objects sent as part of a direct marketing message like push notification." - }, - "xdm:marketingSubscription" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Counter event when a visitor opts-in/subscribes for a direct marketing service." - }, - "xdm:unsubscribeReason" : { - "title" : "Marketing Service Unsubscribe", - "description" : "Tracks the visitor feedback provided when unsubscribing form a direct marketing service.", - "type" : "string" - }, - "xdm:hashedEmail" : { - "title" : "Visitor Hashed Email Address", - "description" : "Captures the encrypted/hashed version of the visitor's email address.", - "type" : "string" - }, - "xdm:emailVisitorID" : { - "title" : "Email Recipient ID", - "description" : "Captures the email recipient ID.", - "type" : "string" - }, - "xdm:messageID" : { - "title" : "Email Message ID", - "description" : "Captures the email message ID.", - "type" : "string" - }, - "xdm:emailDelivered" : { - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Counts the total number of email messages delivered." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/direct-marketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing", + "type": "object", + "description": "The events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications.", + "meta:extensible": true, + "definitions": { + "direct-marketing": { + "properties": { + "xdm:bounces": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous messages that have been returned as temporarily undeliverable the receiving system." + }, + "xdm:clicks": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click actions on a message." + }, + "xdm:mirrorPages": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click on a link in a message to a web hosted mirror page." + }, + "xdm:nonDeliverables": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous messages failed to deliver in a way that indicates that no future delivery attempts will be successful to the address." + }, + "xdm:sends": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous messages such as email, SMS, and MMS that have been dispatched to a person's account, address, or device." + }, + "xdm:userComplaints": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "User complaint or complaints have been received. This generally occurs when a recipient of a message reports it as spam." + }, + "xdm:opens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The direct marketing message such as email, SMS, and push notifications has been opened, swiped, or touched by the recipient." + }, + "xdm:unsubscriptions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The recipient of the direct marketing message such as email or newsletters has opted out from receiving them." + }, + "xdm:notSent": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Asynchronous message such as email, SMS, or MMS was not dispatched due to cancellation or expiration of the marketing activity." + }, + "xdm:offerOpens": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Offer in a marketing message such as email, SMS, or push notifications has been opened, swiped, touched or otherwise interacted with by the recipient." + }, + "xdm:impressions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The direct marketing message such as push notifications or in-app message has been seen by the end user." + }, + "xdm:excludes": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The recipient of the direct marketing message such as email or push has been excluded due to some typology rules configured like fatigue/blacklisted." + }, + "xdm:customActions": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Action(s) that users can take on custom objects sent as part of a direct marketing message like push notification." + }, + "xdm:marketingSubscription": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Counter event when a visitor opts-in/subscribes for a direct marketing service." + }, + "xdm:unsubscribeReason": { + "title": "Marketing Service Unsubscribe", + "description": "Tracks the visitor feedback provided when unsubscribing form a direct marketing service.", + "type": "string" + }, + "xdm:hashedEmail": { + "title": "Visitor Hashed Email Address", + "description": "Captures the encrypted/hashed version of the visitor's email address.", + "type": "string" + }, + "xdm:emailVisitorID": { + "title": "Email Recipient ID", + "description": "Captures the email recipient ID.", + "type": "string" + }, + "xdm:messageID": { + "title": "Email Message ID", + "description": "Captures the email message ID.", + "type": "string" + }, + "xdm:emailDelivered": { + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Counts the total number of email messages delivered." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/direct-marketing" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/direct-marketing" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/directmarketing-address.schema.json b/components/datatypes/marketing/directmarketing-address.schema.json index e023cdcf7..a8a9030b3 100644 --- a/components/datatypes/marketing/directmarketing-address.schema.json +++ b/components/datatypes/marketing/directmarketing-address.schema.json @@ -1,39 +1,47 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/directmarketing-address", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Direct marketing postal address", - "type" : "object", - "description" : "Postal address information used to contact a user.", - "definitions" : { - "directmarketing-address" : { - "properties" : { - "xdm:errorCount" : { - "title" : "Address error count", - "type" : "integer", - "description" : "Number of consecutive errors when sending to this address." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/directmarketing-address", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing postal address", + "type": "object", + "description": "Postal address information used to contact a user.", + "definitions": { + "directmarketing-address": { + "properties": { + "xdm:errorCount": { + "title": "Address error count", + "type": "integer", + "description": "Number of consecutive errors when sending to this address." }, - "xdm:quality" : { - "title" : "Address quality", - "type" : "string", - "description" : "Address quality rating.", - "meta:enum" : { - "incomplete_address" : "Incomplete address", - "unknown_town_postal_code" : "Unknown town or postal code", - "empty_street" : "Empty street", - "unknown_street" : "Unknown street", - "partially_recognized_street" : "Partially recognized street", - "fully_recognized_street" : "Fully recognized street" + "xdm:quality": { + "title": "Address quality", + "type": "string", + "description": "Address quality rating.", + "meta:enum": { + "incomplete_address": "Incomplete address", + "unknown_town_postal_code": "Unknown town or postal code", + "empty_street": "Empty street", + "unknown_street": "Unknown street", + "partially_recognized_street": "Partially recognized street", + "fully_recognized_street": "Fully recognized street" } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/directmarketing-address" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/address" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/directmarketing-address" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/address" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/directmarketing-emailaddress.schema.json b/components/datatypes/marketing/directmarketing-emailaddress.schema.json index 6381a8a69..0300667ca 100644 --- a/components/datatypes/marketing/directmarketing-emailaddress.schema.json +++ b/components/datatypes/marketing/directmarketing-emailaddress.schema.json @@ -1,31 +1,39 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/directmarketing-emailaddress", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Direct marketing email address", - "type" : "object", - "description" : "Email address used to contact a user.", - "definitions" : { - "directmarketing-emailaddress" : { - "properties" : { - "xdm:errorCount" : { - "title" : "Error count", - "type" : "integer", - "description" : "Number of consecutive errors when sending to this email address." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/directmarketing-emailaddress", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing email address", + "type": "object", + "description": "Email address used to contact a user.", + "definitions": { + "directmarketing-emailaddress": { + "properties": { + "xdm:errorCount": { + "title": "Error count", + "type": "integer", + "description": "Number of consecutive errors when sending to this email address." }, - "xdm:quality" : { - "title" : "Quality", - "type" : "string", - "description" : "Quality rating." + "xdm:quality": { + "title": "Quality", + "type": "string", + "description": "Quality rating." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/directmarketing-emailaddress" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/emailaddress" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/directmarketing-emailaddress" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/emailaddress" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/directmarketing-phonenumber.schema.json b/components/datatypes/marketing/directmarketing-phonenumber.schema.json index 770be1b78..c05b982e4 100644 --- a/components/datatypes/marketing/directmarketing-phonenumber.schema.json +++ b/components/datatypes/marketing/directmarketing-phonenumber.schema.json @@ -1,31 +1,39 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/directmarketing-phonenumber", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Direct marketing phone number", - "type" : "object", - "description" : "Phone number used to contact a user.", - "definitions" : { - "directmarketing-phonenumber" : { - "properties" : { - "xdm:errorCount" : { - "title" : "Error count", - "type" : "integer", - "description" : "Number of consecutive errors when calling this phone number." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/directmarketing-phonenumber", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct marketing phone number", + "type": "object", + "description": "Phone number used to contact a user.", + "definitions": { + "directmarketing-phonenumber": { + "properties": { + "xdm:errorCount": { + "title": "Error count", + "type": "integer", + "description": "Number of consecutive errors when calling this phone number." }, - "xdm:quality" : { - "title" : "Quality", - "type" : "string", - "description" : "Quality rating." + "xdm:quality": { + "title": "Quality", + "type": "string", + "description": "Quality rating." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/directmarketing-phonenumber" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/directmarketing-phonenumber" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/phonenumber" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/marketing/marketing.schema.json b/components/datatypes/marketing/marketing.schema.json index 8082521c2..ea41e918d 100644 --- a/components/datatypes/marketing/marketing.schema.json +++ b/components/datatypes/marketing/marketing.schema.json @@ -1,37 +1,45 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/marketing", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Marketing", - "type" : "object", - "meta:extensible" : true, - "description" : "The information related to marketing activities that are active with the touchpoint.", - "definitions" : { - "marketing" : { - "properties" : { - "xdm:trackingCode" : { - "title" : "Tracking code", - "type" : "string", - "description" : "Tracking code that can be used to identify the marketing campaign the event is associated with." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/marketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Marketing", + "type": "object", + "meta:extensible": true, + "description": "The information related to marketing activities that are active with the touchpoint.", + "definitions": { + "marketing": { + "properties": { + "xdm:trackingCode": { + "title": "Tracking code", + "type": "string", + "description": "Tracking code that can be used to identify the marketing campaign the event is associated with." }, - "xdm:campaignName" : { - "title" : "Campaign name", - "type" : "string", - "description" : "Name of the campaign used to identify marketing campaign like '50%_DISCOUNT_USA' or '50%_DISCOUNT_ASIA'." + "xdm:campaignName": { + "title": "Campaign name", + "type": "string", + "description": "Name of the campaign used to identify marketing campaign like '50%_DISCOUNT_USA' or '50%_DISCOUNT_ASIA'." }, - "xdm:campaignGroup" : { - "title" : "Campaign group", - "type" : "string", - "description" : "Name of the campaign group where multiple campaigns are grouped together like '50%_DISCOUNT'." + "xdm:campaignGroup": { + "title": "Campaign group", + "type": "string", + "description": "Name of the campaign group where multiple campaigns are grouped together like '50%_DISCOUNT'." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/marketing" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/marketing" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed-asset-reference.schema.json b/components/datatypes/media/media-timed-asset-reference.schema.json index 3b1d4a423..6b9772618 100644 --- a/components/datatypes/media/media-timed-asset-reference.schema.json +++ b/components/datatypes/media/media-timed-asset-reference.schema.json @@ -1,138 +1,146 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed-asset-reference", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Timed media primary asset reference", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Asset information about the main content that was played, but present on all ads and chapters that occur during the content playback.", - "definitions" : { - "media-asset-reference" : { - "properties" : { - "@id" : { - "title" : "Asset ID", - "type" : "string", - "format" : "uri-reference", - "description" : "Identifier of the content, which can be used to tie back to other industry or CMS IDs." - }, - "dc:title" : { - "title" : "Content name", - "type" : "string", - "description" : "The friendly, human-readable name of the timed media asset." - }, - "dc:creator" : { - "title" : "Originator", - "type" : "string", - "description" : "Creator of the content." - }, - "id3:Audio" : { - "title" : "Audio", - "description" : "Metadata specific to audio content (record label, radio station, etc.).", - "$ref" : "https://id3.org/id3v2.4/audio", - "meta:status" : "deprecated" - }, - "xmpDM:artist" : { - "title" : "Artist", - "type" : "string", - "description" : "The name of the album artist or group performing the music recording or video.", - "meta:status" : "deprecated" - }, - "xmpDM:album" : { - "title" : "Album", - "type" : "string", - "description" : "The name of the album that the music recording or video belongs to.", - "meta:status" : "deprecated" - }, - "xdm:Audio" : { - "title" : "Audio", - "description" : "Metadata specific to audio content (record label, radio station, etc.).", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed-audio" - }, - "xmpDM:duration" : { - "title" : "Media content length", - "type" : "integer", - "description" : "Length of primary media asset in seconds." - }, - "xdm:showType" : { - "title" : "Show type", - "type" : "string", - "description" : "The type of content for example, trailer or full episode." - }, - "iptc4xmpExt:Series" : { - "title" : "Series", - "description" : "The series the show belongs to.", - "$ref" : "http://www.iptc.org/series" - }, - "xdm:streamFormat" : { - "title" : "Stream format", - "type" : "string", - "description" : "Free-form format of the stream for example, short or long." - }, - "xdm:streamType" : { - "title" : "Stream type", - "description" : "The type of the media stream", - "type" : "string", - "default" : "video", - "enum" : [ "audio", "video", "gaming" ], - "meta:enum" : { - "audio" : "An audio stream (e.g. podcast, audiobook, radio stream).", - "video" : "A video stream (e.g. Video-On-Demand, live event stream, downloaded movie).", - "gaming" : "A gaming stream (e.g. Twitch, Hitbox)." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-asset-reference", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media primary asset reference", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Asset information about the main content that was played, but present on all ads and chapters that occur during the content playback.", + "definitions": { + "media-asset-reference": { + "properties": { + "@id": { + "title": "Asset ID", + "type": "string", + "format": "uri-reference", + "description": "Identifier of the content, which can be used to tie back to other industry or CMS IDs." + }, + "dc:title": { + "title": "Content name", + "type": "string", + "description": "The friendly, human-readable name of the timed media asset." + }, + "dc:creator": { + "title": "Originator", + "type": "string", + "description": "Creator of the content." + }, + "id3:Audio": { + "title": "Audio", + "description": "Metadata specific to audio content (record label, radio station, etc.).", + "$ref": "https://id3.org/id3v2.4/audio", + "meta:status": "deprecated" + }, + "xmpDM:artist": { + "title": "Artist", + "type": "string", + "description": "The name of the album artist or group performing the music recording or video.", + "meta:status": "deprecated" + }, + "xmpDM:album": { + "title": "Album", + "type": "string", + "description": "The name of the album that the music recording or video belongs to.", + "meta:status": "deprecated" + }, + "xdm:Audio": { + "title": "Audio", + "description": "Metadata specific to audio content (record label, radio station, etc.).", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-audio" + }, + "xmpDM:duration": { + "title": "Media content length", + "type": "integer", + "description": "Length of primary media asset in seconds." + }, + "xdm:showType": { + "title": "Show type", + "type": "string", + "description": "The type of content for example, trailer or full episode." + }, + "iptc4xmpExt:Series": { + "title": "Series", + "description": "The series the show belongs to.", + "$ref": "http://www.iptc.org/series" + }, + "xdm:streamFormat": { + "title": "Stream format", + "type": "string", + "description": "Free-form format of the stream for example, short or long." + }, + "xdm:streamType": { + "title": "Stream type", + "description": "The type of the media stream", + "type": "string", + "default": "video", + "enum": ["audio", "video", "gaming"], + "meta:enum": { + "audio": "An audio stream (e.g. podcast, audiobook, radio stream).", + "video": "A video stream (e.g. Video-On-Demand, live event stream, downloaded movie).", + "gaming": "A gaming stream (e.g. Twitch, Hitbox)." } }, - "iptc4xmpExt:Season" : { - "title" : "Season", - "description" : "The season the show belongs to.", - "$ref" : "http://www.iptc.org/season" - }, - "iptc4xmpExt:Episode" : { - "title" : "Episode", - "description" : "The episode the show belongs to.", - "$ref" : "http://www.iptc.org/episode" - }, - "iptc4xmpExt:Genre" : { - "title" : "Genre", - "description" : "Type or grouping of content as defined by content producer.", - "type" : "array", - "items" : { - "type" : "string" + "iptc4xmpExt:Season": { + "title": "Season", + "description": "The season the show belongs to.", + "$ref": "http://www.iptc.org/season" + }, + "iptc4xmpExt:Episode": { + "title": "Episode", + "description": "The episode the show belongs to.", + "$ref": "http://www.iptc.org/episode" + }, + "iptc4xmpExt:Genre": { + "title": "Genre", + "description": "Type or grouping of content as defined by content producer.", + "type": "array", + "items": { + "type": "string" } }, - "iptc4xmpExt:Rating" : { - "title" : "Content rating", - "description" : "The rating as defined by Parental Guidelines.", - "type" : "array", - "items" : { - "$ref" : "http://www.iptc.org/rating" + "iptc4xmpExt:Rating": { + "title": "Content rating", + "description": "The rating as defined by Parental Guidelines.", + "type": "array", + "items": { + "$ref": "http://www.iptc.org/rating" } }, - "iptc4xmpExt:Creator" : { - "title" : "Creator", - "description" : "Party or parties including person or organization which created the video, refinement by the role attribute.", - "type" : "array", - "items" : { - "$ref" : "http://www.iptc.org/creator" + "iptc4xmpExt:Creator": { + "title": "Creator", + "description": "Party or parties including person or organization which created the video, refinement by the role attribute.", + "type": "array", + "items": { + "$ref": "http://www.iptc.org/creator" } }, - "xdm:firstAirDate" : { - "title" : "First air date", - "type" : "string", - "description" : "The date when the content first aired on television." + "xdm:firstAirDate": { + "title": "First air date", + "type": "string", + "description": "The date when the content first aired on television." }, - "xmpDM:releaseDate" : { - "title" : "First digital date", - "type" : "string", - "description" : "The date when the content first aired on any digital channel or platform." + "xmpDM:releaseDate": { + "title": "First digital date", + "type": "string", + "description": "The date when the content first aired on any digital channel or platform." } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-asset-reference" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-asset-reference" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed-asset-view-details.schema.json b/components/datatypes/media/media-timed-asset-view-details.schema.json index 316cd516a..597409c99 100644 --- a/components/datatypes/media/media-timed-asset-view-details.schema.json +++ b/components/datatypes/media/media-timed-asset-view-details.schema.json @@ -1,128 +1,136 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed-asset-view-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Primary asset view details", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "View details for the main content playback, present on all ads and chapters that occur during the content's playback.", - "definitions" : { - "media-asset-view-details" : { - "properties" : { - "@id" : { - "title" : "Media session ID", - "type" : "string", - "format" : "uri-reference", - "description" : "Identifies an instance of a content stream unique to an individual playback." - }, - "xdm:playerName" : { - "title" : "Content player name", - "type" : "string", - "description" : "Name of the content player." - }, - "xdm:videoSegment" : { - "title" : "Video segment", - "type" : "string", - "pattern" : "^[0-9]+-[0-9]+$", - "description" : "The interval that describes the part of the content that has been viewed in minutes." - }, - "xdm:path" : { - "title" : "Video path", - "type" : "string", - "description" : "The path to the video in the app or site." - }, - "xdm:broadcastChannel" : { - "title" : "Content channel", - "type" : "string", - "description" : "Distribution channel from where the content was played." - }, - "xdm:broadcastContentType" : { - "title" : "Broadcast content type", - "type" : "string", - "description" : "The type of the stream delivery.", - "meta:enum" : { - "VOD" : "Video-on-demand", - "Live" : "Live streaming", - "Linear" : "Linear playback of the media asset", - "UGC" : "User-generated content", - "Radio" : "Radio show", - "Podcast" : "Audio podcast", - "Audiobook" : "Audiobook" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-asset-view-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Primary asset view details", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "View details for the main content playback, present on all ads and chapters that occur during the content's playback.", + "definitions": { + "media-asset-view-details": { + "properties": { + "@id": { + "title": "Media session ID", + "type": "string", + "format": "uri-reference", + "description": "Identifies an instance of a content stream unique to an individual playback." + }, + "xdm:playerName": { + "title": "Content player name", + "type": "string", + "description": "Name of the content player." + }, + "xdm:videoSegment": { + "title": "Video segment", + "type": "string", + "pattern": "^[0-9]+-[0-9]+$", + "description": "The interval that describes the part of the content that has been viewed in minutes." + }, + "xdm:path": { + "title": "Video path", + "type": "string", + "description": "The path to the video in the app or site." + }, + "xdm:broadcastChannel": { + "title": "Content channel", + "type": "string", + "description": "Distribution channel from where the content was played." + }, + "xdm:broadcastContentType": { + "title": "Broadcast content type", + "type": "string", + "description": "The type of the stream delivery.", + "meta:enum": { + "VOD": "Video-on-demand", + "Live": "Live streaming", + "Linear": "Linear playback of the media asset", + "UGC": "User-generated content", + "Radio": "Radio show", + "Podcast": "Audio podcast", + "Audiobook": "Audiobook" } }, - "xdm:playerSDKVersion" : { - "title" : "Player SDK version", - "$ref" : "https://ns.adobe.com/xdm/context/implementationdetails", - "description" : "The SDK version used by the player." - }, - "xdm:vhlVersion" : { - "title" : "VHL version", - "type" : "string", - "description" : "The Media SDK version used for the tracking session." - }, - "xdm:broadcastNetwork" : { - "title" : "Broadcast network", - "type" : "string", - "description" : "The programmer network name." - }, - "xdm:adLoadType" : { - "title" : "Ad load type", - "type" : "string", - "description" : "The type of ad loaded as defined by each customer's internal representation." - }, - "xdm:sourceFeed" : { - "title" : "Feed type", - "type" : "string", - "description" : "The type of feed, which can either represent actual feed-related data such as EAST HD or SD, or the source of the feed like a URL." - }, - "xdm:sessionTimeout" : { - "title" : "Media session server timeout", - "type" : "integer", - "description" : "Indicates the amount of time, in seconds, that passed between the user's last known interaction and the moment the session was closed." - }, - "xdm:qoe" : { - "title" : "Quality of experience", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed-qoe", - "description" : "Timed media properties related to the content playback's quality of experience (QoE)." - }, - "xdm:downloadedPlayback" : { - "title" : "Media downloaded flag", - "type" : "boolean", - "description" : "The stream was played locally on the device after being downloaded." - }, - "xdm:fullScreen" : { - "title" : "Full screen", - "$ref" : "https://ns.adobe.com/xdm/context/player-state", - "description" : "Timed media properties related to full screen player state." - }, - "xdm:mute" : { - "title" : "Mute", - "$ref" : "https://ns.adobe.com/xdm/context/player-state", - "description" : "Timed media properties related to mute player state." - }, - "xdm:closeCaption" : { - "title" : "Close caption", - "$ref" : "https://ns.adobe.com/xdm/context/player-state", - "description" : "Timed media properties related to close caption player state." - }, - "xdm:pictureInPicture" : { - "title" : "Picture in picture", - "$ref" : "https://ns.adobe.com/xdm/context/player-state", - "description" : "Timed media properties related to picture in picture player state." - }, - "xdm:inFocus" : { - "title" : "In focus", - "$ref" : "https://ns.adobe.com/xdm/context/player-state", - "description" : "Timed media properties related to in focus player state." + "xdm:playerSDKVersion": { + "title": "Player SDK version", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "The SDK version used by the player." + }, + "xdm:vhlVersion": { + "title": "VHL version", + "type": "string", + "description": "The Media SDK version used for the tracking session." + }, + "xdm:broadcastNetwork": { + "title": "Broadcast network", + "type": "string", + "description": "The programmer network name." + }, + "xdm:adLoadType": { + "title": "Ad load type", + "type": "string", + "description": "The type of ad loaded as defined by each customer's internal representation." + }, + "xdm:sourceFeed": { + "title": "Feed type", + "type": "string", + "description": "The type of feed, which can either represent actual feed-related data such as EAST HD or SD, or the source of the feed like a URL." + }, + "xdm:sessionTimeout": { + "title": "Media session server timeout", + "type": "integer", + "description": "Indicates the amount of time, in seconds, that passed between the user's last known interaction and the moment the session was closed." + }, + "xdm:qoe": { + "title": "Quality of experience", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-qoe", + "description": "Timed media properties related to the content playback's quality of experience (QoE)." + }, + "xdm:downloadedPlayback": { + "title": "Media downloaded flag", + "type": "boolean", + "description": "The stream was played locally on the device after being downloaded." + }, + "xdm:fullScreen": { + "title": "Full screen", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to full screen player state." + }, + "xdm:mute": { + "title": "Mute", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to mute player state." + }, + "xdm:closeCaption": { + "title": "Close caption", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to close caption player state." + }, + "xdm:pictureInPicture": { + "title": "Picture in picture", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to picture in picture player state." + }, + "xdm:inFocus": { + "title": "In focus", + "$ref": "https://ns.adobe.com/xdm/context/player-state", + "description": "Timed media properties related to in focus player state." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-asset-view-details" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-asset-view-details" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed-audio.schema.json b/components/datatypes/media/media-timed-audio.schema.json index 4ca327ef7..4d7eaebcf 100644 --- a/components/datatypes/media/media-timed-audio.schema.json +++ b/components/datatypes/media/media-timed-audio.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed-audio", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Media audio", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Asset information about the audio content.", - "definitions" : { - "media-asset-reference" : { - "properties" : { - "dc:creator" : { - "title" : "Author", - "type" : "string", - "description" : "Name of the media author." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-audio", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Media audio", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Asset information about the audio content.", + "definitions": { + "media-asset-reference": { + "properties": { + "dc:creator": { + "title": "Author", + "type": "string", + "description": "Name of the media author." }, - "xmpDM:artist" : { - "title" : "Artist", - "type" : "string", - "description" : "The name of the album artist or group performing the music recording or video." + "xmpDM:artist": { + "title": "Artist", + "type": "string", + "description": "The name of the album artist or group performing the music recording or video." }, - "xmpDM:album" : { - "title" : "Album", - "type" : "string", - "description" : "The name of the album that the music recording or video belongs to." + "xmpDM:album": { + "title": "Album", + "type": "string", + "description": "The name of the album that the music recording or video belongs to." }, - "id3:Audio" : { - "title" : "Audio", - "description" : "Metadata specific to audio content (record label, radio station, etc.).", - "$ref" : "https://id3.org/id3v2.4/audio" + "id3:Audio": { + "title": "Audio", + "description": "Metadata specific to audio content (record label, radio station, etc.).", + "$ref": "https://id3.org/id3v2.4/audio" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-asset-reference" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-asset-reference" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed-chapter-asset-reference.schema.json b/components/datatypes/media/media-timed-chapter-asset-reference.schema.json index 6cce5aa2d..4bf4a81a5 100644 --- a/components/datatypes/media/media-timed-chapter-asset-reference.schema.json +++ b/components/datatypes/media/media-timed-chapter-asset-reference.schema.json @@ -1,39 +1,47 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Timed media chapter asset reference", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Asset information about the chapter captured by the experience event.", - "definitions" : { - "media-chapter-asset-reference" : { - "properties" : { - "@id" : { - "title" : "Chapter identity", - "format" : "uri-reference", - "type" : "string", - "description" : "The identity of the chapter." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media chapter asset reference", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Asset information about the chapter captured by the experience event.", + "definitions": { + "media-chapter-asset-reference": { + "properties": { + "@id": { + "title": "Chapter identity", + "format": "uri-reference", + "type": "string", + "description": "The identity of the chapter." }, - "dc:title" : { - "title" : "Chapter name", - "type" : "string", - "description" : "The friendly name of the chapter and or segment." + "dc:title": { + "title": "Chapter name", + "type": "string", + "description": "The friendly name of the chapter and or segment." }, - "xmpDM:duration" : { - "title" : "Chapter length or duration", - "type" : "integer", - "description" : "The length of the chapter, in seconds." + "xmpDM:duration": { + "title": "Chapter length or duration", + "type": "integer", + "description": "The length of the chapter, in seconds." } }, - "required" : [ "@id" ] + "required": ["@id"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-chapter-asset-reference" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-chapter-asset-reference" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed-chapter-view-details.schema.json b/components/datatypes/media/media-timed-chapter-view-details.schema.json index 713c1a04d..5c7f65ac2 100644 --- a/components/datatypes/media/media-timed-chapter-view-details.schema.json +++ b/components/datatypes/media/media-timed-chapter-view-details.schema.json @@ -1,33 +1,41 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed-chapter-view-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Timed media chapter view details", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "View details for the chapter playback captured by the experience event.", - "definitions" : { - "media-chapter-view-details" : { - "properties" : { - "xdm:index" : { - "title" : "Chapter position", - "type" : "integer", - "description" : "The index of the chapter inside the content." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-chapter-view-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media chapter view details", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "View details for the chapter playback captured by the experience event.", + "definitions": { + "media-chapter-view-details": { + "properties": { + "xdm:index": { + "title": "Chapter position", + "type": "integer", + "description": "The index of the chapter inside the content." }, - "xdm:offset" : { - "title" : "Chapter offset", - "type" : "integer", - "description" : "The offset of the chapter, in seconds, inside the content from the start." + "xdm:offset": { + "title": "Chapter offset", + "type": "integer", + "description": "The offset of the chapter, in seconds, inside the content from the start." } }, - "required" : [ "xdm:index", "xdm:offset" ] + "required": ["xdm:index", "xdm:offset"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-chapter-view-details" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-chapter-view-details" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed-chapter.schema.json b/components/datatypes/media/media-timed-chapter.schema.json index fa51e4ff1..86aed7d73 100644 --- a/components/datatypes/media/media-timed-chapter.schema.json +++ b/components/datatypes/media/media-timed-chapter.schema.json @@ -1,57 +1,65 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed-chapter", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Timed media chapter information", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Timed media chapter information.", - "definitions" : { - "media-timed-chapter" : { - "properties" : { - "xdm:chapterAssetReference" : { - "title" : "Chapter asset reference", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference", - "description" : "Asset information about the chapter captured by the experience event." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-chapter", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media chapter information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Timed media chapter information.", + "definitions": { + "media-timed-chapter": { + "properties": { + "xdm:chapterAssetReference": { + "title": "Chapter asset reference", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-chapter-asset-reference", + "description": "Asset information about the chapter captured by the experience event." }, - "xdm:chapterAssetViewDetails" : { - "title" : "Chapter view details", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed-chapter-view-details", - "description" : "View details for the chapter playback captured by the experience event." + "xdm:chapterAssetViewDetails": { + "title": "Chapter view details", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-chapter-view-details", + "description": "View details for the chapter playback captured by the experience event." }, - "xdm:impressions" : { - "title" : "Chapter starts", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed." + "xdm:impressions": { + "title": "Chapter starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed." }, - "xdm:completes" : { - "title" : "Chapter completes", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead." + "xdm:completes": { + "title": "Chapter completes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if a timed media asset was watched to completion - this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead." }, - "xdm:timePlayed" : { - "title" : "Chapter time spent", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the amount of time in seconds spent by a user on a specific timed media asset." + "xdm:timePlayed": { + "title": "Chapter time spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the amount of time in seconds spent by a user on a specific timed media asset." }, - "xdm:federated" : { - "title" : "Chapter federated", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates if an experience event was created through data federation or data sharing." + "xdm:federated": { + "title": "Chapter federated", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if an experience event was created through data federation or data sharing." }, - "xdm:downloadedPlayback" : { - "title" : "Chapter downloaded flag", - "type" : "boolean", - "description" : "Set to true when the hit is generated due to playing a downloaded chapter content session." + "xdm:downloadedPlayback": { + "title": "Chapter downloaded flag", + "type": "boolean", + "description": "Set to true when the hit is generated due to playing a downloaded chapter content session." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-timed-chapter" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-timed-chapter" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed-qoe.schema.json b/components/datatypes/media/media-timed-qoe.schema.json index 9dd46bf9b..8d64f1f83 100644 --- a/components/datatypes/media/media-timed-qoe.schema.json +++ b/components/datatypes/media/media-timed-qoe.schema.json @@ -1,126 +1,134 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed-qoe", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Timed media quality of experience", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Timed media properties related to the content playback's quality of experience (QoE).", - "definitions" : { - "media-timed-qoe" : { - "properties" : { - "xdm:errors" : { - "title" : "Errors", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of errors that were encountered during playback." - }, - "xdm:buffers" : { - "title" : "Buffer events", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of buffer states that occurred during a playback session." - }, - "xdm:bufferTime" : { - "title" : "Total buffer duration", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the total amount of time in seconds, spent buffering." - }, - "xdm:bufferImpactedStreams" : { - "title" : "Buffer impacted streams", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of streams impacted by buffering." - }, - "xdm:stalls" : { - "title" : "Stalling events", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of stall states that occurred during a playback session." - }, - "xdm:stallTime" : { - "title" : "Total stalling duration", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the duration in seconds in which the playback was stalled during playback." - }, - "xdm:stallingImpactedStreams" : { - "title" : "Stalling impacted streams", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of streams impacted by stalling." - }, - "xdm:bitrateChanges" : { - "title" : "Bitrate changes", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of bitrate change events that occurred during a playback session." - }, - "xdm:bitrateAverage" : { - "title" : "Average bitrate", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "A weighted average of all bitrate values related to the play duration that occurred during a playback session." - }, - "xdm:bitrateAverageBucket" : { - "title" : "Average bitrate bucket", - "type" : "string", - "description" : "The average bitrate (in kbps). The value is predefined buckets at 100kbps intervals." - }, - "xdm:bitrateChangeImpactedStreams" : { - "title" : "Bitrate change impacted streams", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of streams in which bitrate changes occurred." - }, - "xdm:droppedFrames" : { - "title" : "Dropped frames", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of frames dropped during playback of the main content." - }, - "xdm:droppedFrameImpactedStreams" : { - "title" : "Dropped frame impacted streams", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of streams in which frames were dropped." - }, - "xdm:dropBeforeStarts" : { - "title" : "Drops before starts", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN." - }, - "xdm:timeToStart" : { - "title" : "Time to start", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the duration (in seconds) passed between video load and start." - }, - "xdm:playerSdkErrors" : { - "title" : "Player SDK Error IDs", - "type" : "array", - "items" : { - "type" : "string" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed-qoe", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media quality of experience", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Timed media properties related to the content playback's quality of experience (QoE).", + "definitions": { + "media-timed-qoe": { + "properties": { + "xdm:errors": { + "title": "Errors", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of errors that were encountered during playback." + }, + "xdm:buffers": { + "title": "Buffer events", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of buffer states that occurred during a playback session." + }, + "xdm:bufferTime": { + "title": "Total buffer duration", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the total amount of time in seconds, spent buffering." + }, + "xdm:bufferImpactedStreams": { + "title": "Buffer impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams impacted by buffering." + }, + "xdm:stalls": { + "title": "Stalling events", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of stall states that occurred during a playback session." + }, + "xdm:stallTime": { + "title": "Total stalling duration", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the duration in seconds in which the playback was stalled during playback." + }, + "xdm:stallingImpactedStreams": { + "title": "Stalling impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams impacted by stalling." + }, + "xdm:bitrateChanges": { + "title": "Bitrate changes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of bitrate change events that occurred during a playback session." + }, + "xdm:bitrateAverage": { + "title": "Average bitrate", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "A weighted average of all bitrate values related to the play duration that occurred during a playback session." + }, + "xdm:bitrateAverageBucket": { + "title": "Average bitrate bucket", + "type": "string", + "description": "The average bitrate (in kbps). The value is predefined buckets at 100kbps intervals." + }, + "xdm:bitrateChangeImpactedStreams": { + "title": "Bitrate change impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams in which bitrate changes occurred." + }, + "xdm:droppedFrames": { + "title": "Dropped frames", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of frames dropped during playback of the main content." + }, + "xdm:droppedFrameImpactedStreams": { + "title": "Dropped frame impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams in which frames were dropped." + }, + "xdm:dropBeforeStarts": { + "title": "Drops before starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN." + }, + "xdm:timeToStart": { + "title": "Time to start", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the duration (in seconds) passed between video load and start." + }, + "xdm:playerSdkErrors": { + "title": "Player SDK Error IDs", + "type": "array", + "items": { + "type": "string" }, - "description" : "The error IDs encountered during a playback session that originated in the Player." + "description": "The error IDs encountered during a playback session that originated in the Player." }, - "xdm:mediaSdkErrors" : { - "title" : "Media SDK Error IDs", - "type" : "array", - "items" : { - "type" : "string" + "xdm:mediaSdkErrors": { + "title": "Media SDK Error IDs", + "type": "array", + "items": { + "type": "string" }, - "description" : "The error IDs encountered during a playback session that originated in the Media SDK." + "description": "The error IDs encountered during a playback session that originated in the Media SDK." }, - "xdm:externalSdkErrors" : { - "title" : "External Error IDs", - "type" : "array", - "items" : { - "type" : "string" + "xdm:externalSdkErrors": { + "title": "External Error IDs", + "type": "array", + "items": { + "type": "string" }, - "description" : "The error IDs encountered during a playback session that originated outside the Player or SDK." + "description": "The error IDs encountered during a playback session that originated outside the Player or SDK." }, - "xdm:errorImpactedStreams" : { - "title" : "Error impacted streams", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of streams in which an error event occurred." + "xdm:errorImpactedStreams": { + "title": "Error impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of streams in which an error event occurred." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-timed-qoe" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-timed-qoe" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media-timed.schema.json b/components/datatypes/media/media-timed.schema.json index ec2aadfe8..d913bf9d1 100644 --- a/components/datatypes/media/media-timed.schema.json +++ b/components/datatypes/media/media-timed.schema.json @@ -1,164 +1,172 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media-timed", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Timed media information", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Information related to timed media such main content, ads, and chapters.", - "definitions" : { - "media-timed" : { - "properties" : { - "xdm:primaryAssetReference" : { - "title" : "Primary asset reference", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed-asset-reference", - "description" : "Asset information about the main content that was played, present on all ads and chapters that occur during the content's playback." - }, - "xdm:primaryAssetViewDetails" : { - "title" : "Primary asset view details", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed-asset-view-details", - "description" : "View details for the main content playback, present on all ads and chapters that occur during the content's playback." - }, - "xdm:mediaChapter" : { - "title" : "Media chapter", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed-chapter", - "description" : "Timed media chapter information." - }, - "xdm:impressions" : { - "title" : "Media starts", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed." - }, - "xdm:completes" : { - "title" : "Content completes", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates if a timed media asset was watched to completion, this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead." - }, - "xdm:timePlayed" : { - "title" : "Content time spent", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The amount of time spent in seconds by a user on a specific timed media asset." - }, - "xdm:federated" : { - "title" : "Media federated", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates the experience event was created through data federation or data sharing." - }, - "xdm:starts" : { - "title" : "Content starts", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates the first frame of the timed media asset has been viewed for example, the viewer did not abandon during pre-roll ad, or buffering." - }, - "xdm:mediaSegmentViews" : { - "title" : "Media segment views", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates when at least one frame, not necessarily the first has been viewed." - }, - "xdm:dropBeforeStarts" : { - "title" : "Drops before starts", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN.", - "meta:status" : "deprecated" - }, - "xdm:totalTimePlayed" : { - "title" : "Media Time Spent", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads." - }, - "xdm:uniqueTimePlayed" : { - "title" : "Unique Time Played", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the sum of the unique intervals seen by a user on a timed media asset - i.e. the length playback intervals viewed multiple times are only counted once." - }, - "xdm:averageMinuteAudience" : { - "title" : "Average Minute Audience", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the average content time spent for a specific media item - i.e. the total content time spent divided by the length for all of the playback sessions." - }, - "xdm:adCount" : { - "title" : "Ad count", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of ads started during the playback." - }, - "xdm:chapterCount" : { - "title" : "Chapter count", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of chapters started during the playback." - }, - "xdm:progress10" : { - "title" : "10% Progress marker", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." - }, - "xdm:progress25" : { - "title" : "25% Progress marker", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates that the playhead passed the 25% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." - }, - "xdm:progress50" : { - "title" : "50% Progress marker", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates that the playhead passed the 50% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." - }, - "xdm:progress75" : { - "title" : "75% Progress marker", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates that the playhead passed the 75% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." - }, - "xdm:progress95" : { - "title" : "95% Progress marker", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates that the playhead passed the 95% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." - }, - "xdm:resumes" : { - "title" : "Content resumes", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period." - }, - "xdm:estimatedStreams" : { - "title" : "Estimated streams", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The estimated number of video or audio streams per each individual content." - }, - "xdm:pauseImpactedStreams" : { - "title" : "Pause impacted streams", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Indicates if one or more pauses occurred during the playback of a single media item." - }, - "xdm:pauses" : { - "title" : "Pause events", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "The number of pause periods that occurred during playback." - }, - "xdm:pauseTime" : { - "title" : "Total pause duration", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Describes the duration in seconds in which playback was paused by the user." - }, - "xdm:idp" : { - "title" : "MVPD Identifier", - "type" : "string", - "description" : "The MVPD (Multichannel Video Programming Distributor) provided via authentication. [https://en.wikipedia.org/?title=MVPD]" - }, - "xdm:mediaAuth" : { - "title" : "Media authorized", - "type" : "string", - "description" : "The user has been authorized via authentication." - }, - "xdm:dayPart" : { - "title" : "Day part", - "type" : "string", - "description" : "Defines the time of the day when the content was broadcast or played." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media-timed", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Timed media information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Information related to timed media such main content, ads, and chapters.", + "definitions": { + "media-timed": { + "properties": { + "xdm:primaryAssetReference": { + "title": "Primary asset reference", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-asset-reference", + "description": "Asset information about the main content that was played, present on all ads and chapters that occur during the content's playback." + }, + "xdm:primaryAssetViewDetails": { + "title": "Primary asset view details", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-asset-view-details", + "description": "View details for the main content playback, present on all ads and chapters that occur during the content's playback." + }, + "xdm:mediaChapter": { + "title": "Media chapter", + "$ref": "https://ns.adobe.com/xdm/context/media-timed-chapter", + "description": "Timed media chapter information." + }, + "xdm:impressions": { + "title": "Media starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the intention to play a timed media asset. It does not measure success, as the user might abandon the content before the first frame is viewed." + }, + "xdm:completes": { + "title": "Content completes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if a timed media asset was watched to completion, this does not necessarily mean the viewer watched the whole video; viewer could have skipped ahead." + }, + "xdm:timePlayed": { + "title": "Content time spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The amount of time spent in seconds by a user on a specific timed media asset." + }, + "xdm:federated": { + "title": "Media federated", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the experience event was created through data federation or data sharing." + }, + "xdm:starts": { + "title": "Content starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the first frame of the timed media asset has been viewed for example, the viewer did not abandon during pre-roll ad, or buffering." + }, + "xdm:mediaSegmentViews": { + "title": "Media segment views", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates when at least one frame, not necessarily the first has been viewed." + }, + "xdm:dropBeforeStarts": { + "title": "Drops before starts", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates the user abandoned the media stream before the first frame for example, during the pre-roll ad break, or due to an error while loading the content from the CDN.", + "meta:status": "deprecated" + }, + "xdm:totalTimePlayed": { + "title": "Media Time Spent", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the total amount of time spent by a user on a specific timed media asset, which includes time spent watching ads." + }, + "xdm:uniqueTimePlayed": { + "title": "Unique Time Played", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the sum of the unique intervals seen by a user on a timed media asset - i.e. the length playback intervals viewed multiple times are only counted once." + }, + "xdm:averageMinuteAudience": { + "title": "Average Minute Audience", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the average content time spent for a specific media item - i.e. the total content time spent divided by the length for all of the playback sessions." + }, + "xdm:adCount": { + "title": "Ad count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of ads started during the playback." + }, + "xdm:chapterCount": { + "title": "Chapter count", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of chapters started during the playback." + }, + "xdm:progress10": { + "title": "10% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 10% marker of media based on stream length. The marker is only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress25": { + "title": "25% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 25% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress50": { + "title": "50% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 50% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress75": { + "title": "75% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 75% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:progress95": { + "title": "95% Progress marker", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates that the playhead passed the 95% marker of media based on stream length. Marker only counted once, even if seeking backwards. If seeking forward, markers that are skipped are not counted." + }, + "xdm:resumes": { + "title": "Content resumes", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Marks each playback that was resumed after more than 30 minutes of buffer, pause, or stall period." + }, + "xdm:estimatedStreams": { + "title": "Estimated streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The estimated number of video or audio streams per each individual content." + }, + "xdm:pauseImpactedStreams": { + "title": "Pause impacted streams", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Indicates if one or more pauses occurred during the playback of a single media item." + }, + "xdm:pauses": { + "title": "Pause events", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "The number of pause periods that occurred during playback." + }, + "xdm:pauseTime": { + "title": "Total pause duration", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Describes the duration in seconds in which playback was paused by the user." + }, + "xdm:idp": { + "title": "MVPD Identifier", + "type": "string", + "description": "The MVPD (Multichannel Video Programming Distributor) provided via authentication. [https://en.wikipedia.org/?title=MVPD]" + }, + "xdm:mediaAuth": { + "title": "Media authorized", + "type": "string", + "description": "The user has been authorized via authentication." + }, + "xdm:dayPart": { + "title": "Day part", + "type": "string", + "description": "Defines the time of the day when the content was broadcast or played." } }, - "required" : [ "xdm:primaryAssetReference" ] + "required": ["xdm:primaryAssetReference"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media-timed" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media-timed" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/media/media.schema.json b/components/datatypes/media/media.schema.json index 6f33395e1..7bb0f63bc 100644 --- a/components/datatypes/media/media.schema.json +++ b/components/datatypes/media/media.schema.json @@ -1,27 +1,35 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/media", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Media information", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Media context information for content related interactions.", - "definitions" : { - "media" : { - "properties" : { - "xdm:mediaTimed" : { - "title" : "Timed media information", - "$ref" : "https://ns.adobe.com/xdm/context/media-timed", - "description" : "Information related to timed media main content, such as ads and chapters." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/media", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Media information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Media context information for content related interactions.", + "definitions": { + "media": { + "properties": { + "xdm:mediaTimed": { + "title": "Timed media information", + "$ref": "https://ns.adobe.com/xdm/context/media-timed", + "description": "Information related to timed media main content, such as ads and chapters." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/media" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/media" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/namespace.schema.json b/components/datatypes/namespace.schema.json index c931c667c..b49b89d8b 100644 --- a/components/datatypes/namespace.schema.json +++ b/components/datatypes/namespace.schema.json @@ -1,28 +1,36 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/namespace", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Namespace", - "type" : "object", - "meta:extensible" : true, - "description" : "", - "definitions" : { - "namespace" : { - "properties" : { - "xdm:code" : { - "title" : "Code", - "type" : "string", - "description" : "The code is a human readable identifier for the namespace and can be used to request the technical namespace id which is used for identity graph processing." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/namespace", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Namespace", + "type": "object", + "meta:extensible": true, + "description": "", + "definitions": { + "namespace": { + "properties": { + "xdm:code": { + "title": "Code", + "type": "string", + "description": "The code is a human readable identifier for the namespace and can be used to request the technical namespace id which is used for identity graph processing." } }, - "required" : [ "xdm:code" ] + "required": ["xdm:code"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/namespace" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/namespace" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/optinout-additional-details.schema.json b/components/datatypes/optinout-additional-details.schema.json index 039f5f6a3..a8cc7e143 100644 --- a/components/datatypes/optinout-additional-details.schema.json +++ b/components/datatypes/optinout-additional-details.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/optinout-additional-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "OptOut Additional Details", - "type" : "object", - "description" : "Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel.", - "definitions" : { - "optinout-additional-details" : { - "properties" : { - "xdm:optOutReason" : { - "title" : "Opt Out Reason", - "description" : "Reason for opting out for a notification.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/optinout-additional-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "OptOut Additional Details", + "type": "object", + "description": "Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel.", + "definitions": { + "optinout-additional-details": { + "properties": { + "xdm:optOutReason": { + "title": "Opt Out Reason", + "description": "Reason for opting out for a notification.", + "type": "string" }, - "xdm:optOutDate" : { - "title" : "Opt Out Date", - "description" : "Date of opting out for a notification.", - "type" : "string", - "format" : "date-time" + "xdm:optOutDate": { + "title": "Opt Out Date", + "description": "Date of opting out for a notification.", + "type": "string", + "format": "date-time" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/optinout-additional-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-08-18" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/optinout-additional-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-08-18" +} diff --git a/components/datatypes/optinout.schema.json b/components/datatypes/optinout.schema.json index 740f929f9..cf72e84f7 100644 --- a/components/datatypes/optinout.schema.json +++ b/components/datatypes/optinout.schema.json @@ -1,325 +1,333 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/optinout", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "OptInOut", - "type" : "object", - "description" : "Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel.", - "definitions" : { - "optinout" : { - "properties" : { - "https://ns.adobe.com/xdm/channels/adm" : { - "title" : "Amazon Device Messaging", - "description" : "Amazon Device Messaging (ADM) channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/optinout", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "OptInOut", + "type": "object", + "description": "Describes user communication preferences by channel. For each channel individually, which is a property of this object, a user's preference such as opt-in, opt-out, or pending can be recorded. In addition, a global override opt-out is possible. Each property of this schema must be a valid and known URI for an XDM Channel.", + "definitions": { + "optinout": { + "properties": { + "https://ns.adobe.com/xdm/channels/adm": { + "title": "Amazon Device Messaging", + "description": "Amazon Device Messaging (ADM) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/agency" : { - "title" : "Agency", - "description" : "External agency channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/agency": { + "title": "Agency", + "description": "External agency channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/apns" : { - "title" : "Apple Push Notification Service", - "description" : "Apple Push Notification Service (APNS) channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/apns": { + "title": "Apple Push Notification Service", + "description": "Apple Push Notification Service (APNS) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/application" : { - "title" : "Application", - "description" : "Application channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/application": { + "title": "Application", + "description": "Application channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/baidu" : { - "title" : "Baidu Cloud Push Service", - "description" : "Baidu Cloud Push Service channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/baidu": { + "title": "Baidu Cloud Push Service", + "description": "Baidu Cloud Push Service channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/channel" : { - "title" : "Experience Channel", - "description" : "Experience channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/channel": { + "title": "Experience Channel", + "description": "Experience channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/direct-mail" : { - "title" : "Direct mail", - "description" : "Mail delivered by a postal service channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/direct-mail": { + "title": "Direct mail", + "description": "Mail delivered by a postal service channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/email" : { - "title" : "Email", - "description" : "Email messages, delivered via SMTP to list subscribers channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/email": { + "title": "Email", + "description": "Email messages, delivered via SMTP to list subscribers channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/facebook-feed" : { - "title" : "Facebook news feed", - "description" : "The Facebook news feed channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/facebook-feed": { + "title": "Facebook news feed", + "description": "The Facebook news feed channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/fax" : { - "title" : "Fax", - "description" : "Fax or telefacsimile channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/fax": { + "title": "Fax", + "description": "Fax or telefacsimile channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/gcm" : { - "title" : "Google Cloud Messaging", - "description" : "Google Cloud Messaging (GCM) channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/gcm": { + "title": "Google Cloud Messaging", + "description": "Google Cloud Messaging (GCM) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/line" : { - "title" : "Line Platform Notification", - "description" : "Line Platform Notification (LINE) channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/line": { + "title": "Line Platform Notification", + "description": "Line Platform Notification (LINE) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/mobile-app" : { - "title" : "Web", - "description" : "Native mobile applications that are installed through an app store channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/mobile-app": { + "title": "Web", + "description": "Native mobile applications that are installed through an app store channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/mpns" : { - "title" : "Microsoft Push Notification Service", - "description" : "Microsoft Push Notification Service (MPNS) channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/mpns": { + "title": "Microsoft Push Notification Service", + "description": "Microsoft Push Notification Service (MPNS) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/phone" : { - "title" : "Phone", - "description" : "The telephone channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/phone": { + "title": "Phone", + "description": "The telephone channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/sms" : { - "title" : "SMS", - "description" : "Short Message Service delivered to a mobile phone channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/sms": { + "title": "SMS", + "description": "Short Message Service delivered to a mobile phone channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/twitter-feed" : { - "title" : "Twitter feed", - "description" : "Twitter feed channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/twitter-feed": { + "title": "Twitter feed", + "description": "Twitter feed channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/web" : { - "title" : "Web", - "description" : "World Wide Web and mobile web channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/web": { + "title": "Web", + "description": "World Wide Web and mobile web channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/webpage" : { - "title" : "Web Page", - "description" : "Web Page channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/webpage": { + "title": "Web Page", + "description": "Web Page channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/wechat" : { - "title" : "WeChat", - "description" : "WeChat Platform Notification channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/wechat": { + "title": "WeChat", + "description": "WeChat Platform Notification channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "https://ns.adobe.com/xdm/channels/wns" : { - "title" : "Windows Push Notification Service", - "description" : "Windows Push Notification Service (WNS) channel OptInOut.", - "type" : "string", - "default" : "not_provided", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in: the user explicitly consents to receiving messages.", - "out" : "Opt-out: the user declines to receive any messages on this channel." + "https://ns.adobe.com/xdm/channels/wns": { + "title": "Windows Push Notification Service", + "description": "Windows Push Notification Service (WNS) channel OptInOut.", + "type": "string", + "default": "not_provided", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in: the user explicitly consents to receiving messages.", + "out": "Opt-out: the user declines to receive any messages on this channel." } }, - "xdm:globalOptout" : { - "title" : "Global Opt-out", - "type" : "boolean", - "description" : "Do not contact this profile on any outbound channel.", - "default" : false + "xdm:globalOptout": { + "title": "Global Opt-out", + "type": "boolean", + "description": "Do not contact this profile on any outbound channel.", + "default": false }, - "xdm:optOutDetails" : { - "type" : "object", - "properties" : { - "xdm:email" : { - "title" : "Additional Details for Email Opt Out", - "description" : "Additional Details for Email Opt Out like reason, date.", - "$ref" : "https://ns.adobe.com/xdm/common/optinout-additional-details" + "xdm:optOutDetails": { + "type": "object", + "properties": { + "xdm:email": { + "title": "Additional Details for Email Opt Out", + "description": "Additional Details for Email Opt Out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" }, - "xdm:phone" : { - "title" : "Additional Details for Phone Opt Out", - "description" : "Additional details for phone opt out like reason, date.", - "$ref" : "https://ns.adobe.com/xdm/common/optinout-additional-details" + "xdm:phone": { + "title": "Additional Details for Phone Opt Out", + "description": "Additional details for phone opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" }, - "xdm:fax" : { - "title" : "Additional Details for Fax Opt Out", - "description" : "Additional details for fax opt out like reason, date.", - "$ref" : "https://ns.adobe.com/xdm/common/optinout-additional-details" + "xdm:fax": { + "title": "Additional Details for Fax Opt Out", + "description": "Additional details for fax opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" }, - "xdm:direct-mail" : { - "title" : "Additional Details for Direct-Mail Opt Out", - "description" : "Additional details for direct-mail opt out like reason, date.", - "$ref" : "https://ns.adobe.com/xdm/common/optinout-additional-details" + "xdm:direct-mail": { + "title": "Additional Details for Direct-Mail Opt Out", + "description": "Additional details for direct-mail opt out like reason, date.", + "$ref": "https://ns.adobe.com/xdm/common/optinout-additional-details" } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/optinout" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/optinout" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/page.schema.json b/components/datatypes/page.schema.json index 085919683..95589b206 100644 --- a/components/datatypes/page.schema.json +++ b/components/datatypes/page.schema.json @@ -1,51 +1,58 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/page", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Page", - "type" : "object", - "description" : "Page object contains paging information for related resource when resource result is paginated.", - "definitions" : { - "page" : { - "properties" : { - "orderBy" : { - "title" : "Order by Property", - "type" : "string", - "description" : "The `orderBy` parameter specifies the comma-separated (no spaces after comma) list of properties by which the resource should be sorted. The properties by which to sort are listed in priority order. The first property is used for primary sorting, the second property to resolve ties in primary sorting, etc. The name of a property may be prefixed with a `+` to indicate ascending ordering or `-` to indicate descending ordering by that property. If the property name is not prefixed the result is sorted in ascending order. If `orderBy` is not given or does not name a property supported to sort by, the order is indeterminate and the service may return the elements in any order." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/page", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Page", + "type": "object", + "description": "Page object contains paging information for related resource when resource result is paginated.", + "definitions": { + "page": { + "properties": { + "orderBy": { + "title": "Order by Property", + "type": "string", + "description": "The `orderBy` parameter specifies the comma-separated (no spaces after comma) list of properties by which the resource should be sorted. The properties by which to sort are listed in priority order. The first property is used for primary sorting, the second property to resolve ties in primary sorting, etc. The name of a property may be prefixed with a `+` to indicate ascending ordering or `-` to indicate descending ordering by that property. If the property name is not prefixed the result is sorted in ascending order. If `orderBy` is not given or does not name a property supported to sort by, the order is indeterminate and the service may return the elements in any order." }, - "start" : { - "title" : "First Value", - "type" : "string", - "description" : "The first value, in sorted order, of the `orderby` property on this page." + "start": { + "title": "First Value", + "type": "string", + "description": "The first value, in sorted order, of the `orderby` property on this page." }, - "next" : { - "title" : "Next Page Start Value", - "type" : "string", - "description" : "The start value for the next page." + "next": { + "title": "Next Page Start Value", + "type": "string", + "description": "The start value for the next page." }, - "property" : { - "title" : "Filter Properties", - "type" : "string", - "description" : "The list of properties by which the result is filtered, if any.\nThis list is comma-separated (no spaces after comma). The resulting list will only include entries for which the filtered property has been defined. " + "property": { + "title": "Filter Properties", + "type": "string", + "description": "The list of properties by which the result is filtered, if any.\nThis list is comma-separated (no spaces after comma). The resulting list will only include entries for which the filtered property has been defined. " }, - "type" : { - "title" : "Filter Type Value", - "type" : "string", - "description" : "The applied type filtering value, if any. Unlike `property` which allows to filter for presence of any property, `type` filters only for the specific value of the `type` attribute, i.e. the media type. This is a literal filter without any globbing or pattern matching." + "type": { + "title": "Filter Type Value", + "type": "string", + "description": "The applied type filtering value, if any. Unlike `property` which allows to filter for presence of any property, `type` filters only for the specific value of the `type` attribute, i.e. the media type. This is a literal filter without any globbing or pattern matching." }, - "count" : { - "title" : "Number of Items", - "type" : "integer", - "minimum" : 0, - "description" : "The number of items on this page." + "count": { + "title": "Number of Items", + "type": "integer", + "minimum": 0, + "description": "The number of items on this page." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/page" - } ], - "required" : [ "orderBy", "start", "next", "count" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/page" + } + ], + "required": ["orderBy", "start", "next", "count"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/person/person-name.schema.json b/components/datatypes/person/person-name.schema.json index 1ed322dc1..9feee6205 100644 --- a/components/datatypes/person/person-name.schema.json +++ b/components/datatypes/person/person-name.schema.json @@ -1,52 +1,60 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/person-name", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Person name", - "type" : "object", - "meta:extensible" : true, - "description" : "Full name of a person.", - "definitions" : { - "personname" : { - "properties" : { - "xdm:firstName" : { - "title" : "First name", - "type" : "string", - "description" : "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/person-name", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Person name", + "type": "object", + "meta:extensible": true, + "description": "Full name of a person.", + "definitions": { + "personname": { + "properties": { + "xdm:firstName": { + "title": "First name", + "type": "string", + "description": "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." }, - "xdm:lastName" : { - "title" : "Last name", - "type" : "string", - "description" : "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." + "xdm:lastName": { + "title": "Last name", + "type": "string", + "description": "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." }, - "xdm:middleName" : { - "title" : "Middle name", - "type" : "string", - "description" : "Middle, alternative, or additional names supplied between the first name and last name." + "xdm:middleName": { + "title": "Middle name", + "type": "string", + "description": "Middle, alternative, or additional names supplied between the first name and last name." }, - "xdm:courtesyTitle" : { - "title" : "Courtesy title", - "type" : "string", - "description" : "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr." + "xdm:courtesyTitle": { + "title": "Courtesy title", + "type": "string", + "description": "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr." }, - "xdm:suffix" : { - "title" : "Suffix", - "type" : "string", - "description" : "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc." + "xdm:suffix": { + "title": "Suffix", + "type": "string", + "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc." }, - "xdm:fullName" : { - "title" : "Full name", - "type" : "string", - "description" : "The full name of the person, in writing order most commonly accepted in the language of the name." + "xdm:fullName": { + "title": "Full name", + "type": "string", + "description": "The full name of the person, in writing order most commonly accepted in the language of the name." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/personname" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/personname" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/person/person.schema.json b/components/datatypes/person/person.schema.json index 7bd5980c8..f527d5030 100644 --- a/components/datatypes/person/person.schema.json +++ b/components/datatypes/person/person.schema.json @@ -1,85 +1,93 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/person", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Person", - "type" : "object", - "meta:extensible" : true, - "meta:auditable" : true, - "description" : "An individual person. May represent a person acting in various roles, such as a customer, contact, or owner.", - "definitions" : { - "person" : { - "properties" : { - "xdm:name" : { - "title" : "Full name", - "$ref" : "https://ns.adobe.com/xdm/context/person-name", - "description" : "The person's full name." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/person", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Person", + "type": "object", + "meta:extensible": true, + "meta:auditable": true, + "description": "An individual person. May represent a person acting in various roles, such as a customer, contact, or owner.", + "definitions": { + "person": { + "properties": { + "xdm:name": { + "title": "Full name", + "$ref": "https://ns.adobe.com/xdm/context/person-name", + "description": "The person's full name." }, - "xdm:birthDate" : { - "title" : "Birth date", - "type" : "string", - "format" : "date", - "description" : "The full date a person was born." + "xdm:birthDate": { + "title": "Birth date", + "type": "string", + "format": "date", + "description": "The full date a person was born." }, - "xdm:birthDayAndMonth" : { - "title" : "Birth date", - "type" : "string", - "pattern" : "[0-1][0-9]-[0-9][0-9]", - "description" : "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year." + "xdm:birthDayAndMonth": { + "title": "Birth date", + "type": "string", + "pattern": "[0-1][0-9]-[0-9][0-9]", + "description": "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year." }, - "xdm:birthYear" : { - "title" : "Birth year", - "type" : "integer", - "description" : "The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date.", - "minimum" : 1, - "maximum" : 32767 + "xdm:birthYear": { + "title": "Birth year", + "type": "integer", + "description": "The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date.", + "minimum": 1, + "maximum": 32767 }, - "xdm:gender" : { - "title" : "Gender", - "type" : "string", - "enum" : [ "male", "female", "not_specified", "non_specific" ], - "meta:enum" : { - "male" : "Male", - "female" : "Female", - "not_specified" : "Not Specified", - "non_specific" : "Non-specific" + "xdm:gender": { + "title": "Gender", + "type": "string", + "enum": ["male", "female", "not_specified", "non_specific"], + "meta:enum": { + "male": "Male", + "female": "Female", + "not_specified": "Not Specified", + "non_specific": "Non-specific" }, - "description" : "Gender identity of the person.\n", - "default" : "not_specified" + "description": "Gender identity of the person.\n", + "default": "not_specified" }, - "xdm:maritalStatus" : { - "title" : "Marital Status", - "type" : "string", - "enum" : [ "married", "single", "divorced", "widowed", "not_specified" ], - "meta:enum" : { - "married" : "Married", - "single" : "Single", - "divorced" : "Divorced", - "widowed" : "Widowed", - "not_specified" : "Not Specified" + "xdm:maritalStatus": { + "title": "Marital Status", + "type": "string", + "enum": ["married", "single", "divorced", "widowed", "not_specified"], + "meta:enum": { + "married": "Married", + "single": "Single", + "divorced": "Divorced", + "widowed": "Widowed", + "not_specified": "Not Specified" }, - "description" : "Describes a person's relationship with a significant other.", - "default" : "not_specified" + "description": "Describes a person's relationship with a significant other.", + "default": "not_specified" }, - "xdm:nationality" : { - "title" : "Nationality", - "type" : "string", - "pattern" : "^[A-Z]{2}$", - "description" : "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code." + "xdm:nationality": { + "title": "Nationality", + "type": "string", + "pattern": "^[A-Z]{2}$", + "description": "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code." }, - "xdm:taxId" : { - "title" : "Tax ID", - "type" : "string", - "description" : "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain." + "xdm:taxId": { + "title": "Tax ID", + "type": "string", + "description": "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/person" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/person" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/placecontext.schema.json b/components/datatypes/placecontext.schema.json index 96eb25315..32e4fa318 100644 --- a/components/datatypes/placecontext.schema.json +++ b/components/datatypes/placecontext.schema.json @@ -1,58 +1,66 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/placecontext", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Place context", - "type" : "object", - "meta:extensible" : true, - "description" : "", - "definitions" : { - "placecontext" : { - "properties" : { - "xdm:localTime" : { - "title" : "Local time", - "type" : "string", - "format" : "date-time", - "description" : "The local time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/placecontext", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Place context", + "type": "object", + "meta:extensible": true, + "description": "", + "definitions": { + "placecontext": { + "properties": { + "xdm:localTime": { + "title": "Local time", + "type": "string", + "format": "date-time", + "description": "The local time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." }, - "xdm:ianaTimezone" : { - "title" : "Iana Timezone", - "type" : "string", - "description" : "Timezone of the device represented as a standard timezone string. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones." + "xdm:ianaTimezone": { + "title": "Iana Timezone", + "type": "string", + "description": "Timezone of the device represented as a standard timezone string. https://en.wikipedia.org/wiki/List_of_tz_database_time_zones." }, - "xdm:localTimezoneOffset" : { - "title" : "Local time zone offset", - "type" : "integer", - "description" : "The current, local time zone offset in minutes from UTC for the localTime in this object. This will include the current DST offset if applicable." + "xdm:localTimezoneOffset": { + "title": "Local time zone offset", + "type": "integer", + "description": "The current, local time zone offset in minutes from UTC for the localTime in this object. This will include the current DST offset if applicable." }, - "xdm:geo" : { - "title" : "Geo", - "$ref" : "https://ns.adobe.com/xdm/common/geo", - "description" : "The geographic location where the experience was delivered." + "xdm:geo": { + "title": "Geo", + "$ref": "https://ns.adobe.com/xdm/common/geo", + "description": "The geographic location where the experience was delivered." }, - "xdm:POIinteraction" : { - "title" : "POI interaction", - "description" : "The point of interest (POI) interaction details.", - "meta:status" : "experimental", - "$ref" : "https://ns.adobe.com/xdm/context/poi-interaction" + "xdm:POIinteraction": { + "title": "POI interaction", + "description": "The point of interest (POI) interaction details.", + "meta:status": "experimental", + "$ref": "https://ns.adobe.com/xdm/context/poi-interaction" }, - "xdm:activePOIs" : { - "title" : "POI detail", - "description" : "Details of the points of interest (POIs) that cause the event.", - "meta:status" : "experimental", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/poi-detail" + "xdm:activePOIs": { + "title": "POI detail", + "description": "Details of the points of interest (POIs) that cause the event.", + "meta:status": "experimental", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/poi-detail" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/placecontext" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/placecontext" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/player-state.schema.json b/components/datatypes/player-state.schema.json index cbbf3b0a6..18c67f1fe 100644 --- a/components/datatypes/player-state.schema.json +++ b/components/datatypes/player-state.schema.json @@ -1,39 +1,47 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/player-state", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Player state information", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "Information related to player state.", - "definitions" : { - "player-state" : { - "properties" : { - "xdm:playerStateSet" : { - "title" : "Player state set", - "type" : "boolean", - "description" : "Whether or not the player state is set on that state." + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/player-state", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Player state information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "Information related to player state.", + "definitions": { + "player-state": { + "properties": { + "xdm:playerStateSet": { + "title": "Player state set", + "type": "boolean", + "description": "Whether or not the player state is set on that state." }, - "xdm:playerStateCount" : { - "title" : "Player state count", - "type" : "integer", - "minimum" : 0, - "description" : "The number of times that player state was set on the stream." + "xdm:playerStateCount": { + "title": "Player state count", + "type": "integer", + "minimum": 0, + "description": "The number of times that player state was set on the stream." }, - "xdm:playerStateTime" : { - "title" : "Player state time", - "type" : "integer", - "minimum" : 0, - "description" : "The total duration of that player state." + "xdm:playerStateTime": { + "title": "Player state time", + "type": "integer", + "minimum": 0, + "description": "The total duration of that player state." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/player-state" - } ], - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/player-state" + } + ], + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/poi-detail.schema.json b/components/datatypes/poi-detail.schema.json index 6f7b89a0d..902ba4ed0 100644 --- a/components/datatypes/poi-detail.schema.json +++ b/components/datatypes/poi-detail.schema.json @@ -1,75 +1,83 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/poi-detail", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Point of interest details", - "type" : "object", - "meta:extensible" : true, - "description" : "A point or place of interest (POI) Details. Used to capture the technical and metadata information for a POI.", - "definitions" : { - "geo-interaction-detail" : { - "properties" : { - "xdm:POIID" : { - "title" : "POI identity", - "type" : "string", - "meta:status" : "deprecated", - "description" : "The unique identifier of the POI." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/poi-detail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Point of interest details", + "type": "object", + "meta:extensible": true, + "description": "A point or place of interest (POI) Details. Used to capture the technical and metadata information for a POI.", + "definitions": { + "geo-interaction-detail": { + "properties": { + "xdm:POIID": { + "title": "POI identity", + "type": "string", + "meta:status": "deprecated", + "description": "The unique identifier of the POI." }, - "xdm:poiID" : { - "title" : "POI Identity", - "type" : "string", - "description" : "The unique identifier of the POI." + "xdm:poiID": { + "title": "POI Identity", + "type": "string", + "description": "The unique identifier of the POI." }, - "xdm:name" : { - "title" : "POI name", - "type" : "string", - "description" : "The name given to the POI." + "xdm:name": { + "title": "POI name", + "type": "string", + "description": "The name given to the POI." }, - "xdm:category" : { - "title" : "POI category", - "type" : "string", - "description" : "General category assigned for organizing the POIs by the administrator of POI definitions." + "xdm:category": { + "title": "POI category", + "type": "string", + "description": "General category assigned for organizing the POIs by the administrator of POI definitions." }, - "xdm:type" : { - "title" : "POI type", - "type" : "string", - "description" : "The general type of the POI using a typing schema selected by the administrator of the POI definitions." + "xdm:type": { + "title": "POI type", + "type": "string", + "description": "The general type of the POI using a typing schema selected by the administrator of the POI definitions." }, - "xdm:distanceToPOICenter" : { - "title" : "Distance to POI center", - "type" : "number", - "description" : "Estimated distance from the POI center in meters." + "xdm:distanceToPOICenter": { + "title": "Distance to POI center", + "type": "number", + "description": "Estimated distance from the POI center in meters." }, - "xdm:locatingType" : { - "title" : "Locating type", - "type" : "string", - "description" : "Mechanism used to determine location.", - "meta:enum" : { - "beacon" : "Hardware beacon", - "gps" : "Device GPS", - "ip" : "IP to geo lookup", - "ip+wifi" : "IP with wifi lookup", - "wifi-triangulation" : "Wifi triangulation" + "xdm:locatingType": { + "title": "Locating type", + "type": "string", + "description": "Mechanism used to determine location.", + "meta:enum": { + "beacon": "Hardware beacon", + "gps": "Device GPS", + "ip": "IP to geo lookup", + "ip+wifi": "IP with wifi lookup", + "wifi-triangulation": "Wifi triangulation" } }, - "xdm:beaconInteractionDetails" : { - "title" : "Beacon interaction details", - "$ref" : "https://ns.adobe.com/xdm/context/beacon-interaction-details", - "description" : "Beacon details active for the POI interaction." + "xdm:beaconInteractionDetails": { + "title": "Beacon interaction details", + "$ref": "https://ns.adobe.com/xdm/context/beacon-interaction-details", + "description": "Beacon details active for the POI interaction." }, - "xdm:geoInteractionDetails" : { - "title" : "Geo interaction details", - "$ref" : "https://ns.adobe.com/xdm/context/geo-interaction-details", - "description" : "Geo details active for the POI interaction." + "xdm:geoInteractionDetails": { + "title": "Geo interaction details", + "$ref": "https://ns.adobe.com/xdm/context/geo-interaction-details", + "description": "Geo details active for the POI interaction." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/geo-interaction-detail" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/geo-interaction-detail" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/principal.schema.json b/components/datatypes/principal.schema.json index e8c502036..252a0d160 100644 --- a/components/datatypes/principal.schema.json +++ b/components/datatypes/principal.schema.json @@ -1,27 +1,32 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$schema" : "http://json-schema.org/draft-06/schema#", - "$id" : "https://ns.adobe.com/xdm/common/principal", - "title" : "Principal", - "description" : "This model represents a principal in an access control system. Principals are entities that have been authenticated against an identity provider.", - "type" : "object", - "meta:extensible" : false, - "properties" : { - "xdm:provider" : { - "description" : "The identity provider that manages this principal.", - "$ref" : "https://ns.adobe.com/xdm/common/identity-provider" + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://ns.adobe.com/xdm/common/principal", + "title": "Principal", + "description": "This model represents a principal in an access control system. Principals are entities that have been authenticated against an identity provider.", + "type": "object", + "meta:extensible": false, + "properties": { + "xdm:provider": { + "description": "The identity provider that manages this principal.", + "$ref": "https://ns.adobe.com/xdm/common/identity-provider" }, - "@id" : { - "type" : "string", - "description" : "A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the principal. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986)." + "@id": { + "type": "string", + "description": "A unique (uniqueness is defined on the same lines as defined [here](https://tools.ietf.org/html/rfc8141#section-5)) and persistent identifier for the principal. Ideally, this identifier should be a [URI](https://tools.ietf.org/html/rfc3986)." }, - "@type" : { - "type" : "string", - "format" : "uri", - "description" : "The type of the principal. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986)." + "@type": { + "type": "string", + "format": "uri", + "description": "The type of the principal. Acts as a processing hint to the client. Ideally, each value should be identified as a [URI](https://tools.ietf.org/html/rfc3986)." } }, - "required" : [ "xdm:provider", "@id", "@type" ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "required": ["xdm:provider", "@id", "@type"], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/product.schema.json b/components/datatypes/product.schema.json index baf63b455..81f53ae1b 100644 --- a/components/datatypes/product.schema.json +++ b/components/datatypes/product.schema.json @@ -1,188 +1,204 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/product", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product", - "type" : "object", - "description" : "XDM product name or title, master product, and key attributes of product in the product catalog.", - "definitions" : { - "product" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "The internal unique ID of the product in the commerce backend system." - }, - "xdm:SKU" : { - "title" : "SKU", - "type" : "string", - "description" : "The unique SKU (stock keeping unit) of the product assigned by the vendor.", - "meta:descriptors" : [ { - "@type" : "xdm:searchdescriptor", - "search:indexed" : true - } ] - }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "The name of the product." - }, - "schema:description" : { - "title" : "Description", - "type" : "string", - "description" : "The localized description of the product.", - "meta:status" : "deprecated" - }, - "xdm:productDescription" : { - "title" : "Description", - "type" : "string", - "description" : "The localized description of the product.", - "meta:descriptors" : [ { - "@type" : "xdm:searchdescriptor", - "search:indexed" : true - } ] - }, - "xdm:category" : { - "title" : "Category", - "type" : "string", - "description" : "Primary categorization or category name of the product." - }, - "xdm:department" : { - "title" : "Department", - "type" : "string", - "description" : "Primary department the product is associated with." - }, - "xdm:brand" : { - "title" : "Brand", - "type" : "string", - "description" : "The brand of the product.", - "meta:descriptors" : [ { - "@type" : "xdm:searchdescriptor", - "search:indexed" : true - } ] - }, - "xdm:masterProductID" : { - "title" : "Master product identifier", - "type" : "string", - "format" : "uri", - "description" : "The internal unique ID of the product in the commerce backend system." - }, - "xdm:masterProductSKU" : { - "title" : "Master product SKU", - "type" : "string", - "description" : "The unique SKU (stock keeping unit) of the master product assigned by the vendor or manufacturer." - }, - "xdm:masterProductName" : { - "title" : "Master product name", - "type" : "string", - "description" : "The localized name of the product." - }, - "xdm:masterProductDescription" : { - "title" : "Master product description", - "type" : "string", - "description" : "The description of the product." - }, - "xdm:fabrication" : { - "title" : "Fabrication", - "type" : "string", - "description" : "Primary material of the product construction.", - "meta:status" : "deprecated" - }, - "xdm:material" : { - "title" : "Material", - "type" : "string", - "description" : "Primary material of the product construction.", - "meta:descriptors" : [ { - "@type" : "xdm:searchdescriptor", - "search:indexed" : true - } ] - }, - "xdm:gender" : { - "title" : "Gender", - "type" : "string", - "description" : "Gender the product is marketed to.", - "meta:enum" : { - "male" : "For men", - "female" : "For women", - "unisex" : "For both men and women", - "unknown" : "Unknown" + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/product", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product", + "type": "object", + "description": "XDM product name or title, master product, and key attributes of product in the product catalog.", + "definitions": { + "product": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "The internal unique ID of the product in the commerce backend system." + }, + "xdm:SKU": { + "title": "SKU", + "type": "string", + "description": "The unique SKU (stock keeping unit) of the product assigned by the vendor.", + "meta:descriptors": [ + { + "@type": "xdm:searchdescriptor", + "search:indexed": true + } + ] + }, + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The name of the product." + }, + "schema:description": { + "title": "Description", + "type": "string", + "description": "The localized description of the product.", + "meta:status": "deprecated" + }, + "xdm:productDescription": { + "title": "Description", + "type": "string", + "description": "The localized description of the product.", + "meta:descriptors": [ + { + "@type": "xdm:searchdescriptor", + "search:indexed": true + } + ] + }, + "xdm:category": { + "title": "Category", + "type": "string", + "description": "Primary categorization or category name of the product." + }, + "xdm:department": { + "title": "Department", + "type": "string", + "description": "Primary department the product is associated with." + }, + "xdm:brand": { + "title": "Brand", + "type": "string", + "description": "The brand of the product.", + "meta:descriptors": [ + { + "@type": "xdm:searchdescriptor", + "search:indexed": true + } + ] + }, + "xdm:masterProductID": { + "title": "Master product identifier", + "type": "string", + "format": "uri", + "description": "The internal unique ID of the product in the commerce backend system." + }, + "xdm:masterProductSKU": { + "title": "Master product SKU", + "type": "string", + "description": "The unique SKU (stock keeping unit) of the master product assigned by the vendor or manufacturer." + }, + "xdm:masterProductName": { + "title": "Master product name", + "type": "string", + "description": "The localized name of the product." + }, + "xdm:masterProductDescription": { + "title": "Master product description", + "type": "string", + "description": "The description of the product." + }, + "xdm:fabrication": { + "title": "Fabrication", + "type": "string", + "description": "Primary material of the product construction.", + "meta:status": "deprecated" + }, + "xdm:material": { + "title": "Material", + "type": "string", + "description": "Primary material of the product construction.", + "meta:descriptors": [ + { + "@type": "xdm:searchdescriptor", + "search:indexed": true + } + ] + }, + "xdm:gender": { + "title": "Gender", + "type": "string", + "description": "Gender the product is marketed to.", + "meta:enum": { + "male": "For men", + "female": "For women", + "unisex": "For both men and women", + "unknown": "Unknown" } }, - "xdm:size" : { - "title" : "Size", - "type" : "number", - "description" : "Standard product size for the product." - }, - "xdm:unitOfMeasure" : { - "title" : "Unit of measure", - "type" : "string", - "description" : "Standard unit of measure of the product and or variation and relates the units for the size measurement." - }, - "xdm:countryOfOrigin" : { - "title" : "Country of origin", - "type" : "string", - "pattern" : "^[A-Z]{2}$", - "description" : "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country of origin of the product as defined by customs requirements." - }, - "xdm:COGS" : { - "title" : "Cost of good sold", - "type" : "number", - "description" : "Cost of good sold, in the `currencyCode` currency." - }, - "xdm:listPrice" : { - "title" : "List price", - "type" : "number", - "description" : "Default price of the product before sales and discounting, in the `currencyCode` currency." - }, - "xdm:currencyCode" : { - "title" : "Currency code", - "type" : "string", - "examples" : [ "USD", "EUR" ], - "pattern" : "^[A-Z]{3}$", - "description" : "The ISO 4217 alphabetic currency code used for cost and pricing, including `listPrice` and `COGS`." - }, - "xdm:originalSaleDate" : { - "title" : "Original sale date", - "type" : "string", - "format" : "date", - "description" : "First date the product was made available for sale. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." - }, - "xdm:productCreateDate" : { - "title" : "Product creation date", - "format" : "date", - "type" : "string", - "description" : "The date when this product was created. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." - }, - "xdm:productLastModified" : { - "title" : "Product last modified", - "format" : "date", - "type" : "string", - "description" : "The date when this product was last modified. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." - }, - "xdm:productURL" : { - "title" : "Product URL", - "type" : "string", - "description" : "The URL for the primary product view of the product page." - }, - "xdm:manufacturerName" : { - "title" : "Manufacturer name", - "type" : "string", - "description" : "Manufacturer of the product." - }, - "xdm:supplierName" : { - "title" : "Supplier name", - "type" : "string", - "description" : "The distributor of the product." + "xdm:size": { + "title": "Size", + "type": "number", + "description": "Standard product size for the product." + }, + "xdm:unitOfMeasure": { + "title": "Unit of measure", + "type": "string", + "description": "Standard unit of measure of the product and or variation and relates the units for the size measurement." + }, + "xdm:countryOfOrigin": { + "title": "Country of origin", + "type": "string", + "pattern": "^[A-Z]{2}$", + "description": "The two-character [ISO 3166-1 alpha-2](https://datahub.io/core/country-list) code for the country of origin of the product as defined by customs requirements." + }, + "xdm:COGS": { + "title": "Cost of good sold", + "type": "number", + "description": "Cost of good sold, in the `currencyCode` currency." + }, + "xdm:listPrice": { + "title": "List price", + "type": "number", + "description": "Default price of the product before sales and discounting, in the `currencyCode` currency." + }, + "xdm:currencyCode": { + "title": "Currency code", + "type": "string", + "examples": ["USD", "EUR"], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 alphabetic currency code used for cost and pricing, including `listPrice` and `COGS`." + }, + "xdm:originalSaleDate": { + "title": "Original sale date", + "type": "string", + "format": "date", + "description": "First date the product was made available for sale. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + }, + "xdm:productCreateDate": { + "title": "Product creation date", + "format": "date", + "type": "string", + "description": "The date when this product was created. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + }, + "xdm:productLastModified": { + "title": "Product last modified", + "format": "date", + "type": "string", + "description": "The date when this product was last modified. The time using RFC3339 with a stated time zone offset such as \"2001-07-04T12:08:56-07:00\". An example formatting pattern is \"yyyy-MM-dd'T'HH:mm:ssXXX\"." + }, + "xdm:productURL": { + "title": "Product URL", + "type": "string", + "description": "The URL for the primary product view of the product page." + }, + "xdm:manufacturerName": { + "title": "Manufacturer name", + "type": "string", + "description": "Manufacturer of the product." + }, + "xdm:supplierName": { + "title": "Supplier name", + "type": "string", + "description": "The distributor of the product." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/product" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/product" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/productlistitem.schema.json b/components/datatypes/productlistitem.schema.json index a700a7d29..9315d9487 100644 --- a/components/datatypes/productlistitem.schema.json +++ b/components/datatypes/productlistitem.schema.json @@ -1,64 +1,71 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/content/productlistitem", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product list item", - "type" : "object", - "description" : "The product list item represents a product selected by a customer with specific options, pricing, usage context for a specific point of time and may differ from the product record. For example the product record contains details from the product information system that are consistent for all customers, where the product list item has the actual price offered to the customer at that time which may vary due to sales campaigns or seasonal pricing.", - "definitions" : { - "productlistitem" : { - "properties" : { - "xdm:SKU" : { - "title" : "SKU", - "type" : "string", - "description" : "Stock keeping unit (SKU), the unique identifier for a product defined by the vendor." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/content/productlistitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product list item", + "type": "object", + "description": "The product list item represents a product selected by a customer with specific options, pricing, usage context for a specific point of time and may differ from the product record. For example the product record contains details from the product information system that are consistent for all customers, where the product list item has the actual price offered to the customer at that time which may vary due to sales campaigns or seasonal pricing.", + "definitions": { + "productlistitem": { + "properties": { + "xdm:SKU": { + "title": "SKU", + "type": "string", + "description": "Stock keeping unit (SKU), the unique identifier for a product defined by the vendor." }, - "@id" : { - "title" : "Line item ID.", - "type" : "string", - "format" : "uri-reference", - "description" : "The line item identifier for this product entry. The product itself is identified through `xdm:product`." + "@id": { + "title": "Line item ID.", + "type": "string", + "format": "uri-reference", + "description": "The line item identifier for this product entry. The product itself is identified through `xdm:product`." }, - "xdm:product" : { - "title" : "Product", - "type" : "string", - "format" : "uri", - "description" : "The XDM identifier of the product itself." + "xdm:product": { + "title": "Product", + "type": "string", + "format": "uri", + "description": "The XDM identifier of the product itself." }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "The display name for the product as presented to the user for this product view." + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The display name for the product as presented to the user for this product view." }, - "xdm:productAddMethod" : { - "title" : "Product add method", - "type" : "string", - "description" : "The method that was used to add a product item to the list by the visitor. Set with product list add metrics." + "xdm:productAddMethod": { + "title": "Product add method", + "type": "string", + "description": "The method that was used to add a product item to the list by the visitor. Set with product list add metrics." }, - "xdm:currencyCode" : { - "title" : "Currency code", - "type" : "string", - "examples" : [ "USD", "EUR" ], - "pattern" : "^[A-Z]{3}$", - "description" : "The ISO 4217 alphabetic currency code used for pricing the product." + "xdm:currencyCode": { + "title": "Currency code", + "type": "string", + "examples": ["USD", "EUR"], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 alphabetic currency code used for pricing the product." }, - "xdm:quantity" : { - "title" : "Quantity", - "type" : "integer", - "description" : "The number of units the customer has indicated they require of the product." + "xdm:quantity": { + "title": "Quantity", + "type": "integer", + "description": "The number of units the customer has indicated they require of the product." }, - "xdm:priceTotal" : { - "title" : "Price total", - "type" : "number", - "description" : "The total price for the product line item." + "xdm:priceTotal": { + "title": "Price total", + "type": "number", + "description": "The total price for the product line item." } }, - "required" : [ "xdm:SKU" ] + "required": ["xdm:SKU"] } }, - "allOf" : [ { - "$ref" : "#/definitions/productlistitem" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/productlistitem" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/profilestitch.schema.json b/components/datatypes/profilestitch.schema.json index ab6fe5a38..bed62fe88 100644 --- a/components/datatypes/profilestitch.schema.json +++ b/components/datatypes/profilestitch.schema.json @@ -1,31 +1,39 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profileStitch", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Profile stitch", - "type" : "object", - "description" : "Details about the IDs that were joined by profile stitching.", - "definitions" : { - "profileStitch" : { - "properties" : { - "xdm:profileStitchID" : { - "title" : "Profile stitch ID", - "$ref" : "https://ns.adobe.com/xdm/context/profileStitchIdentity", - "description" : "The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profileStitch", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile stitch", + "type": "object", + "description": "Details about the IDs that were joined by profile stitching.", + "definitions": { + "profileStitch": { + "properties": { + "xdm:profileStitchID": { + "title": "Profile stitch ID", + "$ref": "https://ns.adobe.com/xdm/context/profileStitchIdentity", + "description": "The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment." }, - "xdm:version" : { - "title" : "Version", - "type" : "string", - "description" : "The version of the profile stitch definition used and is useful for debugging." + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The version of the profile stitch definition used and is useful for debugging." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/context/identitymap" - }, { - "$ref" : "#/definitions/profileStitch" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "#/definitions/profileStitch" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/profilestitchidentity.schema.json b/components/datatypes/profilestitchidentity.schema.json index 0f94f848d..93286211c 100644 --- a/components/datatypes/profilestitchidentity.schema.json +++ b/components/datatypes/profilestitchidentity.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profileStitchIdentity", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Profile stitch identity", - "type" : "object", - "description" : "Profile stitch identity is used to clearly distinguish profile stitching from multiple sources. `ProfileStitchIdentity` is established by an profile stitch identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the profileStitchIdentity is unique.", - "definitions" : { - "profileStitchIdentity" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "Identity of the profile stitch in the related namespace." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profileStitchIdentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile stitch identity", + "type": "object", + "description": "Profile stitch identity is used to clearly distinguish profile stitching from multiple sources. `ProfileStitchIdentity` is established by an profile stitch identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the profileStitchIdentity is unique.", + "definitions": { + "profileStitchIdentity": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "Identity of the profile stitch in the related namespace." }, - "xdm:namespace" : { - "title" : "Namespace", - "$ref" : "https://ns.adobe.com/xdm/context/namespace", - "description" : "The namespace associated with the `xid` attribute." + "xdm:namespace": { + "title": "Namespace", + "$ref": "https://ns.adobe.com/xdm/context/namespace", + "description": "The namespace associated with the `xid` attribute." }, - "xdm:xid" : { - "title" : "Experience identifier", - "type" : "string", - "description" : "When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." + "xdm:xid": { + "title": "Experience identifier", + "type": "string", + "description": "When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/profileStitchIdentity" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/profileStitchIdentity" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/pushdetail.schema.json b/components/datatypes/pushdetail.schema.json index e2752ac00..43b1641de 100644 --- a/components/datatypes/pushdetail.schema.json +++ b/components/datatypes/pushdetail.schema.json @@ -1,65 +1,73 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/pushdetail", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Push notification detail", - "type" : "object", - "meta:extensible" : true, - "description" : "Push notification detail required to send mobile push notification to a specific mobile application on a given device.", - "definitions" : { - "pushdetail" : { - "properties" : { - "xdm:token" : { - "title" : "Push Token", - "type" : "string", - "description" : "Valid push token for the given push platform." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/pushdetail", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push notification detail", + "type": "object", + "meta:extensible": true, + "description": "Push notification detail required to send mobile push notification to a specific mobile application on a given device.", + "definitions": { + "pushdetail": { + "properties": { + "xdm:token": { + "title": "Push Token", + "type": "string", + "description": "Valid push token for the given push platform." }, - "xdm:platform" : { - "title" : "Push Platform", - "type" : "string", - "description" : "Push provider, e.g. apns or fcm" + "xdm:platform": { + "title": "Push Platform", + "type": "string", + "description": "Push provider, e.g. apns or fcm" }, - "xdm:blacklisted" : { - "title" : "Blacklist Flag", - "type" : "boolean", - "meta:status" : "deprecated", - "description" : "Indicates whether the push token is blacklisted. Deprecated due to new guidance on key names, use blocklisted instead." + "xdm:blacklisted": { + "title": "Blacklist Flag", + "type": "boolean", + "meta:status": "deprecated", + "description": "Indicates whether the push token is blacklisted. Deprecated due to new guidance on key names, use blocklisted instead." }, - "xdm:blocklisted" : { - "title" : "Blocklist Flag", - "type" : "boolean", - "meta:status" : "deprecated", - "description" : "Indicates whether the push token is blocked by the push provider. Deprecated due to new guidance on key names, use denylisted instead." + "xdm:blocklisted": { + "title": "Blocklist Flag", + "type": "boolean", + "meta:status": "deprecated", + "description": "Indicates whether the push token is blocked by the push provider. Deprecated due to new guidance on key names, use denylisted instead." }, - "xdm:denylisted" : { - "title" : "Denylist Flag", - "type" : "boolean", - "description" : "Indicates whether the push token is blocked by the push provider." + "xdm:denylisted": { + "title": "Denylist Flag", + "type": "boolean", + "description": "Indicates whether the push token is blocked by the push provider." }, - "xdm:appID" : { - "title" : "Application Identifier", - "type" : "string", - "description" : "Unique Identifier for the mobile application." + "xdm:appID": { + "title": "Application Identifier", + "type": "string", + "description": "Unique Identifier for the mobile application." }, - "xdm:identiy" : { - "title" : "Identity associated with this token", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "meta:status" : "deprecated", - "description" : "The identity associated with this token before profile stitching. Deprecated due to typo, use xdm:identity instead." + "xdm:identiy": { + "title": "Identity associated with this token", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "meta:status": "deprecated", + "description": "The identity associated with this token before profile stitching. Deprecated due to typo, use xdm:identity instead." }, - "xdm:identity" : { - "title" : "Identity associated with this token", - "$ref" : "https://ns.adobe.com/xdm/context/identity", - "description" : "The identity associated with this token before profile stitching." + "xdm:identity": { + "title": "Identity associated with this token", + "$ref": "https://ns.adobe.com/xdm/context/identity", + "description": "The identity associated with this token before profile stitching." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/pushdetail" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/pushdetail" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/pushnotificationtoken.schema.json b/components/datatypes/pushnotificationtoken.schema.json index ef1038c06..1e1d84803 100644 --- a/components/datatypes/pushnotificationtoken.schema.json +++ b/components/datatypes/pushnotificationtoken.schema.json @@ -1,59 +1,67 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/pushnotificationtoken", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Push notification token", - "type" : "object", - "meta:extensible" : true, - "description" : "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts. Examples include mobile application notifications over notification services like the Apple Push Notification service.", - "definitions" : { - "pushnotificationtoken" : { - "properties" : { - "xdm:token" : { - "title" : "Token", - "type" : "string", - "description" : "The service specific token used to address the application for communication for example, an Apple APN ID or a Google GCM ID." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/pushnotificationtoken", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push notification token", + "type": "object", + "meta:extensible": true, + "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts. Examples include mobile application notifications over notification services like the Apple Push Notification service.", + "definitions": { + "pushnotificationtoken": { + "properties": { + "xdm:token": { + "title": "Token", + "type": "string", + "description": "The service specific token used to address the application for communication for example, an Apple APN ID or a Google GCM ID." }, - "xdm:registrationDate" : { - "title" : "Registration date", - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the profile has authorized the application to receive push notifications." + "xdm:registrationDate": { + "title": "Registration date", + "type": "string", + "format": "date-time", + "description": "Date and time when the profile has authorized the application to receive push notifications." }, - "xdm:deregistrationDate" : { - "title" : "De-registration date", - "type" : "string", - "format" : "date-time", - "description" : "Date and time when the profile has disabled push notifications on the application." + "xdm:deregistrationDate": { + "title": "De-registration date", + "type": "string", + "format": "date-time", + "description": "Date and time when the profile has disabled push notifications on the application." }, - "xdm:environment" : { - "title" : "Environment", - "$ref" : "https://ns.adobe.com/xdm/context/environment", - "description" : "Environment of at the time of the registration." + "xdm:environment": { + "title": "Environment", + "$ref": "https://ns.adobe.com/xdm/context/environment", + "description": "Environment of at the time of the registration." }, - "xdm:device" : { - "title" : "Device", - "$ref" : "https://ns.adobe.com/xdm/context/device", - "description" : "The device originating the registration." + "xdm:device": { + "title": "Device", + "$ref": "https://ns.adobe.com/xdm/context/device", + "description": "The device originating the registration." }, - "xdm:application" : { - "title" : "Application", - "$ref" : "https://ns.adobe.com/xdm/context/application", - "description" : "Application registered to receive push notifications." + "xdm:application": { + "title": "Application", + "$ref": "https://ns.adobe.com/xdm/context/application", + "description": "Application registered to receive push notifications." }, - "xdm:channel" : { - "title" : "Communication channel", - "$ref" : "https://ns.adobe.com/xdm/channels/channel", - "description" : "Channels for communicating with customers or users." + "xdm:channel": { + "title": "Communication channel", + "$ref": "https://ns.adobe.com/xdm/channels/channel", + "description": "Channels for communicating with customers or users." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/pushnotificationtoken" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/pushnotificationtoken" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/search.schema.json b/components/datatypes/search.schema.json index 16eea186b..fa6870fd8 100644 --- a/components/datatypes/search.schema.json +++ b/components/datatypes/search.schema.json @@ -1,62 +1,70 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/search", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Search", - "type" : "object", - "meta:extensible" : true, - "description" : "Information about web search activity.", - "definitions" : { - "search" : { - "properties" : { - "xdm:searchEngine" : { - "title" : "Search engine", - "type" : "string", - "description" : "The search engine used by the search." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/search", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Search", + "type": "object", + "meta:extensible": true, + "description": "Information about web search activity.", + "definitions": { + "search": { + "properties": { + "xdm:searchEngine": { + "title": "Search engine", + "type": "string", + "description": "The search engine used by the search." }, - "xdm:searchEngineID" : { - "title" : "Search engine ID", - "type" : "string", - "format" : "uri", - "description" : "The application specified identifier used to identify the search engine used by the search." + "xdm:searchEngineID": { + "title": "Search engine ID", + "type": "string", + "format": "uri", + "description": "The application specified identifier used to identify the search engine used by the search." }, - "xdm:keywords" : { - "title" : "Keywords", - "type" : "string", - "description" : "Keywords for the search." + "xdm:keywords": { + "title": "Keywords", + "type": "string", + "description": "Keywords for the search." }, - "xdm:isPaid" : { - "title" : "Is paid", - "type" : "boolean", - "description" : "Indicate if the search is paid or not." + "xdm:isPaid": { + "title": "Is paid", + "type": "boolean", + "description": "Indicate if the search is paid or not." }, - "xdm:pageDepth" : { - "title" : "Page depth", - "type" : "integer", - "description" : "Page depth in the search results." + "xdm:pageDepth": { + "title": "Page depth", + "type": "integer", + "description": "Page depth in the search results." }, - "xdm:slot" : { - "title" : "Page slot", - "type" : "string", - "description" : "Named section of the page where the search result appeared, for example, top or side.", - "meta:enum" : { - "top" : "Top of the page", - "side" : "Side of the page" + "xdm:slot": { + "title": "Page slot", + "type": "string", + "description": "Named section of the page where the search result appeared, for example, top or side.", + "meta:enum": { + "top": "Top of the page", + "side": "Side of the page" } }, - "xdm:position" : { - "title" : "Listing position", - "type" : "integer", - "description" : "Position or rank of the listing in the search result page." + "xdm:position": { + "title": "Listing position", + "type": "integer", + "description": "Position or rank of the listing in the search result page." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/search" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/search" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/segmentidentity.schema.json b/components/datatypes/segmentidentity.schema.json index bc10d56d5..2b9a90402 100644 --- a/components/datatypes/segmentidentity.schema.json +++ b/components/datatypes/segmentidentity.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/segmentidentity", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Segment identity", - "type" : "object", - "description" : "Segment identity is used to clearly distinguish segments from multiple sources. Segment identity is established by an segment identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the segment identity is unique.", - "definitions" : { - "segmentIdentity" : { - "properties" : { - "@id" : { - "title" : "Identifier", - "type" : "string", - "format" : "uri-reference", - "description" : "Identity of the segment in the related namespace." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentidentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment identity", + "type": "object", + "description": "Segment identity is used to clearly distinguish segments from multiple sources. Segment identity is established by an segment identity provider, which itself is referenced in the `namespace` attribute. Within each `namespace`, the segment identity is unique.", + "definitions": { + "segmentIdentity": { + "properties": { + "@id": { + "title": "Identifier", + "type": "string", + "format": "uri-reference", + "description": "Identity of the segment in the related namespace." }, - "xdm:namespace" : { - "title" : "Namespace", - "$ref" : "https://ns.adobe.com/xdm/context/namespace", - "description" : "The namespace associated with the `xid` attribute." + "xdm:namespace": { + "title": "Namespace", + "$ref": "https://ns.adobe.com/xdm/context/namespace", + "description": "The namespace associated with the `xid` attribute." }, - "xdm:xid" : { - "title" : "Experience identifier", - "type" : "string", - "description" : "When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." + "xdm:xid": { + "title": "Experience identifier", + "type": "string", + "description": "When present, this value represents a cross-namespace identifier that is unique across all namespace-scoped identifiers in all namespaces." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/segmentIdentity" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/segmentIdentity" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/segmentmembership.schema.json b/components/datatypes/segmentmembership.schema.json index f1fb4f1f3..b238a4fcd 100644 --- a/components/datatypes/segmentmembership.schema.json +++ b/components/datatypes/segmentmembership.schema.json @@ -1,99 +1,106 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/segmentmembership", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Segment membership", - "type" : "object", - "description" : "Details about a segment membership.", - "definitions" : { - "segmentMembership" : { - "properties" : { - "xdm:segmentID" : { - "title" : "Segment ID", - "meta:status" : "deprecated", - "$ref" : "https://ns.adobe.com/xdm/context/segmentidentity", - "description" : "The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment. Deprecated." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentmembership", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment membership", + "type": "object", + "description": "Details about a segment membership.", + "definitions": { + "segmentMembership": { + "properties": { + "xdm:segmentID": { + "title": "Segment ID", + "meta:status": "deprecated", + "$ref": "https://ns.adobe.com/xdm/context/segmentidentity", + "description": "The identity of the segment or snapshot definition in with the domain of the specific system that processes that type of segment. Deprecated." }, - "xdm:version" : { - "title" : "Version", - "type" : "string", - "description" : "The version of the segment definition used in this segment assertion. Version can be omitted in audience lists when all memberships versions are the same." + "xdm:version": { + "title": "Version", + "type": "string", + "description": "The version of the segment definition used in this segment assertion. Version can be omitted in audience lists when all memberships versions are the same." }, - "xdm:lastQualificationTime" : { - "title" : "Last qualification time", - "type" : "string", - "format" : "date-time", - "description" : "The timestamp when the assertion of segment membership was made." + "xdm:lastQualificationTime": { + "title": "Last qualification time", + "type": "string", + "format": "date-time", + "description": "The timestamp when the assertion of segment membership was made." }, - "xdm:payload" : { - "title" : "Payload", - "description" : "Values that are directly related with the segment realization. This payload exists with the same 'validUntil' as the segment realization. Note that the intention is that exactly one payload value be included, as indicated by the payload type. This was originally modeled using 'oneOf', but due to limitations in our tooling that was removed. This more semantically meaningful representation will be re-introduced in the future.", - "type" : "object", - "properties" : { - "xdm:payloadBooleanValue" : { - "title" : "Value", - "type" : "boolean", - "description" : "The boolean value." + "xdm:payload": { + "title": "Payload", + "description": "Values that are directly related with the segment realization. This payload exists with the same 'validUntil' as the segment realization. Note that the intention is that exactly one payload value be included, as indicated by the payload type. This was originally modeled using 'oneOf', but due to limitations in our tooling that was removed. This more semantically meaningful representation will be re-introduced in the future.", + "type": "object", + "properties": { + "xdm:payloadBooleanValue": { + "title": "Value", + "type": "boolean", + "description": "The boolean value." }, - "xdm:payloadNumberValue" : { - "title" : "Value", - "type" : "number", - "description" : "The number." + "xdm:payloadNumberValue": { + "title": "Value", + "type": "number", + "description": "The number." }, - "xdm:payloadPropensityValue" : { - "title" : "Value", - "type" : "number", - "description" : "The propensity.", - "exclusiveMinimum" : 0, - "maximum" : 1 + "xdm:payloadPropensityValue": { + "title": "Value", + "type": "number", + "description": "The propensity.", + "exclusiveMinimum": 0, + "maximum": 1 }, - "xdm:payloadStringValue" : { - "title" : "Value", - "type" : "string", - "description" : "The string value." + "xdm:payloadStringValue": { + "title": "Value", + "type": "string", + "description": "The string value." }, - "xdm:payloadType" : { - "title" : "Payload Type", - "type" : "string", - "enum" : [ "boolean", "number", "propensity", "string" ], - "meta:enum" : { - "boolean" : "Boolean", - "number" : "Number", - "propensity" : "Propensity", - "string" : "String" + "xdm:payloadType": { + "title": "Payload Type", + "type": "string", + "enum": ["boolean", "number", "propensity", "string"], + "meta:enum": { + "boolean": "Boolean", + "number": "Number", + "propensity": "Propensity", + "string": "String" }, - "description" : "The type of payload." + "description": "The type of payload." } }, - "required" : [ "xdm:payloadType" ] + "required": ["xdm:payloadType"] }, - "xdm:validUntil" : { - "title" : "Valid until", - "type" : "string", - "format" : "date-time", - "description" : "The timestamp for when the segment assertion should no longer be assumed to be valid and should either be ignored or revalidated." + "xdm:validUntil": { + "title": "Valid until", + "type": "string", + "format": "date-time", + "description": "The timestamp for when the segment assertion should no longer be assumed to be valid and should either be ignored or revalidated." }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "description" : "Is the segment participation realized as part of the current request.", - "default" : "realized", - "enum" : [ "existing", "realized", "exited" ], - "meta:enum" : { - "existing" : "Entity continues to be in the segment.", - "realized" : "Entity is entering the segment.", - "exited" : "Entity is exiting the segment." + "xdm:status": { + "title": "Status", + "type": "string", + "description": "Is the segment participation realized as part of the current request.", + "default": "realized", + "enum": ["existing", "realized", "exited"], + "meta:enum": { + "existing": "Entity continues to be in the segment.", + "realized": "Entity is entering the segment.", + "exited": "Entity is exiting the segment." } }, - "xdm:profileStitchID" : { - "$ref" : "https://ns.adobe.com/xdm/context/profileStitchIdentity" + "xdm:profileStitchID": { + "$ref": "https://ns.adobe.com/xdm/context/profileStitchIdentity" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/segmentMembership" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/segmentMembership" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/segmentmembershipitem.schema.json b/components/datatypes/segmentmembershipitem.schema.json index 84ba0173d..c34643682 100644 --- a/components/datatypes/segmentmembershipitem.schema.json +++ b/components/datatypes/segmentmembershipitem.schema.json @@ -1,24 +1,32 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/segmentmembershipitem", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Segment membership item", - "type" : "object", - "description" : "List item that contains details of segment membership combined the profile stitched identities to which the membership applies.", - "definitions" : { - "membershipIdentities" : { - "properties" : { - "xdm:profileStitchID" : { - "$ref" : "https://ns.adobe.com/xdm/context/profileStitchIdentity" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentmembershipitem", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment membership item", + "type": "object", + "description": "List item that contains details of segment membership combined the profile stitched identities to which the membership applies.", + "definitions": { + "membershipIdentities": { + "properties": { + "xdm:profileStitchID": { + "$ref": "https://ns.adobe.com/xdm/context/profileStitchIdentity" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/context/segmentmembership" - }, { - "$ref" : "#/definitions/membershipIdentities" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" + }, + { + "$ref": "#/definitions/membershipIdentities" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/datatypes/web/webinfo.schema.json b/components/datatypes/web/webinfo.schema.json index 8f4520459..9b367dcb9 100644 --- a/components/datatypes/web/webinfo.schema.json +++ b/components/datatypes/web/webinfo.schema.json @@ -1,37 +1,45 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/webinfo", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Web information", - "type" : "object", - "meta:status" : "stable", - "meta:extensible" : true, - "description" : "", - "definitions" : { - "webinfo" : { - "properties" : { - "xdm:webPageDetails" : { - "title" : "Web page details", - "$ref" : "https://ns.adobe.com/xdm/context/webpagedetails", - "description" : "Details about the web page where the web interaction occurred." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webinfo", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web information", + "type": "object", + "meta:status": "stable", + "meta:extensible": true, + "description": "", + "definitions": { + "webinfo": { + "properties": { + "xdm:webPageDetails": { + "title": "Web page details", + "$ref": "https://ns.adobe.com/xdm/context/webpagedetails", + "description": "Details about the web page where the web interaction occurred." }, - "xdm:webInteraction" : { - "title" : "Web interaction", - "$ref" : "https://ns.adobe.com/xdm/context/webinteraction", - "description" : "Details about the web link or URL that corresponds to where the interaction occurred." + "xdm:webInteraction": { + "title": "Web interaction", + "$ref": "https://ns.adobe.com/xdm/context/webinteraction", + "description": "Details about the web link or URL that corresponds to where the interaction occurred." }, - "xdm:webReferrer" : { - "title" : "Web referrer", - "$ref" : "https://ns.adobe.com/xdm/context/webreferrer", - "description" : "The referrer of a web interaction, which is the URL a visitor came from immediately before the current web interaction was recorded." + "xdm:webReferrer": { + "title": "Web referrer", + "$ref": "https://ns.adobe.com/xdm/context/webreferrer", + "description": "The referrer of a web interaction, which is the URL a visitor came from immediately before the current web interaction was recorded." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/webinfo" - } ], - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webinfo" + } + ], + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/web/webinteraction.schema.json b/components/datatypes/web/webinteraction.schema.json index f44b1cdc7..29985bae9 100644 --- a/components/datatypes/web/webinteraction.schema.json +++ b/components/datatypes/web/webinteraction.schema.json @@ -1,48 +1,56 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/webinteraction", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Web interaction", - "type" : "object", - "meta:extensible" : true, - "description" : "Interaction details from inside the context of a loaded web page.", - "definitions" : { - "webinteraction" : { - "properties" : { - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "The link type.", - "enum" : [ "download", "exit", "other" ], - "meta:enum" : { - "download" : "Download", - "exit" : "Exit", - "other" : "Other" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webinteraction", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web interaction", + "type": "object", + "meta:extensible": true, + "description": "Interaction details from inside the context of a loaded web page.", + "definitions": { + "webinteraction": { + "properties": { + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The link type.", + "enum": ["download", "exit", "other"], + "meta:enum": { + "download": "Download", + "exit": "Exit", + "other": "Other" } }, - "xdm:URL" : { - "title" : "URL", - "type" : "string", - "description" : "The actual link or URL used for this web interaction." + "xdm:URL": { + "title": "URL", + "type": "string", + "description": "The actual link or URL used for this web interaction." }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "The normative name used for this web link, used for classification purposes." + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The normative name used for this web link, used for classification purposes." }, - "xdm:linkClicks" : { - "title" : "Link Clicks", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "Click of a web link has occurred." + "xdm:linkClicks": { + "title": "Link Clicks", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "Click of a web link has occurred." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/webinteraction" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webinteraction" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/web/webpagedetails.schema.json b/components/datatypes/web/webpagedetails.schema.json index 12475b6e4..2b55a08ee 100644 --- a/components/datatypes/web/webpagedetails.schema.json +++ b/components/datatypes/web/webpagedetails.schema.json @@ -1,63 +1,71 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/webpagedetails", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Web page details", - "type" : "object", - "meta:extensible" : true, - "description" : "", - "definitions" : { - "webpagedetails" : { - "properties" : { - "xdm:siteSection" : { - "title" : "Site section", - "type" : "string", - "description" : "The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webpagedetails", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web page details", + "type": "object", + "meta:extensible": true, + "description": "", + "definitions": { + "webpagedetails": { + "properties": { + "xdm:siteSection": { + "title": "Site section", + "type": "string", + "description": "The normative name of the site section where this web page resides, which may be used to classify or categorize the interaction." }, - "xdm:name" : { - "title" : "Name", - "type" : "string", - "description" : "The normative name of the web page. This name is not necessarily the page title or directly associate with page content, but is used to organize a site's pages for classification purposes." + "xdm:name": { + "title": "Name", + "type": "string", + "description": "The normative name of the web page. This name is not necessarily the page title or directly associate with page content, but is used to organize a site's pages for classification purposes." }, - "xdm:viewName" : { - "title" : "View Name", - "type" : "string", - "description" : "The name of the view, within a page. This is commonly used with Single Page Applications or pages that have tabs or controls that change a majority of the page layout." + "xdm:viewName": { + "title": "View Name", + "type": "string", + "description": "The name of the view, within a page. This is commonly used with Single Page Applications or pages that have tabs or controls that change a majority of the page layout." }, - "xdm:URL" : { - "title" : "URL", - "type" : "string", - "pattern" : "^\\w+:\\/\\/(localhost|[^\\s:\\/]+\\.[^\\s:\\/]+)(:\\d+)?(\\/[^\\s]*)?$", - "description" : "The normative or usual URL of the web page. This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`." + "xdm:URL": { + "title": "URL", + "type": "string", + "pattern": "^\\w+:\\/\\/(localhost|[^\\s:\\/]+\\.[^\\s:\\/]+)(:\\d+)?(\\/[^\\s]*)?$", + "description": "The normative or usual URL of the web page. This may or may not be the actual URL used to reach the page, which would be recorded using `Web Link`." }, - "xdm:server" : { - "title" : "Server", - "type" : "string", - "description" : "The normative or usual server that hosts the web page. This may or may not be the host or server that actually served the page interaction, but is used for classification purposes." + "xdm:server": { + "title": "Server", + "type": "string", + "description": "The normative or usual server that hosts the web page. This may or may not be the host or server that actually served the page interaction, but is used for classification purposes." }, - "xdm:isErrorPage" : { - "title" : "Is error page", - "type" : "boolean", - "description" : "Flag that indicate if the page is error page or not. Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code. This flag is used to broadly categorize web interactions." + "xdm:isErrorPage": { + "title": "Is error page", + "type": "boolean", + "description": "Flag that indicate if the page is error page or not. Error here is defined by the application, and may nor may not correspond to a page served with an HTTP error code. This flag is used to broadly categorize web interactions." }, - "xdm:isHomePage" : { - "title" : "Is home page", - "type" : "boolean", - "description" : "Flag that indicate if the page is the site home page or not. The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point. This flag is used to broadly categorize web interactions." + "xdm:isHomePage": { + "title": "Is home page", + "type": "boolean", + "description": "Flag that indicate if the page is the site home page or not. The definition of home page is determined by the application, but is commonly used to designate a top level landing page or common site entry point. This flag is used to broadly categorize web interactions." }, - "xdm:pageViews" : { - "title" : "Page Views", - "$ref" : "https://ns.adobe.com/xdm/data/measure", - "description" : "View(s) of a webpage has occurred." + "xdm:pageViews": { + "title": "Page Views", + "$ref": "https://ns.adobe.com/xdm/data/measure", + "description": "View(s) of a webpage has occurred." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/webpagedetails" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webpagedetails" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/datatypes/web/webreferrer.schema.json b/components/datatypes/web/webreferrer.schema.json index a084cfa97..d1317a63a 100644 --- a/components/datatypes/web/webreferrer.schema.json +++ b/components/datatypes/web/webreferrer.schema.json @@ -1,43 +1,60 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/webreferrer", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Web referrer", - "type" : "object", - "meta:extensible" : true, - "description" : "", - "definitions" : { - "webreferrer" : { - "properties" : { - "xdm:URL" : { - "title" : "URL", - "type" : "string", - "description" : "The referrer URL." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/webreferrer", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web referrer", + "type": "object", + "meta:extensible": true, + "description": "", + "definitions": { + "webreferrer": { + "properties": { + "xdm:URL": { + "title": "URL", + "type": "string", + "description": "The referrer URL." }, - "xdm:type" : { - "title" : "Type", - "type" : "string", - "description" : "The referrer type.", - "enum" : [ "internal", "external", "search_engine", "typed_bookmarked", "email", "social", "unknown", "usenet" ], - "meta:enum" : { - "internal" : "Internal", - "external" : "External", - "search_engine" : "Search engine", - "typed_bookmarked" : "Typed or bookmarked", - "email" : "Email", - "social" : "Social network", - "unknown" : "Unknown", - "news" : "Usenet newsgroup" + "xdm:type": { + "title": "Type", + "type": "string", + "description": "The referrer type.", + "enum": [ + "internal", + "external", + "search_engine", + "typed_bookmarked", + "email", + "social", + "unknown", + "usenet" + ], + "meta:enum": { + "internal": "Internal", + "external": "External", + "search_engine": "Search engine", + "typed_bookmarked": "Typed or bookmarked", + "email": "Email", + "social": "Social network", + "unknown": "Unknown", + "news": "Usenet newsgroup" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/webreferrer" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/webreferrer" + } + ], + "meta:status": "stable", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/account/account-components.schema.json b/components/mixins/account/account-components.schema.json index abd52a61f..a7b4bdb46 100644 --- a/components/mixins/account/account-components.schema.json +++ b/components/mixins/account/account-components.schema.json @@ -1,49 +1,54 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/account-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Account Components", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/account" ], - "description" : "XDM Business Account relationships for one data source.", - "definitions" : { - "account-components" : { - "properties" : { - "xdm:accountComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceAccountID" : { - "title" : "Source Account ID", - "description" : "Source account ID.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/account-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Account Components", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/account"], + "description": "XDM Business Account relationships for one data source.", + "definitions": { + "account-components": { + "properties": { + "xdm:accountComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceAccountID": { + "title": "Source Account ID", + "description": "Source account ID.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceAccountParentID" : { - "title" : "Source Parent Account", - "description" : "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceAccountParentID": { + "title": "Source Parent Account", + "description": "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External ID", - "description" : "External ID.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External ID", + "description": "External ID.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourcePartnerAccountID" : { - "title" : "Source Partner Account Id", - "description" : "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourcePartnerAccountID": { + "title": "Source Partner Account Id", + "description": "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceAccountOwnerID" : { - "title" : "Account Owner Id", - "description" : "Account owner ID.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceAccountOwnerID": { + "title": "Account Owner Id", + "description": "Account owner ID.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:segmentationAttributes" : { - "title" : "Account Segmentation Properties", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-account#/definitions/b2b-account-segmentation" + "xdm:segmentationAttributes": { + "title": "Account Segmentation Properties", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-account#/definitions/b2b-account-segmentation" } } } @@ -51,9 +56,11 @@ } } }, - "allOf" : [ { - "$ref" : "#/definitions/account-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-02" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/account-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-02" +} diff --git a/components/mixins/account/account-details.schema.json b/components/mixins/account/account-details.schema.json index 5c4fcae0b..4855a0193 100644 --- a/components/mixins/account/account-details.schema.json +++ b/components/mixins/account/account-details.schema.json @@ -1,115 +1,122 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/account-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Account Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/account" ], - "description" : "XDM business account details.", - "definitions" : { - "account-details" : { - "properties" : { - "xdm:accountName" : { - "title" : "Account Name", - "description" : "name of company. Up to 255 characters are allowed in this field.", - "type" : "string" - }, - "xdm:accountTerritoryID" : { - "title" : "Account Territory Id", - "description" : "The territory to which the account has been assigned.", - "type" : "string" - }, - "xdm:accountScore" : { - "title" : "Account Score", - "type" : "number" - }, - "xdm:accountBillingAddress" : { - "title" : "Account Billing Address", - "$ref" : "https://ns.adobe.com/xdm/common/address" - }, - "xdm:accountShippingAddress" : { - "title" : "Account Shipping Address", - "$ref" : "https://ns.adobe.com/xdm/common/address" - }, - "xdm:accountPhysicalAddress" : { - "title" : "Account Physical Address", - "description" : "Actual physical address of the account. Could be the HQ address or any preffered business address for communication.", - "$ref" : "https://ns.adobe.com/xdm/common/address" - }, - "xdm:accountOrganization" : { - "title" : "Account Organization", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-account-organization" - }, - "xdm:accountParentID" : { - "title" : "Parent Account", - "description" : "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.", - "type" : "string" - }, - "xdm:partnerAccountID" : { - "title" : "Partner Account Id", - "description" : "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.", - "type" : "string" - }, - "xdm:accountNumber" : { - "title" : "Account Number", - "description" : "Tracking or reference number for account. Up to 40 characters are allowed in this field.", - "type" : "string" - }, - "xdm:accountDescription" : { - "title" : "Account Description", - "description" : "Text description of the account.", - "type" : "string" - }, - "xdm:accountSite" : { - "title" : "Account Site Details", - "description" : "Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field.", - "type" : "string" - }, - "xdm:accountType" : { - "title" : "Account Type", - "description" : "Account Type.", - "type" : "string" - }, - "xdm:accountSourceType" : { - "title" : "Account Source Type", - "description" : "Source type for the account.", - "type" : "string" - }, - "xdm:defaultCurrencyCode" : { - "title" : "Default Currency Code", - "type" : "string", - "examples" : [ "USD", "EUR" ], - "pattern" : "^[A-Z]{3}$", - "description" : "The ISO 4217 currency code." - }, - "xdm:accountOwnership" : { - "title" : "Ownership", - "description" : "Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters.", - "type" : "string" - }, - "xdm:accountTradeStyle" : { - "title" : "Account Trade Style", - "description" : "A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA).", - "type" : "string" - }, - "xdm:accountPhone" : { - "title" : "Account Phone Number", - "description" : "Phone number for the account.", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber" - }, - "xdm:accountFax" : { - "title" : "Account Fax Number", - "description" : "Fax number for the account.", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/account-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Account Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/account"], + "description": "XDM business account details.", + "definitions": { + "account-details": { + "properties": { + "xdm:accountName": { + "title": "Account Name", + "description": "name of company. Up to 255 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountTerritoryID": { + "title": "Account Territory Id", + "description": "The territory to which the account has been assigned.", + "type": "string" + }, + "xdm:accountScore": { + "title": "Account Score", + "type": "number" + }, + "xdm:accountBillingAddress": { + "title": "Account Billing Address", + "$ref": "https://ns.adobe.com/xdm/common/address" + }, + "xdm:accountShippingAddress": { + "title": "Account Shipping Address", + "$ref": "https://ns.adobe.com/xdm/common/address" + }, + "xdm:accountPhysicalAddress": { + "title": "Account Physical Address", + "description": "Actual physical address of the account. Could be the HQ address or any preffered business address for communication.", + "$ref": "https://ns.adobe.com/xdm/common/address" + }, + "xdm:accountOrganization": { + "title": "Account Organization", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-account-organization" + }, + "xdm:accountParentID": { + "title": "Parent Account", + "description": "Parent company for companies that are subsidiaries of a larger company or organization. The parent account must be an existing account in salesforce. You can enter the account name, or select (or optionally, create) the account using the lookup icon.", + "type": "string" + }, + "xdm:partnerAccountID": { + "title": "Partner Account Id", + "description": "Partner accounts are accounts that a channel manager uses to manage partner organizations, partner users, and activities when using a partner community or partner portal.", + "type": "string" + }, + "xdm:accountNumber": { + "title": "Account Number", + "description": "Tracking or reference number for account. Up to 40 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountDescription": { + "title": "Account Description", + "description": "Text description of the account.", + "type": "string" + }, + "xdm:accountSite": { + "title": "Account Site Details", + "description": "Information about the account’s location, such as single location, headquarters, or branch. Up to 80 characters are allowed in this field.", + "type": "string" + }, + "xdm:accountType": { + "title": "Account Type", + "description": "Account Type.", + "type": "string" + }, + "xdm:accountSourceType": { + "title": "Account Source Type", + "description": "Source type for the account.", + "type": "string" + }, + "xdm:defaultCurrencyCode": { + "title": "Default Currency Code", + "type": "string", + "examples": ["USD", "EUR"], + "pattern": "^[A-Z]{3}$", + "description": "The ISO 4217 currency code." + }, + "xdm:accountOwnership": { + "title": "Ownership", + "description": "Ownership of company, for example, public or private. Entry is selected from a picklist of available values, which a salesforce admin sets. Each picklist value can have up to 40 characters.", + "type": "string" + }, + "xdm:accountTradeStyle": { + "title": "Account Trade Style", + "description": "A name, different from its legal name, that an organization may use for conducting business. Similar to (Doing business as) or (DBA).", + "type": "string" + }, + "xdm:accountPhone": { + "title": "Account Phone Number", + "description": "Phone number for the account.", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber" + }, + "xdm:accountFax": { + "title": "Account Fax Number", + "description": "Fax number for the account.", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/account-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-08-27" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/account-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-08-27" +} diff --git a/components/mixins/account/account-person-components.schema.json b/components/mixins/account/account-person-components.schema.json index c3c92aa5e..7dc37f617 100644 --- a/components/mixins/account/account-person-components.schema.json +++ b/components/mixins/account/account-person-components.schema.json @@ -1,45 +1,50 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/account-person-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Account Person Relation Components", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/account-person" ], - "description" : "XDM business account person relation component details.", - "definitions" : { - "account-person-components" : { - "properties" : { - "xdm:accountPersonComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceAccountPersonID" : { - "title" : "Source Account Person ID", - "description" : "Account person relationship unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/account-person-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Account Person Relation Components", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/account-person"], + "description": "XDM business account person relation component details.", + "definitions": { + "account-person-components": { + "properties": { + "xdm:accountPersonComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceAccountPersonID": { + "title": "Source Account Person ID", + "description": "Account person relationship unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External ID", - "description" : "External unique identifer at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External ID", + "description": "External unique identifer at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceAccountID" : { - "title" : "Source Account ID", - "description" : "Account unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceAccountID": { + "title": "Source Account ID", + "description": "Account unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourcePersonID" : { - "title" : "Source Person ID", - "description" : "Person unique identifer at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourcePersonID": { + "title": "Source Person ID", + "description": "Person unique identifer at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:personRole" : { - "title" : "Person Role", - "description" : "Role of the person pertaining to this account.", - "type" : "string" + "xdm:personRole": { + "title": "Person Role", + "description": "Role of the person pertaining to this account.", + "type": "string" } } } @@ -47,9 +52,11 @@ } } }, - "allOf" : [ { - "$ref" : "#/definitions/account-person-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-21" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/account-person-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-21" +} diff --git a/components/mixins/account/related-accounts.schema.json b/components/mixins/account/related-accounts.schema.json index 37daf2660..7acb970a5 100644 --- a/components/mixins/account/related-accounts.schema.json +++ b/components/mixins/account/related-accounts.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/related-accounts", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Related Business Accounts", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/account" ], - "description" : "An array of all related accounts linked to the primary account.", - "definitions" : { - "related-account" : { - "properties" : { - "xdm:relatedAccounts" : { - "title" : "Related Accounts", - "description" : "Related accounts which are linked to a primary Business Account. This is an array of Account IDs.", - "type" : "array", - "items" : { - "type" : "string" + "meta:license": [ + "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/related-accounts", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Related Business Accounts", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/account"], + "description": "An array of all related accounts linked to the primary account.", + "definitions": { + "related-account": { + "properties": { + "xdm:relatedAccounts": { + "title": "Related Accounts", + "description": "Related accounts which are linked to a primary Business Account. This is an array of Account IDs.", + "type": "array", + "items": { + "type": "string" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/related-account" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/related-account" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-19" +} diff --git a/components/mixins/campaign-member/campaign-member-components.schema.json b/components/mixins/campaign-member/campaign-member-components.schema.json index f267978e5..3eb0e3b57 100644 --- a/components/mixins/campaign-member/campaign-member-components.schema.json +++ b/components/mixins/campaign-member/campaign-member-components.schema.json @@ -1,66 +1,71 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/campaign-member-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Campaign Member Components", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/campaign-member" ], - "description" : "This mixin is used to capture B2B campaign member specific relationship attributes that are represented as it is in source and also used for merge/unmerge rules analysis if and when needed.", - "definitions" : { - "campaign-member-components" : { - "properties" : { - "xdm:campaignMemberComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceCampaignMemberID" : { - "title" : "Source Campaign Member ID", - "description" : "Campaign member unique identifier at source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/campaign-member-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Member Components", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/campaign-member"], + "description": "This mixin is used to capture B2B campaign member specific relationship attributes that are represented as it is in source and also used for merge/unmerge rules analysis if and when needed.", + "definitions": { + "campaign-member-components": { + "properties": { + "xdm:campaignMemberComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceCampaignMemberID": { + "title": "Source Campaign Member ID", + "description": "Campaign member unique identifier at source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceCampaignID" : { - "title" : "Source Campaign ID", - "description" : "Campaign unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceCampaignID": { + "title": "Source Campaign ID", + "description": "Campaign unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External ID", - "description" : "External unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External ID", + "description": "External unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourcePersonID" : { - "title" : "Source Person ID", - "description" : "Campaign owner unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourcePersonID": { + "title": "Source Person ID", + "description": "Campaign owner unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceAcquiredByCampaignID" : { - "title" : "Source Acquired By CampaignID", - "description" : "", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceAcquiredByCampaignID": { + "title": "Source Acquired By CampaignID", + "description": "", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:memberStatus" : { - "title" : "Source Campaign Member Status", - "description" : "", - "type" : "string" + "xdm:memberStatus": { + "title": "Source Campaign Member Status", + "description": "", + "type": "string" }, - "xdm:memberStatusReason" : { - "title" : "Source Status Reason", - "description" : "", - "type" : "string" + "xdm:memberStatusReason": { + "title": "Source Status Reason", + "description": "", + "type": "string" }, - "xdm:hasReachedSuccess" : { - "title" : "Source Has Reached Success", - "description" : "", - "type" : "boolean" + "xdm:hasReachedSuccess": { + "title": "Source Has Reached Success", + "description": "", + "type": "boolean" }, - "xdm:reachedSuccessDate" : { - "title" : "Source Reached Success Date", - "description" : "", - "type" : "string", - "format" : "date-time" + "xdm:reachedSuccessDate": { + "title": "Source Reached Success Date", + "description": "", + "type": "string", + "format": "date-time" } } } @@ -68,9 +73,11 @@ } } }, - "allOf" : [ { - "$ref" : "#/definitions/campaign-member-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-29" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/campaign-member-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-29" +} diff --git a/components/mixins/campaign-member/campaign-member-details.schema.json b/components/mixins/campaign-member/campaign-member-details.schema.json index 255193c64..daeec5e62 100644 --- a/components/mixins/campaign-member/campaign-member-details.schema.json +++ b/components/mixins/campaign-member/campaign-member-details.schema.json @@ -1,96 +1,103 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/campaign-member-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Campaign Member Details", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/campaign-member" ], - "description" : "An XDM Business Campaign Member.", - "definitions" : { - "campaign-member-details" : { - "properties" : { - "xdm:memberStatus" : { - "title" : "Campaign Member Status", - "description" : "", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/campaign-member-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Member Details", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/campaign-member"], + "description": "An XDM Business Campaign Member.", + "definitions": { + "campaign-member-details": { + "properties": { + "xdm:memberStatus": { + "title": "Campaign Member Status", + "description": "", + "type": "string" }, - "xdm:memberStatusReason" : { - "title" : "Campaign Member Status Reason", - "description" : "", - "type" : "string" + "xdm:memberStatusReason": { + "title": "Campaign Member Status Reason", + "description": "", + "type": "string" }, - "xdm:nurtureTrackName" : { - "title" : "Nurture Track Name", - "description" : "", - "type" : "string" + "xdm:nurtureTrackName": { + "title": "Nurture Track Name", + "description": "", + "type": "string" }, - "xdm:nurtureCadence" : { - "title" : "Nurture Cadence", - "description" : "", - "type" : "string" + "xdm:nurtureCadence": { + "title": "Nurture Cadence", + "description": "", + "type": "string" }, - "xdm:isExhausted" : { - "title" : "isExhausted", - "description" : "", - "type" : "boolean" + "xdm:isExhausted": { + "title": "isExhausted", + "description": "", + "type": "boolean" }, - "xdm:webinarRegistrationID" : { - "title" : "Webinar Registration ID", - "description" : "", - "type" : "string" + "xdm:webinarRegistrationID": { + "title": "Webinar Registration ID", + "description": "", + "type": "string" }, - "xdm:webinarConfirmationUrl" : { - "title" : "Webinar Confirmation Url", - "description" : "", - "type" : "string" + "xdm:webinarConfirmationUrl": { + "title": "Webinar Confirmation Url", + "description": "", + "type": "string" }, - "xdm:acquiredByCampaignID" : { - "title" : "Acquired By CampaignID", - "description" : "", - "type" : "string" + "xdm:acquiredByCampaignID": { + "title": "Acquired By CampaignID", + "description": "", + "type": "string" }, - "xdm:hasReachedSuccess" : { - "title" : "Has Reached Success", - "description" : "", - "type" : "boolean" + "xdm:hasReachedSuccess": { + "title": "Has Reached Success", + "description": "", + "type": "boolean" }, - "xdm:reachedSuccessDate" : { - "title" : "Reached Success Date", - "description" : "", - "type" : "string", - "format" : "date-time" + "xdm:reachedSuccessDate": { + "title": "Reached Success Date", + "description": "", + "type": "string", + "format": "date-time" }, - "xdm:membershipDate" : { - "title" : "Membership Date", - "description" : "", - "type" : "string", - "format" : "date-time" + "xdm:membershipDate": { + "title": "Membership Date", + "description": "", + "type": "string", + "format": "date-time" }, - "xdm:lastStatus" : { - "title" : "Last Status", - "description" : "", - "type" : "string" + "xdm:lastStatus": { + "title": "Last Status", + "description": "", + "type": "string" }, - "xdm:hasResponded" : { - "title" : "Has Responded", - "description" : "Record whether the member has responded to the workflow stage", - "type" : "boolean" + "xdm:hasResponded": { + "title": "Has Responded", + "description": "Record whether the member has responded to the workflow stage", + "type": "boolean" }, - "xdm:firstRespondedDate" : { - "title" : "First Responded Date", - "description" : "Date captured on which response was submitted", - "type" : "string", - "format" : "date-time" + "xdm:firstRespondedDate": { + "title": "First Responded Date", + "description": "Date captured on which response was submitted", + "type": "string", + "format": "date-time" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/campaign-member-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-08-18" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/campaign-member-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-08-18" +} diff --git a/components/mixins/campaign/campaign-components.schema.json b/components/mixins/campaign/campaign-components.schema.json index d49b304e2..d1d11a6f4 100644 --- a/components/mixins/campaign/campaign-components.schema.json +++ b/components/mixins/campaign/campaign-components.schema.json @@ -1,40 +1,45 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/campaign-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Campaign Components", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/campaign" ], - "description" : "This mixin is used to capture b2b campaign specific relationship attributes that are represented as it is in source and also used for merge/unmerge rules analysis if and when needed.", - "definitions" : { - "campaign-components" : { - "properties" : { - "xdm:campaignComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceCampaignID" : { - "title" : "Source Campaign ID", - "description" : "Campaign unique identifier at source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/campaign-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Components", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/campaign"], + "description": "This mixin is used to capture b2b campaign specific relationship attributes that are represented as it is in source and also used for merge/unmerge rules analysis if and when needed.", + "definitions": { + "campaign-components": { + "properties": { + "xdm:campaignComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceCampaignID": { + "title": "Source Campaign ID", + "description": "Campaign unique identifier at source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceParentCampaignID" : { - "title" : "Source Parent Campaign ID", - "description" : "Account unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceParentCampaignID": { + "title": "Source Parent Campaign ID", + "description": "Account unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External ID", - "description" : "External unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External ID", + "description": "External unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceCampaignOwnerID" : { - "title" : "Source Campaign Owner ID", - "description" : "Campaign owner unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceCampaignOwnerID": { + "title": "Source Campaign Owner ID", + "description": "Campaign owner unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" } } } @@ -42,9 +47,11 @@ } } }, - "allOf" : [ { - "$ref" : "#/definitions/campaign-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-29" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/campaign-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-29" +} diff --git a/components/mixins/campaign/campaign-details.schema.json b/components/mixins/campaign/campaign-details.schema.json index b65af71ff..2b1036598 100644 --- a/components/mixins/campaign/campaign-details.schema.json +++ b/components/mixins/campaign/campaign-details.schema.json @@ -1,127 +1,134 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/campaign-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Campaign Details", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/campaign" ], - "description" : "This mixin is used to capture properties related to business campaign details.", - "definitions" : { - "campaign-details" : { - "properties" : { - "xdm:parentCampaignID" : { - "title" : "Parent Campaign ID", - "description" : "Member type and associated reference ID.", - "type" : "string" - }, - "xdm:campaignStatus" : { - "title" : "Campaign Status", - "description" : "", - "type" : "string" - }, - "xdm:campaignProgressionName" : { - "title" : "Campaign Progression Name", - "description" : "", - "type" : "string" - }, - "xdm:integrationPartnerName" : { - "title" : "Integration Partner Name", - "description" : "", - "type" : "string" - }, - "xdm:channelName" : { - "title" : "Channel Name", - "description" : "", - "type" : "string" - }, - "xdm:campaignStartDate" : { - "title" : "Campaign Start Date", - "description" : "", - "type" : "string", - "format" : "date-time" - }, - "xdm:campaignEndDate" : { - "title" : "Campaign End Date", - "description" : "", - "type" : "string", - "format" : "date-time" - }, - "xdm:timeZone" : { - "title" : "Timezone", - "description" : "", - "type" : "string" - }, - "xdm:timezoneName" : { - "title" : "Timezone Name", - "description" : "", - "type" : "string" - }, - "xdm:timeZoneDelivery" : { - "title" : "TimeZone Delivery", - "description" : "", - "type" : "string" - }, - "xdm:webinarSessionName" : { - "title" : "Webinar Session Name", - "description" : "", - "type" : "string" - }, - "xdm:webinarSessionDescription" : { - "title" : "Webinar Session Description", - "description" : "", - "type" : "string" - }, - "xdm:webinarHistorySyncStatus" : { - "title" : "Webinar History Sync Status", - "description" : "", - "type" : "string" - }, - "xdm:webinarHistorySyncDate" : { - "title" : "Webinar History Sync Date", - "description" : "", - "type" : "string", - "format" : "date-time" - }, - "xdm:isActive" : { - "title" : "Is Active", - "description" : "", - "type" : "boolean" - }, - "xdm:lastActivityDate" : { - "title" : "last Activity Date", - "description" : "", - "type" : "string", - "format" : "date-time" - }, - "xdm:expectedResponse" : { - "title" : "Expected Response", - "description" : "", - "type" : "string" - }, - "xdm:expectedRevenue" : { - "title" : "Expected Revenue", - "description" : "", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency" - }, - "xdm:budgetedCost" : { - "title" : "Budgeted Cost", - "description" : "", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency" - }, - "xdm:actualCost" : { - "title" : "Actual Cost", - "description" : "", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/campaign-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Campaign Details", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/campaign"], + "description": "This mixin is used to capture properties related to business campaign details.", + "definitions": { + "campaign-details": { + "properties": { + "xdm:parentCampaignID": { + "title": "Parent Campaign ID", + "description": "Member type and associated reference ID.", + "type": "string" + }, + "xdm:campaignStatus": { + "title": "Campaign Status", + "description": "", + "type": "string" + }, + "xdm:campaignProgressionName": { + "title": "Campaign Progression Name", + "description": "", + "type": "string" + }, + "xdm:integrationPartnerName": { + "title": "Integration Partner Name", + "description": "", + "type": "string" + }, + "xdm:channelName": { + "title": "Channel Name", + "description": "", + "type": "string" + }, + "xdm:campaignStartDate": { + "title": "Campaign Start Date", + "description": "", + "type": "string", + "format": "date-time" + }, + "xdm:campaignEndDate": { + "title": "Campaign End Date", + "description": "", + "type": "string", + "format": "date-time" + }, + "xdm:timeZone": { + "title": "Timezone", + "description": "", + "type": "string" + }, + "xdm:timezoneName": { + "title": "Timezone Name", + "description": "", + "type": "string" + }, + "xdm:timeZoneDelivery": { + "title": "TimeZone Delivery", + "description": "", + "type": "string" + }, + "xdm:webinarSessionName": { + "title": "Webinar Session Name", + "description": "", + "type": "string" + }, + "xdm:webinarSessionDescription": { + "title": "Webinar Session Description", + "description": "", + "type": "string" + }, + "xdm:webinarHistorySyncStatus": { + "title": "Webinar History Sync Status", + "description": "", + "type": "string" + }, + "xdm:webinarHistorySyncDate": { + "title": "Webinar History Sync Date", + "description": "", + "type": "string", + "format": "date-time" + }, + "xdm:isActive": { + "title": "Is Active", + "description": "", + "type": "boolean" + }, + "xdm:lastActivityDate": { + "title": "last Activity Date", + "description": "", + "type": "string", + "format": "date-time" + }, + "xdm:expectedResponse": { + "title": "Expected Response", + "description": "", + "type": "string" + }, + "xdm:expectedRevenue": { + "title": "Expected Revenue", + "description": "", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency" + }, + "xdm:budgetedCost": { + "title": "Budgeted Cost", + "description": "", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency" + }, + "xdm:actualCost": { + "title": "Actual Cost", + "description": "", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/campaign-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-09-29" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/campaign-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-09-29" +} diff --git a/components/mixins/deprecated/deprecated-profile-consent.schema.json b/components/mixins/deprecated/deprecated-profile-consent.schema.json index 82cae8360..e347cdfd1 100644 --- a/components/mixins/deprecated/deprecated-profile-consent.schema.json +++ b/components/mixins/deprecated/deprecated-profile-consent.schema.json @@ -1,27 +1,34 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/profile-consent", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Privacy/Marketing Preferences (Consent)", - "description" : "This schema captures privacy, personalization and marketing preferences (consents).", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "definitions" : { - "profile-consents" : { - "properties" : { - "xdm:consentsAndPreferences" : { - "title" : "Global Privacy/Marketing Preference Values", - "description" : "Global (User/Profile-level) Privacy/Personalization/Marketing Preferences.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/consent-preferences" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile-consent", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Privacy/Marketing Preferences (Consent)", + "description": "This schema captures privacy, personalization and marketing preferences (consents).", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "definitions": { + "profile-consents": { + "properties": { + "xdm:consentsAndPreferences": { + "title": "Global Privacy/Marketing Preference Values", + "description": "Global (User/Profile-level) Privacy/Personalization/Marketing Preferences.", + "$ref": "https://ns.adobe.com/xdm/datatypes/consent-preferences" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/profile-consents" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/profile-consents" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-alert-setup-steps.schema.json b/components/mixins/deprecated/experienceevent-alert-setup-steps.schema.json index fb646810d..c72f64559 100644 --- a/components/mixins/deprecated/experienceevent-alert-setup-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-alert-setup-steps.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-alert-setup-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Alert Setup Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-alert-setup-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Alert Setup Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["retail", "financial_services", "travel_and_hospitality"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Alert steps such as start, save, failure, and complete.", - "definitions" : { - "alert-setup-steps" : { - "properties" : { - "xdm:alerts" : { - "type" : "object", - "properties" : { - "xdm:alertSetup" : { - "title" : "Alert Setup", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Alert steps such as start, save, failure, and complete.", + "definitions": { + "alert-setup-steps": { + "properties": { + "xdm:alerts": { + "type": "object", + "properties": { + "xdm:alertSetup": { + "title": "Alert Setup", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/alert-setup-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/alert-setup-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-appointment-request-steps.schema.json b/components/mixins/deprecated/experienceevent-appointment-request-steps.schema.json index a71581c0a..7d8ef04c7 100644 --- a/components/mixins/deprecated/experienceevent-appointment-request-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-appointment-request-steps.schema.json @@ -1,35 +1,47 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-appointment-request-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Appointment Request Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "health_and_life_sciences", "manufacturing", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-appointment-request-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Appointment Request Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "financial_services", + "health_and_life_sciences", + "manufacturing", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Steps for setting up any type of appointment with a company.", - "definitions" : { - "appointment-request-steps" : { - "properties" : { - "xdm:userAccount" : { - "type" : "object", - "properties" : { - "xdm:appointmentRequestSteps" : { - "title" : "Appointment Request Steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Steps for setting up any type of appointment with a company.", + "definitions": { + "appointment-request-steps": { + "properties": { + "xdm:userAccount": { + "type": "object", + "properties": { + "xdm:appointmentRequestSteps": { + "title": "Appointment Request Steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/appointment-request-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/appointment-request-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-autopay-enrollment-details.schema.json b/components/mixins/deprecated/experienceevent-autopay-enrollment-details.schema.json index 7d7aa27bf..4ae596778 100644 --- a/components/mixins/deprecated/experienceevent-autopay-enrollment-details.schema.json +++ b/components/mixins/deprecated/experienceevent-autopay-enrollment-details.schema.json @@ -1,40 +1,55 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-autopay-enrollment-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Autopay Enrollment Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "telecom", "automotive", "education", "health_and_life_sciences", "media_and_entertainment" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-autopay-enrollment-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Autopay Enrollment Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "media_and_entertainment" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Autopay enrollment details such as autopay status, start, save, and failure.", - "definitions" : { - "autopay-enrollment-details" : { - "properties" : { - "xdm:autopayEnrollment" : { - "type" : "object", - "properties" : { - "xdm:autoPayEnrollment" : { - "title" : "Autopay Enrollment", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Autopay enrollment details such as autopay status, start, save, and failure.", + "definitions": { + "autopay-enrollment-details": { + "properties": { + "xdm:autopayEnrollment": { + "type": "object", + "properties": { + "xdm:autoPayEnrollment": { + "title": "Autopay Enrollment", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." }, - "xdm:autoPayEnrollmentStatus" : { - "title" : "Autopay Status", - "type" : "boolean", - "description" : "Tracks the visitor's autopay enrollment status." + "xdm:autoPayEnrollmentStatus": { + "title": "Autopay Status", + "type": "boolean", + "description": "Tracks the visitor's autopay enrollment status." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/autopay-enrollment-details" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/autopay-enrollment-details" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-dispute-steps.schema.json b/components/mixins/deprecated/experienceevent-dispute-steps.schema.json index d1d9cf21e..dac50deaa 100644 --- a/components/mixins/deprecated/experienceevent-dispute-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-dispute-steps.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-dispute-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Dispute Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-dispute-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Dispute Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Dispute steps such as start, save, failure, and complete.", - "definitions" : { - "dispute-steps" : { - "properties" : { - "xdm:disputes" : { - "type" : "object", - "properties" : { - "xdm:dispute" : { - "title" : "Dispute", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Dispute steps such as start, save, failure, and complete.", + "definitions": { + "dispute-steps": { + "properties": { + "xdm:disputes": { + "type": "object", + "properties": { + "xdm:dispute": { + "title": "Dispute", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/dispute-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/dispute-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-enduserids-deprecated.schema.json b/components/mixins/deprecated/experienceevent-enduserids-deprecated.schema.json index ac069481f..c57bc7fbc 100644 --- a/components/mixins/deprecated/experienceevent-enduserids-deprecated.schema.json +++ b/components/mixins/deprecated/experienceevent-enduserids-deprecated.schema.json @@ -1,30 +1,38 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-enduserids-deprecated", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "ExperienceEvent endUserIDs (deprecated)", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "ExperienceEvent endUserIDs (deprecated).", - "definitions" : { - "experienceevent-enduserids-deprecated" : { - "properties" : { - "xdm:endUserIDs" : { - "meta:status" : "deprecated", - "title" : "End-User IDs", - "$ref" : "https://ns.adobe.com/xdm/context/enduserids", - "description" : "Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-enduserids-deprecated", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "ExperienceEvent endUserIDs (deprecated)", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "ExperienceEvent endUserIDs (deprecated).", + "definitions": { + "experienceevent-enduserids-deprecated": { + "properties": { + "xdm:endUserIDs": { + "meta:status": "deprecated", + "title": "End-User IDs", + "$ref": "https://ns.adobe.com/xdm/context/enduserids", + "description": "Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-enduserids-deprecated" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-enduserids-deprecated" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-financial-account-creation-steps.schema.json b/components/mixins/deprecated/experienceevent-financial-account-creation-steps.schema.json index 9856cf705..7ce64237c 100644 --- a/components/mixins/deprecated/experienceevent-financial-account-creation-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-financial-account-creation-steps.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-financial-account-creation-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Financial Account Creation Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-financial-account-creation-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Financial Account Creation Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Financial account creation steps such as start, save, failure, and complete.", - "definitions" : { - "financial-account-creation-steps" : { - "properties" : { - "xdm:personalFinances" : { - "type" : "object", - "properties" : { - "xdm:financialAccount" : { - "title" : "Financial Account", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Financial account creation steps such as start, save, failure, and complete.", + "definitions": { + "financial-account-creation-steps": { + "properties": { + "xdm:personalFinances": { + "type": "object", + "properties": { + "xdm:financialAccount": { + "title": "Financial Account", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/financial-account-creation-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/financial-account-creation-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-financial-calculator-steps.schema.json b/components/mixins/deprecated/experienceevent-financial-calculator-steps.schema.json index 08ee68eb8..ee708a9a4 100644 --- a/components/mixins/deprecated/experienceevent-financial-calculator-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-financial-calculator-steps.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-financial-calculator-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Financial Calculator Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-financial-calculator-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Financial Calculator Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "", - "definitions" : { - "financial-calculator-steps" : { - "properties" : { - "xdm:personalFinances" : { - "type" : "object", - "properties" : { - "xdm:calcuator" : { - "title" : "Financial Calculator Steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "", + "definitions": { + "financial-calculator-steps": { + "properties": { + "xdm:personalFinances": { + "type": "object", + "properties": { + "xdm:calcuator": { + "title": "Financial Calculator Steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/financial-calculator-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/financial-calculator-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-paperless-enrollment-steps.schema.json b/components/mixins/deprecated/experienceevent-paperless-enrollment-steps.schema.json index 6bd503a53..0becac0e8 100644 --- a/components/mixins/deprecated/experienceevent-paperless-enrollment-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-paperless-enrollment-steps.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-paperless-enrollment-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Paperless Enrollment Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "travel_and_hospitality", "telecom" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-paperless-enrollment-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Paperless Enrollment Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services", "travel_and_hospitality", "telecom"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Paperless enrollment steps such as start, save, failure, and complete. ", - "definitions" : { - "paperless-enrollment-steps" : { - "properties" : { - "xdm:userAccount" : { - "type" : "object", - "properties" : { - "xdm:paperlessEnrollment" : { - "title" : "Paperless Enrollment", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Paperless enrollment steps such as start, save, failure, and complete. ", + "definitions": { + "paperless-enrollment-steps": { + "properties": { + "xdm:userAccount": { + "type": "object", + "properties": { + "xdm:paperlessEnrollment": { + "title": "Paperless Enrollment", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/paperless-enrollment-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/paperless-enrollment-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-referral-steps.schema.json b/components/mixins/deprecated/experienceevent-referral-steps.schema.json index 9daefd09a..54bd9212d 100644 --- a/components/mixins/deprecated/experienceevent-referral-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-referral-steps.schema.json @@ -1,35 +1,49 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-referral-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Referral Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "media_and_entertainment" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-referral-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Referral Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "media_and_entertainment" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Referral steps such as start, save, failure, and complete.", - "definitions" : { - "referral-steps" : { - "properties" : { - "xdm:web" : { - "type" : "object", - "properties" : { - "xdm:referral" : { - "title" : "Referral", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Referral steps such as start, save, failure, and complete.", + "definitions": { + "referral-steps": { + "properties": { + "xdm:web": { + "type": "object", + "properties": { + "xdm:referral": { + "title": "Referral", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/referral-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/referral-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-request-credit-score-steps.schema.json b/components/mixins/deprecated/experienceevent-request-credit-score-steps.schema.json index 212a0e1e4..37200d654 100644 --- a/components/mixins/deprecated/experienceevent-request-credit-score-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-request-credit-score-steps.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-request-credit-score-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Request Credit Score Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "automotive" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-request-credit-score-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Request Credit Score Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services", "automotive"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "", - "definitions" : { - "request-credit-score-steps" : { - "properties" : { - "xdm:personalFinances" : { - "type" : "object", - "properties" : { - "xdm:requestCreditScore" : { - "title" : "Request Credit Score", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "", + "definitions": { + "request-credit-score-steps": { + "properties": { + "xdm:personalFinances": { + "type": "object", + "properties": { + "xdm:requestCreditScore": { + "title": "Request Credit Score", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/request-credit-score-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/request-credit-score-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-support-request.schema.json b/components/mixins/deprecated/experienceevent-support-request.schema.json index b14551813..06565d2e4 100644 --- a/components/mixins/deprecated/experienceevent-support-request.schema.json +++ b/components/mixins/deprecated/experienceevent-support-request.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-support-request", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Support Request", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "telecom", "high_tech", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-support-request", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Support Request", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services", "telecom", "high_tech", "public_sector"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Included for any type of support request initiated by the customer.", - "definitions" : { - "support-request" : { - "properties" : { - "xdm:supportRequest" : { - "type" : "object", - "properties" : { - "xdm:supportRequestSteps" : { - "title" : "Support Request Steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Included for any type of support request initiated by the customer.", + "definitions": { + "support-request": { + "properties": { + "xdm:supportRequest": { + "type": "object", + "properties": { + "xdm:supportRequestSteps": { + "title": "Support Request Steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/support-request" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/support-request" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/experienceevent-watchlist-steps.schema.json b/components/mixins/deprecated/experienceevent-watchlist-steps.schema.json index c8a3b789d..c914078e6 100644 --- a/components/mixins/deprecated/experienceevent-watchlist-steps.schema.json +++ b/components/mixins/deprecated/experienceevent-watchlist-steps.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-watchlist-steps", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Watchlist Steps", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-watchlist-steps", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Watchlist Steps", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Steps involved in adding stocks, bonds, ETFs, etc to a watchlist such as start, stop, name/symbol.", - "definitions" : { - "watchlist-steps" : { - "properties" : { - "xdm:personalFinances" : { - "type" : "object", - "properties" : { - "xdm:watchlistSteps" : { - "title" : "Watchlist Steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Steps involved in adding stocks, bonds, ETFs, etc to a watchlist such as start, stop, name/symbol.", + "definitions": { + "watchlist-steps": { + "properties": { + "xdm:personalFinances": { + "type": "object", + "properties": { + "xdm:watchlistSteps": { + "title": "Watchlist Steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/watchlist-steps" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/watchlist-steps" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/deprecated/profile-identities-deprecated.schema.json b/components/mixins/deprecated/profile-identities-deprecated.schema.json index 3b48c2fec..85b670aad 100644 --- a/components/mixins/deprecated/profile-identities-deprecated.schema.json +++ b/components/mixins/deprecated/profile-identities-deprecated.schema.json @@ -1,34 +1,42 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-identities-deprecated", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Identities array for profile (deprecated)", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Identities array for profile (deprecated).", - "definitions" : { - "profile-identities-deprecated" : { - "properties" : { - "xdm:identities" : { - "meta:status" : "deprecated", - "title" : "All user identities (deprecated)", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/identity" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-identities-deprecated", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identities array for profile (deprecated)", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Identities array for profile (deprecated).", + "definitions": { + "profile-identities-deprecated": { + "properties": { + "xdm:identities": { + "meta:status": "deprecated", + "title": "All user identities (deprecated)", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/identity" }, - "minItems" : 1, - "description" : "Array of identities. Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead." + "minItems": 1, + "description": "Array of identities. Condensed, normalized encapsulation of all end-user identifiers. Deprecated, use `xdm:identityMap` instead." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-identities-deprecated" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-identities-deprecated" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/experience-event/experienceevent-advertising.schema.json b/components/mixins/experience-event/experienceevent-advertising.schema.json index c672ad8f5..5d0e5b6b4 100644 --- a/components/mixins/experience-event/experienceevent-advertising.schema.json +++ b/components/mixins/experience-event/experienceevent-advertising.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-advertising", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Advertising Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-advertising", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Advertising Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Advertising data such as clicks, completes, impressions, and conversions.", - "definitions" : { - "experienceevent-advertising" : { - "properties" : { - "xdm:advertising" : { - "title" : "Advertising", - "$ref" : "https://ns.adobe.com/xdm/context/advertising", - "description" : "Information related to advertising activity in ExperienceEvents." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Advertising data such as clicks, completes, impressions, and conversions.", + "definitions": { + "experienceevent-advertising": { + "properties": { + "xdm:advertising": { + "title": "Advertising", + "$ref": "https://ns.adobe.com/xdm/context/advertising", + "description": "Information related to advertising activity in ExperienceEvents." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-advertising" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-advertising" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-application.schema.json b/components/mixins/experience-event/experienceevent-application.schema.json index 344cd1e48..b51f49fda 100644 --- a/components/mixins/experience-event/experienceevent-application.schema.json +++ b/components/mixins/experience-event/experienceevent-application.schema.json @@ -1,29 +1,37 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-application", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Application Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Application related data such as crashes, feature usage, launches, and upgrades.", - "definitions" : { - "experienceevent-application" : { - "properties" : { - "xdm:application" : { - "title" : "Application", - "$ref" : "https://ns.adobe.com/xdm/context/application", - "description" : "This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. 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." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-application", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Application Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Application related data such as crashes, feature usage, launches, and upgrades.", + "definitions": { + "experienceevent-application": { + "properties": { + "xdm:application": { + "title": "Application", + "$ref": "https://ns.adobe.com/xdm/context/application", + "description": "This mixin is used to capture application information related to an ExperienceEvent, including the name of the application, app version, installs, launches, crashes, and closures. 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." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-application" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-application" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-card-actions.schema.json b/components/mixins/experience-event/experienceevent-card-actions.schema.json index 5a42cdf07..d5734b5b9 100644 --- a/components/mixins/experience-event/experienceevent-card-actions.schema.json +++ b/components/mixins/experience-event/experienceevent-card-actions.schema.json @@ -1,87 +1,103 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-card-actions", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Card Actions", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-card-actions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Card Actions", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Card action details such as card type as well as activation and lock status.", - "definitions" : { - "card-actions" : { - "properties" : { - "xdm:personalFinances" : { - "type" : "object", - "properties" : { - "xdm:cardID" : { - "title" : "Card ID", - "type" : "string", - "description" : "Tracks the identifier for the card being activated. This might be different from the card number." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Card action details such as card type as well as activation and lock status.", + "definitions": { + "card-actions": { + "properties": { + "xdm:personalFinances": { + "type": "object", + "properties": { + "xdm:cardID": { + "title": "Card ID", + "type": "string", + "description": "Tracks the identifier for the card being activated. This might be different from the card number." }, - "xdm:cardActivated" : { - "title" : "Card Activated Success", - "type" : "integer", - "description" : "Tracks when a card has been successfully activated." + "xdm:cardActivated": { + "title": "Card Activated Success", + "type": "integer", + "description": "Tracks when a card has been successfully activated." }, - "xdm:cardActivationStart" : { - "title" : "Card Activation Started", - "type" : "integer", - "description" : "Tracks when a card activation process has been started." + "xdm:cardActivationStart": { + "title": "Card Activation Started", + "type": "integer", + "description": "Tracks when a card activation process has been started." }, - "xdm:cardCancelled" : { - "title" : "Card Cancelled", - "type" : "integer", - "description" : "Tracks when a card has been cancelled." + "xdm:cardCancelled": { + "title": "Card Cancelled", + "type": "integer", + "description": "Tracks when a card has been cancelled." }, - "xdm:cardControlsLocked" : { - "title" : "Card Controls Locked", - "type" : "integer", - "description" : "Tracks when a card controls have been locked." + "xdm:cardControlsLocked": { + "title": "Card Controls Locked", + "type": "integer", + "description": "Tracks when a card controls have been locked." }, - "xdm:cardControlsUnlocked" : { - "title" : "Card Controls Unlocked", - "type" : "integer", - "description" : "Tracks when a card controls have been unlocked." + "xdm:cardControlsUnlocked": { + "title": "Card Controls Unlocked", + "type": "integer", + "description": "Tracks when a card controls have been unlocked." }, - "xdm:cardLocked" : { - "title" : "Card Locked", - "type" : "integer", - "description" : "Tracks when a card has been locked." + "xdm:cardLocked": { + "title": "Card Locked", + "type": "integer", + "description": "Tracks when a card has been locked." }, - "xdm:cardOrderNew" : { - "title" : "Order New Card", - "type" : "integer", - "description" : "Tracks when a card has been requested." + "xdm:cardOrderNew": { + "title": "Order New Card", + "type": "integer", + "description": "Tracks when a card has been requested." }, - "xdm:cardOrderType" : { - "title" : "Card Order Type", - "type" : "string", - "enum" : [ "new", "lost", "stolen", "never received", "damaged" ], - "description" : "Tracks the type of card order associated with a card order event." + "xdm:cardOrderType": { + "title": "Card Order Type", + "type": "string", + "enum": ["new", "lost", "stolen", "never received", "damaged"], + "description": "Tracks the type of card order associated with a card order event." }, - "xdm:cardType" : { - "title" : "Card Type", - "type" : "string", - "enum" : [ "credit", "debit", "prepaid", "paypal", "atm", "virtual", "hsa", "fsa" ], - "description" : "Tracks the type of card associated with an event." + "xdm:cardType": { + "title": "Card Type", + "type": "string", + "enum": [ + "credit", + "debit", + "prepaid", + "paypal", + "atm", + "virtual", + "hsa", + "fsa" + ], + "description": "Tracks the type of card associated with an event." }, - "xdm:cardUnlocked" : { - "title" : "Card Unlocked", - "type" : "integer", - "description" : "Tracks when a card has been unlocked." + "xdm:cardUnlocked": { + "title": "Card Unlocked", + "type": "integer", + "description": "Tracks when a card has been unlocked." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/card-actions" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-07" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/card-actions" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-07" +} diff --git a/components/mixins/experience-event/experienceevent-channel.schema.json b/components/mixins/experience-event/experienceevent-channel.schema.json index 17dce6ddb..a5480051a 100644 --- a/components/mixins/experience-event/experienceevent-channel.schema.json +++ b/components/mixins/experience-event/experienceevent-channel.schema.json @@ -1,29 +1,37 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-channel", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Channel Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Channel information such as ID, channel type, media type, and location type.", - "definitions" : { - "experienceevent-channel" : { - "properties" : { - "xdm:channel" : { - "title" : "Experience channel", - "description" : "Experience channel related to the ExperienceEvent.", - "$ref" : "https://ns.adobe.com/xdm/channels/channel" + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-channel", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Channel Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Channel information such as ID, channel type, media type, and location type.", + "definitions": { + "experienceevent-channel": { + "properties": { + "xdm:channel": { + "title": "Experience channel", + "description": "Experience channel related to the ExperienceEvent.", + "$ref": "https://ns.adobe.com/xdm/channels/channel" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-channel" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-channel" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-commerce.schema.json b/components/mixins/experience-event/experienceevent-commerce.schema.json index d28c947e6..de24a2a5f 100644 --- a/components/mixins/experience-event/experienceevent-commerce.schema.json +++ b/components/mixins/experience-event/experienceevent-commerce.schema.json @@ -1,40 +1,48 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-commerce", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Commerce Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-commerce", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Commerce Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Commerce data such as product information (SKU, name, quantity), and standard cart operations (order, checkout, abandon).", - "definitions" : { - "experienceevent-commerce" : { - "properties" : { - "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.", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/content/productlistitem" + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Commerce data such as product information (SKU, name, quantity), and standard cart operations (order, checkout, abandon).", + "definitions": { + "experienceevent-commerce": { + "properties": { + "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.", + "items": { + "$ref": "https://ns.adobe.com/xdm/content/productlistitem" } }, - "xdm:commerce" : { - "title" : "Commerce", - "$ref" : "https://ns.adobe.com/xdm/context/commerce", - "description" : "Commerce specific data related to this event." + "xdm:commerce": { + "title": "Commerce", + "$ref": "https://ns.adobe.com/xdm/context/commerce", + "description": "Commerce specific data related to this event." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-commerce" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-commerce" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-consumer.schema.json b/components/mixins/experience-event/experienceevent-consumer.schema.json index 8e394afac..e41c3a395 100644 --- a/components/mixins/experience-event/experienceevent-consumer.schema.json +++ b/components/mixins/experience-event/experienceevent-consumer.schema.json @@ -1,36 +1,63 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-consumer", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Consumer Experience Event", - "type" : "object", - "description" : "Digital content consumption data from web and mobile applications as well as online and offline purchase data such as channel, commerce, and device information.", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "meta:extends" : [ "https://ns.adobe.com/xdm/context/experienceevent-application", "https://ns.adobe.com/xdm/context/experienceevent-channel", "https://ns.adobe.com/xdm/context/experienceevent-environment-details", "https://ns.adobe.com/xdm/context/experienceevent-marketing", "https://ns.adobe.com/xdm/context/experienceevent-media", "https://ns.adobe.com/xdm/context/experienceevent-search", "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", "https://ns.adobe.com/xdm/context/experienceevent-technical-details", "https://ns.adobe.com/xdm/context/experienceevent-web", "https://ns.adobe.com/xdm/context/experienceevent-commerce" ], - "definitions" : { }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-application" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-channel" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-environment-details" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-marketing" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-media" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-search" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-technical-details" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-web" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/experienceevent-commerce" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-consumer", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Consumer Experience Event", + "type": "object", + "description": "Digital content consumption data from web and mobile applications as well as online and offline purchase data such as channel, commerce, and device information.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "meta:extends": [ + "https://ns.adobe.com/xdm/context/experienceevent-application", + "https://ns.adobe.com/xdm/context/experienceevent-channel", + "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "https://ns.adobe.com/xdm/context/experienceevent-media", + "https://ns.adobe.com/xdm/context/experienceevent-search", + "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "https://ns.adobe.com/xdm/context/experienceevent-web", + "https://ns.adobe.com/xdm/context/experienceevent-commerce" + ], + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-application" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-channel" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-environment-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-marketing" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-media" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-search" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-technical-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-web" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/experienceevent-commerce" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-directmarketing.schema.json b/components/mixins/experience-event/experienceevent-directmarketing.schema.json index a3188bc64..80a76327d 100644 --- a/components/mixins/experience-event/experienceevent-directmarketing.schema.json +++ b/components/mixins/experience-event/experienceevent-directmarketing.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-directmarketing", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Direct Marketing Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-directmarketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Direct Marketing Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Direct marketing events such as opens, clicks, impressions, and unsubscribes.", - "definitions" : { - "experienceevent-directmarketing" : { - "properties" : { - "xdm:directMarketing" : { - "title" : "Direct marketing", - "$ref" : "https://ns.adobe.com/xdm/context/direct-marketing", - "description" : "Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Direct marketing events such as opens, clicks, impressions, and unsubscribes.", + "definitions": { + "experienceevent-directmarketing": { + "properties": { + "xdm:directMarketing": { + "title": "Direct marketing", + "$ref": "https://ns.adobe.com/xdm/context/direct-marketing", + "description": "Events and properties related to direct and outbound marketing such as email, direct mail, texts, and in-app notifications." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-directmarketing" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-directmarketing" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-enduserids.schema.json b/components/mixins/experience-event/experienceevent-enduserids.schema.json index e4957a12c..e6d545da1 100644 --- a/components/mixins/experience-event/experienceevent-enduserids.schema.json +++ b/components/mixins/experience-event/experienceevent-enduserids.schema.json @@ -1,29 +1,37 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-enduserids", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "End User ID Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "End user IDs such as AAID, ACID, MCIDs, email, and phone numbers.", - "definitions" : { - "experienceevent-enduserids" : { - "properties" : { - "xdm:endUserIDs" : { - "title" : "EndUserIDs", - "$ref" : "https://ns.adobe.com/xdm/context/enduserids", - "description" : "Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-enduserids", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "End User ID Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "End user IDs such as AAID, ACID, MCIDs, email, and phone numbers.", + "definitions": { + "experienceevent-enduserids": { + "properties": { + "xdm:endUserIDs": { + "title": "EndUserIDs", + "$ref": "https://ns.adobe.com/xdm/context/enduserids", + "description": "Condensed, normalized encapsulation of end user identifiers asserted for this ExperienceEvent." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-enduserids" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-enduserids" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-environment-details.schema.json b/components/mixins/experience-event/experienceevent-environment-details.schema.json index 252bf5157..95c2e0eba 100644 --- a/components/mixins/experience-event/experienceevent-environment-details.schema.json +++ b/components/mixins/experience-event/experienceevent-environment-details.schema.json @@ -1,42 +1,50 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-environment-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Environment Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-environment-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Environment Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Environment details such as device details, browser info, local time, and other geographical information.", - "definitions" : { - "experienceevent-environment-details" : { - "properties" : { - "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." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Environment details such as device details, browser info, local time, and other geographical information.", + "definitions": { + "experienceevent-environment-details": { + "properties": { + "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." }, - "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." + "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." }, - "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, and working hours." + "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, and working hours." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-environment-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-environment-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-file-download-details.schema.json b/components/mixins/experience-event/experienceevent-file-download-details.schema.json index e21978699..40c1bb940 100644 --- a/components/mixins/experience-event/experienceevent-file-download-details.schema.json +++ b/components/mixins/experience-event/experienceevent-file-download-details.schema.json @@ -1,35 +1,54 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-file-download-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "File Download Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-file-download-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "File Download Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "File download details such as file name, size, and transfer status.", - "definitions" : { - "file-download-details" : { - "properties" : { - "xdm:fileTransfer" : { - "type" : "object", - "properties" : { - "xdm:fileDownload" : { - "title" : "File Download", - "$ref" : "https://ns.adobe.com/xdm/datatypes/file-transfer", - "description" : "Tracks all details of a file download. Extension of file transfer data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "File download details such as file name, size, and transfer status.", + "definitions": { + "file-download-details": { + "properties": { + "xdm:fileTransfer": { + "type": "object", + "properties": { + "xdm:fileDownload": { + "title": "File Download", + "$ref": "https://ns.adobe.com/xdm/datatypes/file-transfer", + "description": "Tracks all details of a file download. Extension of file transfer data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/file-download-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-13" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/file-download-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-13" +} diff --git a/components/mixins/experience-event/experienceevent-file-upload-details.schema.json b/components/mixins/experience-event/experienceevent-file-upload-details.schema.json index ee371eef9..8d1ddfc93 100644 --- a/components/mixins/experience-event/experienceevent-file-upload-details.schema.json +++ b/components/mixins/experience-event/experienceevent-file-upload-details.schema.json @@ -1,35 +1,54 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-file-upload-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "File Upload Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-file-upload-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "File Upload Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "File upload details such as file name, size, and transfer status.", - "definitions" : { - "file-upload-details" : { - "properties" : { - "xdm:fileTransfer" : { - "type" : "object", - "properties" : { - "xdm:fileUpload" : { - "title" : "File Upload", - "$ref" : "https://ns.adobe.com/xdm/datatypes/file-transfer", - "description" : "Tracks all details of a file upload. Extension of file transfer data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "File upload details such as file name, size, and transfer status.", + "definitions": { + "file-upload-details": { + "properties": { + "xdm:fileTransfer": { + "type": "object", + "properties": { + "xdm:fileUpload": { + "title": "File Upload", + "$ref": "https://ns.adobe.com/xdm/datatypes/file-transfer", + "description": "Tracks all details of a file upload. Extension of file transfer data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/file-upload-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-13" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/file-upload-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-13" +} diff --git a/components/mixins/experience-event/experienceevent-implementation-details.schema.json b/components/mixins/experience-event/experienceevent-implementation-details.schema.json index 42c91da62..edd8d225a 100644 --- a/components/mixins/experience-event/experienceevent-implementation-details.schema.json +++ b/components/mixins/experience-event/experienceevent-implementation-details.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-implementation-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Implementation Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-implementation-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Implementation Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Information related to the software used to collect an ExperienceEvent such as environment, name, and version.", - "definitions" : { - "experienceevent-implementation-details" : { - "properties" : { - "xdm:implementationDetails" : { - "title" : "Implementation details", - "$ref" : "https://ns.adobe.com/xdm/context/implementationdetails", - "description" : "The details of the software used to collect the ExperienceEvent." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Information related to the software used to collect an ExperienceEvent such as environment, name, and version.", + "definitions": { + "experienceevent-implementation-details": { + "properties": { + "xdm:implementationDetails": { + "title": "Implementation details", + "$ref": "https://ns.adobe.com/xdm/context/implementationdetails", + "description": "The details of the software used to collect the ExperienceEvent." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-implementation-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-implementation-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-knowledge-base-details.schema.json b/components/mixins/experience-event/experienceevent-knowledge-base-details.schema.json index 727001daf..802517288 100644 --- a/components/mixins/experience-event/experienceevent-knowledge-base-details.schema.json +++ b/components/mixins/experience-event/experienceevent-knowledge-base-details.schema.json @@ -1,50 +1,65 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-knowledge-base-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Knowledge Base Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "telecom", "education", "health_and_life_sciences", "high_tech", "manufacturing", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-knowledge-base-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Knowledge Base Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "financial_services", + "telecom", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "", - "definitions" : { - "knowledge-base-details" : { - "properties" : { - "xdm:siteKnowledge" : { - "type" : "object", - "properties" : { - "xdm:knowledgeBaseArticleID" : { - "title" : "Knowledge Base Article ID", - "type" : "string", - "description" : "Tracks the knowledge base article ID when it has been viewed." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "", + "definitions": { + "knowledge-base-details": { + "properties": { + "xdm:siteKnowledge": { + "type": "object", + "properties": { + "xdm:knowledgeBaseArticleID": { + "title": "Knowledge Base Article ID", + "type": "string", + "description": "Tracks the knowledge base article ID when it has been viewed." }, - "xdm:knowledgeBaseArticleType" : { - "title" : "Knowledge Base Article Type", - "type" : "string", - "description" : "Tracks the knowledge base article type when it has been viewed." + "xdm:knowledgeBaseArticleType": { + "title": "Knowledge Base Article Type", + "type": "string", + "description": "Tracks the knowledge base article type when it has been viewed." }, - "xdm:knowledgeBaseArticleView" : { - "title" : "Knowledge Base Article View", - "type" : "integer", - "description" : "Tracked when a knowledge base article has been viewed." + "xdm:knowledgeBaseArticleView": { + "title": "Knowledge Base Article View", + "type": "integer", + "description": "Tracked when a knowledge base article has been viewed." }, - "xdm:knowledgeBaseSearch" : { - "title" : "Knowledge Base Search", - "$ref" : "https://ns.adobe.com/xdm/datatypes/internal-site-search", - "description" : "Extension of internalSearch data type." + "xdm:knowledgeBaseSearch": { + "title": "Knowledge Base Search", + "$ref": "https://ns.adobe.com/xdm/datatypes/internal-site-search", + "description": "Extension of internalSearch data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/knowledge-base-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-15" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/knowledge-base-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-15" +} diff --git a/components/mixins/experience-event/experienceevent-marketing.schema.json b/components/mixins/experience-event/experienceevent-marketing.schema.json index db9337f1e..5d58c5f07 100644 --- a/components/mixins/experience-event/experienceevent-marketing.schema.json +++ b/components/mixins/experience-event/experienceevent-marketing.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-marketing", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Campaign Marketing Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-marketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Campaign Marketing Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Marketing campaign information such as campaign group, name, and tracking code.", - "definitions" : { - "experienceevent-marketing" : { - "properties" : { - "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." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Marketing campaign information such as campaign group, name, and tracking code.", + "definitions": { + "experienceevent-marketing": { + "properties": { + "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." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-marketing" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-marketing" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-media.schema.json b/components/mixins/experience-event/experienceevent-media.schema.json index 41fbdce81..5f3933271 100644 --- a/components/mixins/experience-event/experienceevent-media.schema.json +++ b/components/mixins/experience-event/experienceevent-media.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-media", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Media Interaction Details ", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-media", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Media Interaction Details ", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Track interactions with media such as progress (how much was consumed), total time played, timing of any pauses, and number of media completions.", - "definitions" : { - "experienceevent-media" : { - "properties" : { - "xdm:media" : { - "title" : "Media", - "$ref" : "https://ns.adobe.com/xdm/context/media", - "description" : "Media activity information related to the experience event." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Track interactions with media such as progress (how much was consumed), total time played, timing of any pauses, and number of media completions.", + "definitions": { + "experienceevent-media": { + "properties": { + "xdm:media": { + "title": "Media", + "$ref": "https://ns.adobe.com/xdm/context/media", + "description": "Media activity information related to the experience event." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-media" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-media" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-offer-impression-details.schema.json b/components/mixins/experience-event/experienceevent-offer-impression-details.schema.json index a87a2ec8c..8e0f42a16 100644 --- a/components/mixins/experience-event/experienceevent-offer-impression-details.schema.json +++ b/components/mixins/experience-event/experienceevent-offer-impression-details.schema.json @@ -1,54 +1,71 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-offer-impression-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Offer Impression Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-offer-impression-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Offer Impression Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "", - "definitions" : { - "offer-impression-details" : { - "properties" : { - "xdm:marketing " : { - "type" : "object", - "properties" : { - "xdm:offerClicks" : { - "title" : "Offer Clicks", - "type" : "integer", - "description" : "Counts the number of times an offer has been clicked." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "", + "definitions": { + "offer-impression-details": { + "properties": { + "xdm:marketing ": { + "type": "object", + "properties": { + "xdm:offerClicks": { + "title": "Offer Clicks", + "type": "integer", + "description": "Counts the number of times an offer has been clicked." }, - "xdm:offerDismissals" : { - "title" : "Offer Dismissals", - "type" : "integer", - "description" : "Counts the number of times an offer has been dismissed." + "xdm:offerDismissals": { + "title": "Offer Dismissals", + "type": "integer", + "description": "Counts the number of times an offer has been dismissed." }, - "xdm:offerImpressions" : { - "title" : "Offer Impression Details", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/datatypes/impressions" + "xdm:offerImpressions": { + "title": "Offer Impression Details", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/datatypes/impressions" }, - "description" : "An array of advertisements that have been displayed to a customer." + "description": "An array of advertisements that have been displayed to a customer." }, - "xdm:offerSteps" : { - "title" : "Offer Steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type.", - "meta:status" : "experimental" + "xdm:offerSteps": { + "title": "Offer Steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type.", + "meta:status": "experimental" } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/offer-impression-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-15" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/offer-impression-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-15" +} diff --git a/components/mixins/experience-event/experienceevent-privacy.schema.json b/components/mixins/experience-event/experienceevent-privacy.schema.json index 4668db574..284a31b7d 100644 --- a/components/mixins/experience-event/experienceevent-privacy.schema.json +++ b/components/mixins/experience-event/experienceevent-privacy.schema.json @@ -1,31 +1,39 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-privacy", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Privacy Details", - "description" : "Consent information such as consent format, and consent to personal data.", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "definitions" : { - "experienceevent-privacy" : { - "properties" : { - "xdm:consentStrings" : { - "title" : "Identity level consent information", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/consentstring" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-privacy", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Privacy Details", + "description": "Consent information such as consent format, and consent to personal data.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "definitions": { + "experienceevent-privacy": { + "properties": { + "xdm:consentStrings": { + "title": "Identity level consent information", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/consentstring" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-privacy" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-privacy" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-profile-stitch.schema.json b/components/mixins/experience-event/experienceevent-profile-stitch.schema.json index 9c6930296..e8585faec 100644 --- a/components/mixins/experience-event/experienceevent-profile-stitch.schema.json +++ b/components/mixins/experience-event/experienceevent-profile-stitch.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Profile Stitch Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Profile stitching details such as identity and profile IDs.", - "definitions" : { - "experienceevent-profile-stitch" : { - "properties" : { - "xdm:profileStitch" : { - "title" : "Profile stitch", - "description" : "Details about the IDs that were joined by profile stitching.", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/profileStitch" + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-profile-stitch", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile Stitch Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Profile stitching details such as identity and profile IDs.", + "definitions": { + "experienceevent-profile-stitch": { + "properties": { + "xdm:profileStitch": { + "title": "Profile stitch", + "description": "Details about the IDs that were joined by profile stitching.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/profileStitch" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-profile-stitch" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-profile-stitch" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-pushtracking.schema.json b/components/mixins/experience-event/experienceevent-pushtracking.schema.json index ed7149f4b..4f83da8df 100644 --- a/components/mixins/experience-event/experienceevent-pushtracking.schema.json +++ b/components/mixins/experience-event/experienceevent-pushtracking.schema.json @@ -1,57 +1,65 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-pushtracking", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Push notification tracking", - "type" : "object", - "meta:extensible" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "push notification tracking details", - "definitions" : { - "experienceevent-pushtracking" : { - "properties" : { - "xdm:pushNotificationTracking" : { - "title" : "push notification tracking details", - "type" : "object", - "description" : "Describes interaction with a push notification.", - "properties" : { - "xdm:customAction" : { - "title" : "custom action", - "type" : "object", - "description" : "End user clicked custom action in the push notification", - "properties" : { - "xdm:actionID" : { - "title" : "action ID", - "type" : "string", - "description" : "user clicked custom action identifier" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-pushtracking", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push notification tracking", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "push notification tracking details", + "definitions": { + "experienceevent-pushtracking": { + "properties": { + "xdm:pushNotificationTracking": { + "title": "push notification tracking details", + "type": "object", + "description": "Describes interaction with a push notification.", + "properties": { + "xdm:customAction": { + "title": "custom action", + "type": "object", + "description": "End user clicked custom action in the push notification", + "properties": { + "xdm:actionID": { + "title": "action ID", + "type": "string", + "description": "user clicked custom action identifier" }, - "xdm:value" : { - "title" : "value", - "type" : "number", - "description" : "value associated with the custom action, if any" + "xdm:value": { + "title": "value", + "type": "number", + "description": "value associated with the custom action, if any" } } }, - "xdm:pushProviderMessageID" : { - "title" : "Push Provider message ID", - "type" : "string", - "description" : "ID assigned to this notification as assigned by the push provider" + "xdm:pushProviderMessageID": { + "title": "Push Provider message ID", + "type": "string", + "description": "ID assigned to this notification as assigned by the push provider" }, - "xdm:pushProvider" : { - "title" : "Push Provider", - "type" : "string", - "description" : "Push provider, e.g. apns or fcm" + "xdm:pushProvider": { + "title": "Push Provider", + "type": "string", + "description": "Push provider, e.g. apns or fcm" } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-pushtracking" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-09-28" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-pushtracking" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-09-28" +} diff --git a/components/mixins/experience-event/experienceevent-quote-request-details.schema.json b/components/mixins/experience-event/experienceevent-quote-request-details.schema.json index f26a57912..7adfe41de 100644 --- a/components/mixins/experience-event/experienceevent-quote-request-details.schema.json +++ b/components/mixins/experience-event/experienceevent-quote-request-details.schema.json @@ -1,61 +1,74 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-quote-request-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Quote Request Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "automotive", "health_and_life_sciences", "high_tech", "manufacturing" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-quote-request-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Quote Request Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "financial_services", + "automotive", + "health_and_life_sciences", + "high_tech", + "manufacturing" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Captures different details of a quote request process for various types of quotes - including insurance policies, healthcare, manufacturing orders, or high tech orders.", - "definitions" : { - "quote-request-details" : { - "properties" : { - "xdm:quoteRequestDetails" : { - "type" : "object", - "properties" : { - "xdm:discount" : { - "title" : "Discount", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "Records the discount amount for a quote displayed to a visitor." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Captures different details of a quote request process for various types of quotes - including insurance policies, healthcare, manufacturing orders, or high tech orders.", + "definitions": { + "quote-request-details": { + "properties": { + "xdm:quoteRequestDetails": { + "type": "object", + "properties": { + "xdm:discount": { + "title": "Discount", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "Records the discount amount for a quote displayed to a visitor." }, - "xdm:premium" : { - "title" : "Premium", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "Records the premium amount for a quote displayed to a visitor." + "xdm:premium": { + "title": "Premium", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "Records the premium amount for a quote displayed to a visitor." }, - "xdm:location" : { - "title" : "Location", - "type" : "string", - "description" : "Captures the postal code used for finding retailers near the visitor's location." + "xdm:location": { + "title": "Location", + "type": "string", + "description": "Captures the postal code used for finding retailers near the visitor's location." }, - "xdm:personalDetails" : { - "title" : "Personal Details", - "$ref" : "https://ns.adobe.com/xdm/context/profile-person-details", - "description" : "Extension of the Personal Profile data type." + "xdm:personalDetails": { + "title": "Personal Details", + "$ref": "https://ns.adobe.com/xdm/context/profile-person-details", + "description": "Extension of the Personal Profile data type." }, - "xdm:selectedRetailer" : { - "title" : "Selected Retailer", - "type" : "string", - "description" : "Captures the selected retailer for a quote request, if applicable. " + "xdm:selectedRetailer": { + "title": "Selected Retailer", + "type": "string", + "description": "Captures the selected retailer for a quote request, if applicable. " }, - "xdm:steps" : { - "title" : "Steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type.", - "meta:status" : "deprecated" + "xdm:steps": { + "title": "Steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type.", + "meta:status": "deprecated" } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/quote-request-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-03-31" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/quote-request-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-03-31" +} diff --git a/components/mixins/experience-event/experienceevent-search.schema.json b/components/mixins/experience-event/experienceevent-search.schema.json index 056b52855..bba5935d6 100644 --- a/components/mixins/experience-event/experienceevent-search.schema.json +++ b/components/mixins/experience-event/experienceevent-search.schema.json @@ -1,29 +1,37 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-search", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Search Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Search related information such as search engine, paid search, keywords, and position.", - "definitions" : { - "experienceevent-search" : { - "properties" : { - "xdm:search" : { - "title" : "Search", - "$ref" : "https://ns.adobe.com/xdm/context/search", - "description" : "The information related to web or mobile search." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-search", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Search Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Search related information such as search engine, paid search, keywords, and position.", + "definitions": { + "experienceevent-search": { + "properties": { + "xdm:search": { + "title": "Search", + "$ref": "https://ns.adobe.com/xdm/context/search", + "description": "The information related to web or mobile search." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-search" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-search" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-segmentmembership.schema.json b/components/mixins/experience-event/experienceevent-segmentmembership.schema.json index 1502c2472..d877fa22b 100644 --- a/components/mixins/experience-event/experienceevent-segmentmembership.schema.json +++ b/components/mixins/experience-event/experienceevent-segmentmembership.schema.json @@ -1,46 +1,54 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Segment Membership Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Segment membership data such as which segments an individual belongs to, last qualification time, and membership valid until date.", - "definitions" : { - "experienceevent-segmentmembership" : { - "properties" : { - "xdm:segmentMemberships" : { - "title" : "Segment Memberships", - "meta:status" : "deprecated", - "description" : "The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead.", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/segmentmembershipitem" + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-segmentmembership", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment Membership Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Segment membership data such as which segments an individual belongs to, last qualification time, and membership valid until date.", + "definitions": { + "experienceevent-segmentmembership": { + "properties": { + "xdm:segmentMemberships": { + "title": "Segment Memberships", + "meta:status": "deprecated", + "description": "The segments associated with this ExperienceEvent. Deprecated, use `xdm:segmentMembership` instead.", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembershipitem" } }, - "xdm:segmentMembership" : { - "title" : "Segment Membership Map", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "title" : "Segment Membership per Namespace", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "$ref" : "https://ns.adobe.com/xdm/context/segmentmembership" + "xdm:segmentMembership": { + "title": "Segment Membership Map", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Segment Membership per Namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-segmentmembership" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-segmentmembership" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-service-payment-details.schema.json b/components/mixins/experience-event/experienceevent-service-payment-details.schema.json index cd9a22481..68005620b 100644 --- a/components/mixins/experience-event/experienceevent-service-payment-details.schema.json +++ b/components/mixins/experience-event/experienceevent-service-payment-details.schema.json @@ -1,35 +1,42 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-service-payment-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Service Payment Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "telecom" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-service-payment-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Service Payment Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services", "telecom"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Service Payment Details such as ID, type, and amount.", - "definitions" : { - "service-payment-details" : { - "properties" : { - "xdm:service-payment-details" : { - "type" : "object", - "properties" : { - "xdm:servicePayment" : { - "title" : "Service Payment", - "$ref" : "https://ns.adobe.com/xdm/datatypes/transaction", - "description" : "Extension of transaction data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Service Payment Details such as ID, type, and amount.", + "definitions": { + "service-payment-details": { + "properties": { + "xdm:service-payment-details": { + "type": "object", + "properties": { + "xdm:servicePayment": { + "title": "Service Payment", + "$ref": "https://ns.adobe.com/xdm/datatypes/transaction", + "description": "Extension of transaction data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/service-payment-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-15" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/service-payment-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-15" +} diff --git a/components/mixins/experience-event/experienceevent-social-network-usage-details.schema.json b/components/mixins/experience-event/experienceevent-social-network-usage-details.schema.json index 59f68d555..f2a5fa013 100644 --- a/components/mixins/experience-event/experienceevent-social-network-usage-details.schema.json +++ b/components/mixins/experience-event/experienceevent-social-network-usage-details.schema.json @@ -1,70 +1,89 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-social-network-usage-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Social Network Usage Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-social-network-usage-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Social Network Usage Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Social network usage information such as share, content, and network. ", - "definitions" : { - "social-network-usage-details" : { - "properties" : { - "xdm:socialMarketing " : { - "type" : "object", - "properties" : { - "xdm:sharedContent" : { - "title" : "Shared Content", - "type" : "string", - "description" : "Tracks the page/url/content/value of the item being shared." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Social network usage information such as share, content, and network. ", + "definitions": { + "social-network-usage-details": { + "properties": { + "xdm:socialMarketing ": { + "type": "object", + "properties": { + "xdm:sharedContent": { + "title": "Shared Content", + "type": "string", + "description": "Tracks the page/url/content/value of the item being shared." }, - "xdm:follow" : { - "title" : "Follow", - "type" : "integer", - "description" : "Tracks when a social follow event has occurred." + "xdm:follow": { + "title": "Follow", + "type": "integer", + "description": "Tracks when a social follow event has occurred." }, - "xdm:sharedMessage" : { - "title" : "Shared Message", - "type" : "string", - "description" : "Message that the sender sent" + "xdm:sharedMessage": { + "title": "Shared Message", + "type": "string", + "description": "Message that the sender sent" }, - "xdm:interactions" : { - "title" : "Interactions", - "type" : "integer", - "description" : "The total number of social interactions." + "xdm:interactions": { + "title": "Interactions", + "type": "integer", + "description": "The total number of social interactions." }, - "xdm:network" : { - "title" : "Network", - "type" : "string", - "description" : "Tracks the social sharing network in use, i.e. Facebook, Twitter, Instagram, etc." + "xdm:network": { + "title": "Network", + "type": "string", + "description": "Tracks the social sharing network in use, i.e. Facebook, Twitter, Instagram, etc." }, - "xdm:target" : { - "title" : "Target", - "type" : "string", - "description" : "For social interactions, this is the URL (or resource) which receives the social network action." + "xdm:target": { + "title": "Target", + "type": "string", + "description": "For social interactions, this is the URL (or resource) which receives the social network action." }, - "xdm:recipient" : { - "title" : "Recipient", - "type" : "string", - "description" : "Recipient of the shared content" + "xdm:recipient": { + "title": "Recipient", + "type": "string", + "description": "Recipient of the shared content" }, - "xdm:share" : { - "title" : "Share", - "type" : "integer", - "description" : "Tracks when a social sharing event has occurred." + "xdm:share": { + "title": "Share", + "type": "integer", + "description": "Tracks when a social sharing event has occurred." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/social-network-usage-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-15" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/social-network-usage-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-15" +} diff --git a/components/mixins/experience-event/experienceevent-support-site-search.schema.json b/components/mixins/experience-event/experienceevent-support-site-search.schema.json index 49d0dd947..5f60a741c 100644 --- a/components/mixins/experience-event/experienceevent-support-site-search.schema.json +++ b/components/mixins/experience-event/experienceevent-support-site-search.schema.json @@ -1,35 +1,50 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-support-site-search", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Support Site Search", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services", "telecom", "education", "health_and_life_sciences", "high_tech", "manufacturing", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-support-site-search", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Support Site Search", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "financial_services", + "telecom", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "", - "definitions" : { - "support-site-search" : { - "properties" : { - "xdm:siteKnowledge" : { - "type" : "object", - "properties" : { - "xdm:supportSiteSearch" : { - "title" : "Support Site Search", - "$ref" : "https://ns.adobe.com/xdm/datatypes/internal-site-search", - "description" : "Extension of internalSearch data type." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "", + "definitions": { + "support-site-search": { + "properties": { + "xdm:siteKnowledge": { + "type": "object", + "properties": { + "xdm:supportSiteSearch": { + "title": "Support Site Search", + "$ref": "https://ns.adobe.com/xdm/datatypes/internal-site-search", + "description": "Extension of internalSearch data type." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/support-site-search" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-15" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/support-site-search" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-15" +} diff --git a/components/mixins/experience-event/experienceevent-survey-response-details.schema.json b/components/mixins/experience-event/experienceevent-survey-response-details.schema.json index 282bbedfb..70bfe7558 100644 --- a/components/mixins/experience-event/experienceevent-survey-response-details.schema.json +++ b/components/mixins/experience-event/experienceevent-survey-response-details.schema.json @@ -1,57 +1,76 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-survey-response-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Survey Response Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-survey-response-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Survey Response Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "", - "definitions" : { - "survey-response-details" : { - "properties" : { - "xdm:surveyResponse" : { - "type" : "object", - "properties" : { - "xdm:surveyAnswers" : { - "title" : "Survey Answers", - "type" : "array", - "items" : { - "type" : "string" + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "", + "definitions": { + "survey-response-details": { + "properties": { + "xdm:surveyResponse": { + "type": "object", + "properties": { + "xdm:surveyAnswers": { + "title": "Survey Answers", + "type": "array", + "items": { + "type": "string" }, - "description" : "An array of the answers provided by the visitor within a survey." + "description": "An array of the answers provided by the visitor within a survey." }, - "xdm:surveyID" : { - "title" : "Survey ID", - "type" : "string", - "description" : "ID for the specific survey taken." + "xdm:surveyID": { + "title": "Survey ID", + "type": "string", + "description": "ID for the specific survey taken." }, - "xdm:surveyQuestions" : { - "title" : "Survey Questions", - "type" : "array", - "items" : { - "type" : "string" + "xdm:surveyQuestions": { + "title": "Survey Questions", + "type": "array", + "items": { + "type": "string" }, - "description" : "An array of the questions presented to the visitor within a survey." + "description": "An array of the questions presented to the visitor within a survey." }, - "xdm:surveySteps" : { - "title" : "Survey Steps", - "$ref" : "https://ns.adobe.com/xdm/datatypes/tool-usage", - "description" : "Extension of toolUsage data type.", - "meta:status" : "deprecated" + "xdm:surveySteps": { + "title": "Survey Steps", + "$ref": "https://ns.adobe.com/xdm/datatypes/tool-usage", + "description": "Extension of toolUsage data type.", + "meta:status": "deprecated" } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/survey-response-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-15" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/survey-response-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-15" +} diff --git a/components/mixins/experience-event/experienceevent-technical-details.schema.json b/components/mixins/experience-event/experienceevent-technical-details.schema.json index 5987eb0cd..4fb07523c 100644 --- a/components/mixins/experience-event/experienceevent-technical-details.schema.json +++ b/components/mixins/experience-event/experienceevent-technical-details.schema.json @@ -1,35 +1,43 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-technical-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Technical Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Technical details including data source code, tags, and timestamps.", - "definitions" : { - "experienceevent-technical-details" : { - "properties" : { - "xdm:dataSource" : { - "title" : "Data source", - "$ref" : "https://ns.adobe.com/xdm/data/datasource", - "description" : "Globally unique identification of a data source." + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-technical-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Technical Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Technical details including data source code, tags, and timestamps.", + "definitions": { + "experienceevent-technical-details": { + "properties": { + "xdm:dataSource": { + "title": "Data source", + "$ref": "https://ns.adobe.com/xdm/data/datasource", + "description": "Globally unique identification of a data source." }, - "xdm:receivedTimestamp" : { - "title" : "Received time stamp", - "type" : "string", - "format" : "date-time", - "description" : "The time at which this interaction was received by a server." + "xdm:receivedTimestamp": { + "title": "Received time stamp", + "type": "string", + "format": "date-time", + "description": "The time at which this interaction was received by a server." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-technical-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-technical-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/experience-event/experienceevent-user-login-process.schema.json b/components/mixins/experience-event/experienceevent-user-login-process.schema.json index 3a5316f9d..c8c105dd0 100644 --- a/components/mixins/experience-event/experienceevent-user-login-process.schema.json +++ b/components/mixins/experience-event/experienceevent-user-login-process.schema.json @@ -1,125 +1,144 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/experienceevent-user-login-process", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "User Login Process", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/experienceevent-user-login-process", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "User Login Process", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "User login details such as login state, location, and type, as well as forgot username and password counts.", - "definitions" : { - "user-login-process" : { - "properties" : { - "xdm:userAccount" : { - "type" : "object", - "properties" : { - "xdm:accountSwitch" : { - "title" : "Switch User Accounts", - "type" : "integer", - "description" : "Captures when a visitor switches their account during a visit." - }, - "xdm:cookieConsentAccepted" : { - "title" : "Cookie Consent Accepted", - "type" : "boolean", - "description" : "Tracked when a visitor opts-in to allowing cookies to be set within their browser." - }, - "xdm:cookieConsentViewed" : { - "title" : "Cookie Consent Viewed", - "type" : "integer", - "description" : "Tracked when a visitor views the cookie consent information." - }, - "xdm:forgotPassword" : { - "title" : "Forgot Password", - "type" : "integer", - "description" : "Counter event when a visitor begins the forgot password process." - }, - "xdm:forgotUsername" : { - "title" : "Forgot Username", - "type" : "integer", - "description" : "Counter event when a visitor begins the forgot username process." - }, - "xdm:login" : { - "title" : "Visitor Login", - "type" : "integer", - "description" : "Counter event indicating a successful visitor login." - }, - "xdm:loginBiometric" : { - "title" : "Biometric Authentication", - "type" : "boolean", - "description" : "Flag determining if the user has used a biometric authentication process to login." - }, - "xdm:loginFailure" : { - "title" : "Visitor Login Failure", - "type" : "integer", - "description" : "Counter event indicating a failed visitor login attempt." - }, - "xdm:loginLocation" : { - "title" : "Login Page Location", - "type" : "string", - "description" : "When multiple login locations exist on the page, this value should be used to identify the specific location the user used for login" - }, - "xdm:loginKeychain" : { - "title" : "Keychain ", - "type" : "boolean", - "description" : "Flag determining if the user has used a keychain authentication process to login." - }, - "xdm:loginMultiFactor" : { - "title" : "Multi-Factor Authentication", - "type" : "boolean", - "description" : "Flag determining if the user has used a multi-factor authentication process to login." - }, - "xdm:loginStatus" : { - "title" : "Login Status", - "type" : "string", - "description" : "Used to track the current login status for site visitors, regardless of whether login occurred as a result of a login during the current session or a previous session as identified by a cookie value. " - }, - "xdm:loginThirdParty" : { - "title" : "Login with Third Party", - "type" : "integer", - "description" : "Counter event that is incremented when a visitor has used another login network to authenticate, such as Apple, Facebook, or Google." - }, - "xdm:loginThirdPartySite" : { - "title" : "Third Party Login Site", - "type" : "string", - "description" : "Tracks the site used to authetnicate when a third-party sign-in event is tracked." - }, - "xdm:loginType" : { - "title" : "User Login Type", - "type" : "string", - "description" : "Email address vs social login" - }, - "xdm:logout" : { - "title" : "Visitor Logout", - "type" : "integer", - "description" : "Counter event indicating a successful visitor logout." - }, - "xdm:resetPassword" : { - "title" : "Reset Password", - "type" : "integer", - "description" : "Counter event when a visitor begins the reset password process." - }, - "xdm:sessionTimeout" : { - "title" : "Session Timeout", - "type" : "integer", - "description" : "Tracked when a visitor has an authenticated session that is automatically logged out after a predetermined amount of time." - }, - "xdm:updateProfile" : { - "title" : "Account Profile Update", - "type" : "integer", - "description" : "Counter event indicating a user has updated their account profile." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "User login details such as login state, location, and type, as well as forgot username and password counts.", + "definitions": { + "user-login-process": { + "properties": { + "xdm:userAccount": { + "type": "object", + "properties": { + "xdm:accountSwitch": { + "title": "Switch User Accounts", + "type": "integer", + "description": "Captures when a visitor switches their account during a visit." + }, + "xdm:cookieConsentAccepted": { + "title": "Cookie Consent Accepted", + "type": "boolean", + "description": "Tracked when a visitor opts-in to allowing cookies to be set within their browser." + }, + "xdm:cookieConsentViewed": { + "title": "Cookie Consent Viewed", + "type": "integer", + "description": "Tracked when a visitor views the cookie consent information." + }, + "xdm:forgotPassword": { + "title": "Forgot Password", + "type": "integer", + "description": "Counter event when a visitor begins the forgot password process." + }, + "xdm:forgotUsername": { + "title": "Forgot Username", + "type": "integer", + "description": "Counter event when a visitor begins the forgot username process." + }, + "xdm:login": { + "title": "Visitor Login", + "type": "integer", + "description": "Counter event indicating a successful visitor login." + }, + "xdm:loginBiometric": { + "title": "Biometric Authentication", + "type": "boolean", + "description": "Flag determining if the user has used a biometric authentication process to login." + }, + "xdm:loginFailure": { + "title": "Visitor Login Failure", + "type": "integer", + "description": "Counter event indicating a failed visitor login attempt." + }, + "xdm:loginLocation": { + "title": "Login Page Location", + "type": "string", + "description": "When multiple login locations exist on the page, this value should be used to identify the specific location the user used for login" + }, + "xdm:loginKeychain": { + "title": "Keychain ", + "type": "boolean", + "description": "Flag determining if the user has used a keychain authentication process to login." + }, + "xdm:loginMultiFactor": { + "title": "Multi-Factor Authentication", + "type": "boolean", + "description": "Flag determining if the user has used a multi-factor authentication process to login." + }, + "xdm:loginStatus": { + "title": "Login Status", + "type": "string", + "description": "Used to track the current login status for site visitors, regardless of whether login occurred as a result of a login during the current session or a previous session as identified by a cookie value. " + }, + "xdm:loginThirdParty": { + "title": "Login with Third Party", + "type": "integer", + "description": "Counter event that is incremented when a visitor has used another login network to authenticate, such as Apple, Facebook, or Google." + }, + "xdm:loginThirdPartySite": { + "title": "Third Party Login Site", + "type": "string", + "description": "Tracks the site used to authetnicate when a third-party sign-in event is tracked." + }, + "xdm:loginType": { + "title": "User Login Type", + "type": "string", + "description": "Email address vs social login" + }, + "xdm:logout": { + "title": "Visitor Logout", + "type": "integer", + "description": "Counter event indicating a successful visitor logout." + }, + "xdm:resetPassword": { + "title": "Reset Password", + "type": "integer", + "description": "Counter event when a visitor begins the reset password process." + }, + "xdm:sessionTimeout": { + "title": "Session Timeout", + "type": "integer", + "description": "Tracked when a visitor has an authenticated session that is automatically logged out after a predetermined amount of time." + }, + "xdm:updateProfile": { + "title": "Account Profile Update", + "type": "integer", + "description": "Counter event indicating a user has updated their account profile." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/user-login-process" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-01-15" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/user-login-process" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-01-15" +} diff --git a/components/mixins/experience-event/experienceevent-web.schema.json b/components/mixins/experience-event/experienceevent-web.schema.json index 954f4a2a2..c0df00e8c 100644 --- a/components/mixins/experience-event/experienceevent-web.schema.json +++ b/components/mixins/experience-event/experienceevent-web.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/experienceevent-web", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Web Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/experienceevent-web", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Web Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/experienceevent" ], - "description" : "Use for information regarding web details events such as interaction, page details, and referrer.", - "definitions" : { - "experienceevent-web" : { - "properties" : { - "xdm:web" : { - "title" : "Web", - "$ref" : "https://ns.adobe.com/xdm/context/webinfo", - "description" : "The information related to web page and link of the ExperienceEvent." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/experienceevent"], + "description": "Use for information regarding web details events such as interaction, page details, and referrer.", + "definitions": { + "experienceevent-web": { + "properties": { + "xdm:web": { + "title": "Web", + "$ref": "https://ns.adobe.com/xdm/context/webinfo", + "description": "The information related to web page and link of the ExperienceEvent." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/experienceevent-web" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/experienceevent-web" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/graphs/graph-edge.schema.json b/components/mixins/graphs/graph-edge.schema.json index ee7edf5fc..c373393b4 100644 --- a/components/mixins/graphs/graph-edge.schema.json +++ b/components/mixins/graphs/graph-edge.schema.json @@ -1,115 +1,125 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/graph-edge", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Graph Edge", - "type" : "object", - "description" : "Information regarding the relationship between two nodes or vertices such as data provider, and edge information.", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/graphs" ], - "definitions" : { - "graph-edge" : { - "properties" : { - "xdm:edges" : { - "title" : "Array Of Edges", - "description" : "Array of edges.", - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:edgeId" : { - "title" : "Edge Identifier", - "description" : "The unique identifier of the identity associated with this graph edge.", - "type" : "string" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graph-edge", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graph Edge", + "type": "object", + "description": "Information regarding the relationship between two nodes or vertices such as data provider, and edge information.", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/graphs"], + "definitions": { + "graph-edge": { + "properties": { + "xdm:edges": { + "title": "Array Of Edges", + "description": "Array of edges.", + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:edgeId": { + "title": "Edge Identifier", + "description": "The unique identifier of the identity associated with this graph edge.", + "type": "string" }, - "xdm:sourceNodeId" : { - "title" : "Source Node Id", - "description" : "Source node identifier.", - "type" : "string" + "xdm:sourceNodeId": { + "title": "Source Node Id", + "description": "Source node identifier.", + "type": "string" }, - "xdm:targetNodeId" : { - "title" : "Target Node Id", - "description" : "Target node identifier.", - "type" : "string" + "xdm:targetNodeId": { + "title": "Target Node Id", + "description": "Target node identifier.", + "type": "string" }, - "xdm:relation" : { - "title" : "Relation Description", - "description" : "Relation description.", - "type" : "string" + "xdm:relation": { + "title": "Relation Description", + "description": "Relation description.", + "type": "string" }, - "xdm:label" : { - "title" : "Label", - "description" : "Additional description.", - "type" : "string" + "xdm:label": { + "title": "Label", + "description": "Additional description.", + "type": "string" }, - "xdm:dataProvider" : { - "type" : "array", - "items" : { - "type" : "object", - "additionalProperties" : false, - "properties" : { - "xdm:dataProviderId" : { - "title" : "Data Provider Id", - "description" : "Identifier of the Data Provider..", - "type" : "integer" + "xdm:dataProvider": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": false, + "properties": { + "xdm:dataProviderId": { + "title": "Data Provider Id", + "description": "Identifier of the Data Provider..", + "type": "integer" }, - "xdm:firstSeenTimestamp" : { - "title" : "Relationship Observed Time and Date", - "description" : "Time and date the relation was first observed.", - "type" : "string", - "format" : "date-time" + "xdm:firstSeenTimestamp": { + "title": "Relationship Observed Time and Date", + "description": "Time and date the relation was first observed.", + "type": "string", + "format": "date-time" }, - "xdm:lastSeenTimestamp" : { - "title" : "Relationship Observed most recent Time and Date", - "description" : "Time and date the relation was last observed.", - "type" : "string", - "format" : "date-time" + "xdm:lastSeenTimestamp": { + "title": "Relationship Observed most recent Time and Date", + "description": "Time and date the relation was last observed.", + "type": "string", + "format": "date-time" }, - "xdm:trusted" : { - "title" : "Trusted Data Source Flag", - "description" : "Indicator of whether the data source is trusted or not.", - "type" : "boolean", - "default" : true + "xdm:trusted": { + "title": "Trusted Data Source Flag", + "description": "Indicator of whether the data source is trusted or not.", + "type": "boolean", + "default": true }, - "xdm:directed" : { - "title" : "Directed Or Birectional", - "description" : "Nature of graph whether it is directed or birectional.", - "type" : "boolean", - "default" : false + "xdm:directed": { + "title": "Directed Or Birectional", + "description": "Nature of graph whether it is directed or birectional.", + "type": "boolean", + "default": false }, - "xdm:relationType" : { - "title" : "Relationship Type", - "description" : "The method that established the relationship - Online/Offline deterministic/probabilistic.", - "type" : "string", - "enum" : [ "online_deterministic", "online_probabilistic", "offline_deterministic", "offline_probabilistic" ], - "meta:enum" : { - "online_deterministic" : "Online Deterministic", - "online_probabilistic" : "Online Probabilistic", - "offline_deterministic" : "Offline Deterministic", - "offline_probabilistic" : "Offline Probabilistic" + "xdm:relationType": { + "title": "Relationship Type", + "description": "The method that established the relationship - Online/Offline deterministic/probabilistic.", + "type": "string", + "enum": [ + "online_deterministic", + "online_probabilistic", + "offline_deterministic", + "offline_probabilistic" + ], + "meta:enum": { + "online_deterministic": "Online Deterministic", + "online_probabilistic": "Online Probabilistic", + "offline_deterministic": "Offline Deterministic", + "offline_probabilistic": "Offline Probabilistic" } }, - "xdm:frequency" : { - "title" : "Frequency", - "description" : "Frequency of the observed relationship.", - "type" : "integer" + "xdm:frequency": { + "title": "Frequency", + "description": "Frequency of the observed relationship.", + "type": "integer" }, - "xdm:score" : { - "title" : "Relationship Score", - "description" : "Imputed score of relationship.", - "type" : "number" + "xdm:score": { + "title": "Relationship Score", + "description": "Imputed score of relationship.", + "type": "number" }, - "xdm:summedRecency" : { - "title" : "Recency Score", - "description" : "Recency score of relationship.", - "type" : "integer" + "xdm:summedRecency": { + "title": "Recency Score", + "description": "Recency score of relationship.", + "type": "integer" }, - "xdm:lastCalculatedTimestamp" : { - "title" : "Last Calculated Data And Time", - "description" : "Time and date the relationship score was last calculated.", - "type" : "string", - "format" : "date-time" + "xdm:lastCalculatedTimestamp": { + "title": "Last Calculated Data And Time", + "description": "Time and date the relationship score was last calculated.", + "type": "string", + "format": "date-time" } } } @@ -120,13 +130,17 @@ } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/graph-edge" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/auditable" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/graph-edge" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/graphs/graph-node.schema.json b/components/mixins/graphs/graph-node.schema.json index 82c6afeb9..86aa783fd 100644 --- a/components/mixins/graphs/graph-node.schema.json +++ b/components/mixins/graphs/graph-node.schema.json @@ -1,67 +1,72 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/graph-node", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Graph Node/Vertex Schema", - "type" : "object", - "description" : "Use for node information such as data source, type, and label.", - "meta:auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/graphs" ], - "definitions" : { - "graph-node" : { - "properties" : { - "xdm:nodes" : { - "title" : "Array Of Nodes", - "description" : "Array of nodes.", - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:nodeId" : { - "title" : "Node Identifier", - "description" : "The unique identifier of the identity associated with this graph node.", - "type" : "string" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graph-node", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graph Node/Vertex Schema", + "type": "object", + "description": "Use for node information such as data source, type, and label.", + "meta:auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/graphs"], + "definitions": { + "graph-node": { + "properties": { + "xdm:nodes": { + "title": "Array Of Nodes", + "description": "Array of nodes.", + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:nodeId": { + "title": "Node Identifier", + "description": "The unique identifier of the identity associated with this graph node.", + "type": "string" }, - "xdm:nodeType" : { - "title" : "Node Type", - "description" : "Type of node.", - "type" : "string" + "xdm:nodeType": { + "title": "Node Type", + "description": "Type of node.", + "type": "string" }, - "xdm:label" : { - "title" : "Node Label", - "description" : "Node label.", - "type" : "string" + "xdm:label": { + "title": "Node Label", + "description": "Node label.", + "type": "string" }, - "xdm:dataSource" : { - "title" : "Data Source", - "description" : "Data source for the node.", - "type" : "string" + "xdm:dataSource": { + "title": "Data Source", + "description": "Data source for the node.", + "type": "string" }, - "xdm:firstSeenTimestamp" : { - "title" : "Node First Seen Date And Time", - "description" : "Time and date this node was first seen.", - "type" : "string", - "format" : "date-time" + "xdm:firstSeenTimestamp": { + "title": "Node First Seen Date And Time", + "description": "Time and date this node was first seen.", + "type": "string", + "format": "date-time" }, - "xdm:lastSeenTimestamp" : { - "title" : "Node Last Seen Date And Time", - "description" : "Time and date this node was last seen.", - "type" : "string", - "format" : "date-time" + "xdm:lastSeenTimestamp": { + "title": "Node Last Seen Date And Time", + "description": "Time and date this node was last seen.", + "type": "string", + "format": "date-time" }, - "xdm:firstCreateTimestamp" : { - "title" : "Node Created Date And Time", - "description" : "Time and date this node was first created.", - "type" : "string", - "format" : "date-time" + "xdm:firstCreateTimestamp": { + "title": "Node Created Date And Time", + "description": "Time and date this node was first created.", + "type": "string", + "format": "date-time" }, - "xdm:lastModifiedTimestamp" : { - "title" : "Node Last Modified Date And Time", - "description" : "Time and date this node was last modified.", - "type" : "string", - "format" : "date-time" + "xdm:lastModifiedTimestamp": { + "title": "Node Last Modified Date And Time", + "description": "Time and date this node was last modified.", + "type": "string", + "format": "date-time" } } } @@ -69,11 +74,14 @@ } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/graph-node" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/graph-node" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/graphs/graph.schema.json b/components/mixins/graphs/graph.schema.json index dad551e5d..60f30fa6a 100644 --- a/components/mixins/graphs/graph.schema.json +++ b/components/mixins/graphs/graph.schema.json @@ -1,60 +1,69 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/graph", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Graph Schema", - "type" : "object", - "description" : "Use for host graph data such as label, type, and creation timestamps.", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/graphs" ], - "definitions" : { - "graph" : { - "properties" : { - "xdm:graphId" : { - "title" : "Graph Identifier", - "description" : "The unique identifier of the identity associated with this graph.", - "type" : "string" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/graph", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Graph Schema", + "type": "object", + "description": "Use for host graph data such as label, type, and creation timestamps.", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/graphs"], + "definitions": { + "graph": { + "properties": { + "xdm:graphId": { + "title": "Graph Identifier", + "description": "The unique identifier of the identity associated with this graph.", + "type": "string" }, - "xdm:label" : { - "title" : "Graph Label", - "description" : "Graph label.", - "type" : "string" + "xdm:label": { + "title": "Graph Label", + "description": "Graph label.", + "type": "string" }, - "xdm:directed" : { - "title" : "Directed Graph Indicator", - "description" : "Directed graph indicator.", - "type" : "boolean", - "default" : true + "xdm:directed": { + "title": "Directed Graph Indicator", + "description": "Directed graph indicator.", + "type": "boolean", + "default": true }, - "xdm:graphType" : { - "title" : "Graph Type", - "description" : "Graph type. Examples - Person graph, Third party graph, Private graph etc.", - "type" : "string" + "xdm:graphType": { + "title": "Graph Type", + "description": "Graph type. Examples - Person graph, Third party graph, Private graph etc.", + "type": "string" }, - "xdm:firstCreatedTimestamp" : { - "title" : "Graph Created Date And Time", - "description" : "Time and date this graph was created.", - "type" : "string", - "format" : "date-time" + "xdm:firstCreatedTimestamp": { + "title": "Graph Created Date And Time", + "description": "Time and date this graph was created.", + "type": "string", + "format": "date-time" }, - "xdm:lastModifiedTimestamp" : { - "title" : "Graph Last Modified Date And Time", - "description" : "Time and date this graph was last modified.", - "type" : "string", - "format" : "date-time" + "xdm:lastModifiedTimestamp": { + "title": "Graph Last Modified Date And Time", + "description": "Time and date this graph was last modified.", + "type": "string", + "format": "date-time" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/graph" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/auditable" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/graph" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/auditable" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/marketing-list/marketing-list-components.schema.json b/components/mixins/marketing-list/marketing-list-components.schema.json index 7d68491ae..36e3e21c9 100644 --- a/components/mixins/marketing-list/marketing-list-components.schema.json +++ b/components/mixins/marketing-list/marketing-list-components.schema.json @@ -1,29 +1,34 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/marketing-list-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Marketing List Components", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/marketing-list" ], - "description" : "Marketing list relationship attributes form a single data source. This is the place to add attributes if there is a need to do any kind of segmentation in future.", - "definitions" : { - "marketing-list-components" : { - "properties" : { - "xdm:marketingListComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceMarketingListID" : { - "title" : "Source Marketing List Identifier", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/marketing-list-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Marketing List Components", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/marketing-list"], + "description": "Marketing list relationship attributes form a single data source. This is the place to add attributes if there is a need to do any kind of segmentation in future.", + "definitions": { + "marketing-list-components": { + "properties": { + "xdm:marketingListComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceMarketingListID": { + "title": "Source Marketing List Identifier", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External Identifier", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External Identifier", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" } } } @@ -31,11 +36,14 @@ } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/marketing-list-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-14" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/marketing-list-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-14" +} diff --git a/components/mixins/marketing-list/marketing-list-member-components.schema.json b/components/mixins/marketing-list/marketing-list-member-components.schema.json index 801119e2f..d5790b981 100644 --- a/components/mixins/marketing-list/marketing-list-member-components.schema.json +++ b/components/mixins/marketing-list/marketing-list-member-components.schema.json @@ -1,37 +1,44 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/marketing-list-member-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Marketing List Member Components", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/marketing-list-member" ], - "description" : "Relationship attributes for a marketing list and its members from a single data source. This is also the place to add attributes if there is a need to do any kind of segmentation in future.", - "definitions" : { - "marketing-list-member-components" : { - "properties" : { - "xdm:marketingListMemberComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceMarketingListMemberID" : { - "title" : "Source Marketing List Identifier", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/marketing-list-member-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Marketing List Member Components", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/classes/marketing-list-member" + ], + "description": "Relationship attributes for a marketing list and its members from a single data source. This is also the place to add attributes if there is a need to do any kind of segmentation in future.", + "definitions": { + "marketing-list-member-components": { + "properties": { + "xdm:marketingListMemberComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceMarketingListMemberID": { + "title": "Source Marketing List Identifier", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourcePersonID" : { - "title" : "Source Person Identifier", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourcePersonID": { + "title": "Source Person Identifier", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceMarketingListID" : { - "title" : "Source Marketing List Identifier", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceMarketingListID": { + "title": "Source Marketing List Identifier", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External Identifier", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External Identifier", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" } } } @@ -39,11 +46,14 @@ } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/marketing-list-member-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-14" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/marketing-list-member-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-14" +} diff --git a/components/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json b/components/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json index 634b6c08a..8446a8888 100644 --- a/components/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json +++ b/components/mixins/opportunity-contact-role/opportunity-contact-role-details.schema.json @@ -1,43 +1,53 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/opportunity-contact-role-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Buying Group Additional Properties", - "type" : "object", - "meta:extensible" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/opportunity-contact-role" ], - "description" : "Opportunity Contact Role additional properties", - "definitions" : { - "opportunity-contact-role-details" : { - "properties" : { - "xdm:roleID" : { - "title" : "Contact Role ID", - "description" : "Contact role unique identifier.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/opportunity-contact-role-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Buying Group Additional Properties", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/opportunity-contact-role" + ], + "description": "Opportunity Contact Role additional properties", + "definitions": { + "opportunity-contact-role-details": { + "properties": { + "xdm:roleID": { + "title": "Contact Role ID", + "description": "Contact role unique identifier.", + "type": "string" }, - "xdm:opportunityContactRole" : { - "title" : "Opportunity Contact Role", - "description" : "Role of the opportunity contact like finance , sales .", - "type" : "string" + "xdm:opportunityContactRole": { + "title": "Opportunity Contact Role", + "description": "Role of the opportunity contact like finance , sales .", + "type": "string" }, - "xdm:isPrimary" : { - "title" : "Primary Flag", - "description" : "A flag to signify that this is the primary opportunity contact", - "type" : "boolean" + "xdm:isPrimary": { + "title": "Primary Flag", + "description": "A flag to signify that this is the primary opportunity contact", + "type": "boolean" }, - "xdm:isDeleted" : { - "title" : "Deleted Flag", - "description" : "A flag to signify that this opportunity is in deleted state.", - "type" : "boolean" + "xdm:isDeleted": { + "title": "Deleted Flag", + "description": "A flag to signify that this opportunity is in deleted state.", + "type": "boolean" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/opportunity-contact-role-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-08-18" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/opportunity-contact-role-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-08-18" +} diff --git a/components/mixins/opportunity/opportunity-components.schema.json b/components/mixins/opportunity/opportunity-components.schema.json index 379f05f5e..c47fbe821 100644 --- a/components/mixins/opportunity/opportunity-components.schema.json +++ b/components/mixins/opportunity/opportunity-components.schema.json @@ -1,45 +1,50 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/opportunity-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Opportunity Components", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/opportunity" ], - "description" : "This Mixin is used to capture B2B Opportunity specific relationship attributes that are represented as it is in source and also used for merge/unmerge rules analysis if and when needed ", - "definitions" : { - "opportunity-components" : { - "properties" : { - "xdm:opportunityComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceOpportunityID" : { - "title" : "Source Opportunity ID", - "description" : "Opportunity unique identifier at source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/opportunity-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Opportunity Components", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/opportunity"], + "description": "This Mixin is used to capture B2B Opportunity specific relationship attributes that are represented as it is in source and also used for merge/unmerge rules analysis if and when needed ", + "definitions": { + "opportunity-components": { + "properties": { + "xdm:opportunityComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceOpportunityID": { + "title": "Source Opportunity ID", + "description": "Opportunity unique identifier at source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceAccountID" : { - "title" : "Source Account ID", - "description" : "Account unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceAccountID": { + "title": "Source Account ID", + "description": "Account unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External ID", - "description" : "External unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External ID", + "description": "External unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceOpportunityOwnerID" : { - "title" : "Source Opportunity Owner ID", - "description" : "Opportunity owner unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceOpportunityOwnerID": { + "title": "Source Opportunity Owner ID", + "description": "Opportunity owner unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceCampaignID" : { - "title" : "Source Campaign ID", - "description" : "Campaign unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceCampaignID": { + "title": "Source Campaign ID", + "description": "Campaign unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" } } } @@ -47,9 +52,11 @@ } } }, - "allOf" : [ { - "$ref" : "#/definitions/opportunity-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-09" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/opportunity-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-09" +} diff --git a/components/mixins/opportunity/opportunity-details.schema.json b/components/mixins/opportunity/opportunity-details.schema.json index 8c6b455f6..702714648 100644 --- a/components/mixins/opportunity/opportunity-details.schema.json +++ b/components/mixins/opportunity/opportunity-details.schema.json @@ -1,111 +1,118 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/opportunity-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Opportunity Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/opportunity" ], - "description" : "This mixin is used to capture and maintain additional opportunity attributes that are used by industry crm systems.", - "definitions" : { - "opportunity-details" : { - "properties" : { - "xdm:campaignID" : { - "title" : "Campaign ID", - "description" : "Campaign unique identifer reference.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/opportunity-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Opportunity Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/opportunity"], + "description": "This mixin is used to capture and maintain additional opportunity attributes that are used by industry crm systems.", + "definitions": { + "opportunity-details": { + "properties": { + "xdm:campaignID": { + "title": "Campaign ID", + "description": "Campaign unique identifer reference.", + "type": "string" }, - "xdm:fiscalYear" : { - "title" : "Fiscal Year", - "description" : "The fiscal year this opportunity is targeted.", - "type" : "integer", - "pattern" : "^([0-9]{4})$" + "xdm:fiscalYear": { + "title": "Fiscal Year", + "description": "The fiscal year this opportunity is targeted.", + "type": "integer", + "pattern": "^([0-9]{4})$" }, - "xdm:fiscalQuarter" : { - "title" : "Fiscal Quarter", - "description" : "The fiscal quarter this opportunity is targeted.", - "type" : "string", - "pattern" : "^([1-4]{1})$|^([Qq][1-4]{1})$" + "xdm:fiscalQuarter": { + "title": "Fiscal Quarter", + "description": "The fiscal quarter this opportunity is targeted.", + "type": "string", + "pattern": "^([1-4]{1})$|^([Qq][1-4]{1})$" }, - "xdm:forecastCategory" : { - "title" : "Forecast Category", - "description" : "Forecast Category determined by the opportunity Stage value eg: omitted,pipeline,bestcase,commit,closed.", - "type" : "string" + "xdm:forecastCategory": { + "title": "Forecast Category", + "description": "Forecast Category determined by the opportunity Stage value eg: omitted,pipeline,bestcase,commit,closed.", + "type": "string" }, - "xdm:forecastCategoryName" : { - "title" : "Forecast Category Name", - "description" : "Forecast category name that is displayed in reports for a perticular forecast category.", - "type" : "string" + "xdm:forecastCategoryName": { + "title": "Forecast Category Name", + "description": "Forecast category name that is displayed in reports for a perticular forecast category.", + "type": "string" }, - "xdm:isClosed" : { - "title" : "Closed Flag", - "description" : "Flag indicating if this opportunity is closed.", - "type" : "boolean" + "xdm:isClosed": { + "title": "Closed Flag", + "description": "Flag indicating if this opportunity is closed.", + "type": "boolean" }, - "xdm:isWon" : { - "title" : "Won Flag", - "description" : "Flag indicating if this opportunity is Won.", - "type" : "boolean" + "xdm:isWon": { + "title": "Won Flag", + "description": "Flag indicating if this opportunity is Won.", + "type": "boolean" }, - "xdm:probabilityPercentage" : { - "title" : "Probability Percentage", - "description" : "Likelihood that opportunity will close, stated as a percentage.", - "type" : "number", - "minimum" : 0, - "maximum" : 100 + "xdm:probabilityPercentage": { + "title": "Probability Percentage", + "description": "Likelihood that opportunity will close, stated as a percentage.", + "type": "number", + "minimum": 0, + "maximum": 100 }, - "xdm:opportunityAmount" : { - "title" : "Opportunity Amount", - "description" : "Estimated total sale amount.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency" + "xdm:opportunityAmount": { + "title": "Opportunity Amount", + "description": "Estimated total sale amount.", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency" }, - "xdm:expectedRevenue" : { - "title" : "Expected Revenue", - "description" : "Calculated revenue based on the Amount and Probability.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency" + "xdm:expectedRevenue": { + "title": "Expected Revenue", + "description": "Calculated revenue based on the Amount and Probability.", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency" }, - "xdm:opportunityQuantity" : { - "title" : "Opportunity Quantity", - "description" : "Total of all quantity field values for all products in the Products related list for this opportunity.", - "type" : "integer", - "minimum" : 0, - "default" : 0 + "xdm:opportunityQuantity": { + "title": "Opportunity Quantity", + "description": "Total of all quantity field values for all products in the Products related list for this opportunity.", + "type": "integer", + "minimum": 0, + "default": 0 }, - "xdm:expectedCloseDate" : { - "title" : "Expected Close Date", - "description" : "Expected date of closure for this opportunity.", - "type" : "string", - "format" : "date" + "xdm:expectedCloseDate": { + "title": "Expected Close Date", + "description": "Expected date of closure for this opportunity.", + "type": "string", + "format": "date" }, - "xdm:actualCloseDate" : { - "title" : "Actual Close Date", - "description" : "Actual date of closure for this opportunity.", - "type" : "string", - "format" : "date-time" + "xdm:actualCloseDate": { + "title": "Actual Close Date", + "description": "Actual date of closure for this opportunity.", + "type": "string", + "format": "date-time" }, - "xdm:lastActivityDate" : { - "title" : "Last Activity Date", - "description" : "Last activity date for this opportunity.", - "type" : "string", - "format" : "date-time" + "xdm:lastActivityDate": { + "title": "Last Activity Date", + "description": "Last activity date for this opportunity.", + "type": "string", + "format": "date-time" }, - "xdm:leadSource" : { - "title" : "Lead Source", - "description" : "Source of the opportunity such as Advertisement, Partner, or Web.", - "type" : "string" + "xdm:leadSource": { + "title": "Lead Source", + "description": "Source of the opportunity such as Advertisement, Partner, or Web.", + "type": "string" }, - "xdm:nextStep" : { - "title" : "Next Step", - "description" : "Description of next task in closing opportunity.", - "type" : "string" + "xdm:nextStep": { + "title": "Next Step", + "description": "Description of next task in closing opportunity.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/opportunity-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-09-09" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/opportunity-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-09-09" +} diff --git a/components/mixins/opportunity/opportunity-person-components.schema.json b/components/mixins/opportunity/opportunity-person-components.schema.json index aafbf18e4..66e2d9624 100644 --- a/components/mixins/opportunity/opportunity-person-components.schema.json +++ b/components/mixins/opportunity/opportunity-person-components.schema.json @@ -1,45 +1,52 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/opportunity-person-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Opportunity Person Relation Components", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/opportunity-person" ], - "description" : "XDM business opportunity person relation component details.", - "definitions" : { - "opportunity-person-components" : { - "properties" : { - "xdm:opportunityPersonComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourceOpportunityPersonID" : { - "title" : "Source Opportunity Person ID", - "description" : "Opportunity person relationship unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/opportunity-person-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Opportunity Person Relation Components", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/classes/opportunity-person" + ], + "description": "XDM business opportunity person relation component details.", + "definitions": { + "opportunity-person-components": { + "properties": { + "xdm:opportunityPersonComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourceOpportunityPersonID": { + "title": "Source Opportunity Person ID", + "description": "Opportunity person relationship unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceExternalID" : { - "title" : "Source External ID", - "description" : "External source unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceExternalID": { + "title": "Source External ID", + "description": "External source unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourceOpportunityID" : { - "title" : "Source Opportunity ID", - "description" : "Opportunity unique identifier at the source.", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourceOpportunityID": { + "title": "Source Opportunity ID", + "description": "Opportunity unique identifier at the source.", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:sourcePersonID" : { - "title" : "Source Person ID", - "description" : "Person unique identifer at the source .", - "$ref" : "https://ns.adobe.com/xdm/datatypes/b2b-source" + "xdm:sourcePersonID": { + "title": "Source Person ID", + "description": "Person unique identifer at the source .", + "$ref": "https://ns.adobe.com/xdm/datatypes/b2b-source" }, - "xdm:personRole" : { - "title" : "Person Role", - "description" : "Role of the person pertaining to this opportunity", - "type" : "string" + "xdm:personRole": { + "title": "Person Role", + "description": "Role of the person pertaining to this opportunity", + "type": "string" } } } @@ -47,9 +54,11 @@ } } }, - "allOf" : [ { - "$ref" : "#/definitions/opportunity-person-components" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-09-09" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/opportunity-person-components" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-09-09" +} diff --git a/components/mixins/product/product-catalog-category.schema.json b/components/mixins/product/product-catalog-category.schema.json index 7c6e391e4..6864ea81d 100644 --- a/components/mixins/product/product-catalog-category.schema.json +++ b/components/mixins/product/product-catalog-category.schema.json @@ -1,33 +1,40 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/product-catalog-category", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product Catalog Category", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/product" ], - "description" : "This mixin is used to capture properties related to product catalog category.", - "definitions" : { - "product-catalog-category" : { - "properties" : { - "xdm:productCatalogCategoryName" : { - "title" : "Product Category Name", - "type" : "string", - "description" : "friendly name of the product category." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/product-catalog-category", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product Catalog Category", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/product"], + "description": "This mixin is used to capture properties related to product catalog category.", + "definitions": { + "product-catalog-category": { + "properties": { + "xdm:productCatalogCategoryName": { + "title": "Product Category Name", + "type": "string", + "description": "friendly name of the product category." }, - "xdm:parentProductCatalogCategoryName" : { - "title" : "Parent Product Catalog Category Name", - "type" : "string", - "description" : "Parent product category name used to build hierarchy." + "xdm:parentProductCatalogCategoryName": { + "title": "Parent Product Catalog Category Name", + "type": "string", + "description": "Parent product category name used to build hierarchy." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/product-catalog-category" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/product-catalog-category" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/product/product-catalog.schema.json b/components/mixins/product/product-catalog.schema.json index f680f4919..51aaf2e27 100644 --- a/components/mixins/product/product-catalog.schema.json +++ b/components/mixins/product/product-catalog.schema.json @@ -1,33 +1,40 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/product-catalog", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product Catalog", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/product" ], - "description" : "This mixin is used to capture properties related to product catalog.", - "definitions" : { - "product-catalog" : { - "properties" : { - "xdm:productCatalogName" : { - "title" : "Product Catalog Name", - "type" : "string", - "description" : "friendly name of the product catalog." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/product-catalog", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product Catalog", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/product"], + "description": "This mixin is used to capture properties related to product catalog.", + "definitions": { + "product-catalog": { + "properties": { + "xdm:productCatalogName": { + "title": "Product Catalog Name", + "type": "string", + "description": "friendly name of the product catalog." }, - "xdm:productCatalogDescription" : { - "title" : "Product Catalog Description", - "type" : "string", - "description" : "Catalog description of the product." + "xdm:productCatalogDescription": { + "title": "Product Catalog Description", + "type": "string", + "description": "Catalog description of the product." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/product-catalog" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/product-catalog" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/product/product-category.schema.json b/components/mixins/product/product-category.schema.json index 0b8daf93e..071de98aa 100644 --- a/components/mixins/product/product-category.schema.json +++ b/components/mixins/product/product-category.schema.json @@ -1,43 +1,50 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/product-category", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product Category", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/product" ], - "description" : "This mixin is used to capture properties related to product category.", - "definitions" : { - "product-category" : { - "properties" : { - "xdm:productCategoryName" : { - "title" : "Product Category Name", - "type" : "string", - "description" : "friendly name of the product category." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/product-category", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product Category", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/product"], + "description": "This mixin is used to capture properties related to product category.", + "definitions": { + "product-category": { + "properties": { + "xdm:productCategoryName": { + "title": "Product Category Name", + "type": "string", + "description": "friendly name of the product category." }, - "xdm:productCategoryDescription" : { - "title" : "Product Category Description", - "type" : "string", - "description" : "Friendly description of product category." + "xdm:productCategoryDescription": { + "title": "Product Category Description", + "type": "string", + "description": "Friendly description of product category." }, - "xdm:productSubcategoryName" : { - "title" : "Product Subcategory Name", - "type" : "string", - "description" : "friendly name of the product subcategory." + "xdm:productSubcategoryName": { + "title": "Product Subcategory Name", + "type": "string", + "description": "friendly name of the product subcategory." }, - "xdm:productSubcategoryDescription" : { - "title" : "Product Sub category Description", - "type" : "string", - "description" : "Friendly description of product subcategory." + "xdm:productSubcategoryDescription": { + "title": "Product Sub category Description", + "type": "string", + "description": "Friendly description of product subcategory." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/product-category" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-11-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/product-category" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-11-19" +} diff --git a/components/mixins/product/product-identifiers.schema.json b/components/mixins/product/product-identifiers.schema.json index 0bffcc017..3c6da40e9 100644 --- a/components/mixins/product/product-identifiers.schema.json +++ b/components/mixins/product/product-identifiers.schema.json @@ -1,47 +1,54 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/product-identifiers", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product Identifiers", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/product" ], - "description" : "This mixin is used to capture properties related to product identifiers generic to all industries.", - "definitions" : { - "product-identifiers" : { - "properties" : { - "xdm:productSKU" : { - "title" : "Product SKU", - "type" : "string", - "description" : "The unique SKU (stock keeping unit) of the product assigned by the vendor." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/product-identifiers", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product Identifiers", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/product"], + "description": "This mixin is used to capture properties related to product identifiers generic to all industries.", + "definitions": { + "product-identifiers": { + "properties": { + "xdm:productSKU": { + "title": "Product SKU", + "type": "string", + "description": "The unique SKU (stock keeping unit) of the product assigned by the vendor." }, - "xdm:productGTIN" : { - "title" : "Product GTIN", - "type" : "string", - "description" : "Global Trade Item Number of the product." + "xdm:productGTIN": { + "title": "Product GTIN", + "type": "string", + "description": "Global Trade Item Number of the product." }, - "xdm:productImageURL" : { - "title" : "Product Image URL", - "type" : "string", - "format" : "uri", - "description" : "The URL for the primary product image of the product." + "xdm:productImageURL": { + "title": "Product Image URL", + "type": "string", + "format": "uri", + "description": "The URL for the primary product image of the product." }, - "xdm:productSearchKeywords" : { - "title" : "Product Search Keywords", - "type" : "array", - "items" : { - "type" : "string" + "xdm:productSearchKeywords": { + "title": "Product Search Keywords", + "type": "array", + "items": { + "type": "string" }, - "description" : "The search keywords associated with the product." + "description": "The search keywords associated with the product." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/product-identifiers" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/product-identifiers" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/product/product-measurement.schema.json b/components/mixins/product/product-measurement.schema.json index 0eb9730bc..79ffa6740 100644 --- a/components/mixins/product/product-measurement.schema.json +++ b/components/mixins/product/product-measurement.schema.json @@ -1,38 +1,45 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/product-measurement", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Product Measurement", - "type" : "object", - "auditable" : true, - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/classes/product" ], - "description" : "This mixin is used to capture properties related to product measurements.", - "definitions" : { - "product-measurement" : { - "properties" : { - "xdm:productSize" : { - "title" : "Product Size", - "type" : "string", - "description" : "Standard product size for the product." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/product-measurement", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Product Measurement", + "type": "object", + "auditable": true, + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/classes/product"], + "description": "This mixin is used to capture properties related to product measurements.", + "definitions": { + "product-measurement": { + "properties": { + "xdm:productSize": { + "title": "Product Size", + "type": "string", + "description": "Standard product size for the product." }, - "xdm:unitOfMeasureCode" : { - "title" : "Product Unit Of Measure Code", - "type" : "string", - "description" : "Standard unit of measure of the product and or variation and relates the units for the size measurement." + "xdm:unitOfMeasureCode": { + "title": "Product Unit Of Measure Code", + "type": "string", + "description": "Standard unit of measure of the product and or variation and relates the units for the size measurement." }, - "xdm:unitOfMeasureName" : { - "title" : "Product Unit Of Measure Name", - "type" : "string", - "description" : "Friendly name for product unit of measure." + "xdm:unitOfMeasureName": { + "title": "Product Unit Of Measure Name", + "type": "string", + "description": "Friendly name for product unit of measure." } } } }, - "allOf" : [ { - "$ref" : "#/definitions/product-measurement" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/product-measurement" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/profile/b2b-person-components.schema.json b/components/mixins/profile/b2b-person-components.schema.json index 79c8e655a..b533d9cf2 100644 --- a/components/mixins/profile/b2b-person-components.schema.json +++ b/components/mixins/profile/b2b-person-components.schema.json @@ -1,69 +1,74 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/b2b-person-components", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Person Components", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "This Mixin is used to capture B2B Person specific relationship attributes and other attributes which are required for person segmentation.", - "definitions" : { - "b2b-person-components" : { - "properties" : { - "xdm:personComponents" : { - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:sourcePersonID" : { - "title" : "Source Person ID", - "description" : "Source person ID.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/b2b-person-components", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Person Components", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "This Mixin is used to capture B2B Person specific relationship attributes and other attributes which are required for person segmentation.", + "definitions": { + "b2b-person-components": { + "properties": { + "xdm:personComponents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:sourcePersonID": { + "title": "Source Person ID", + "description": "Source person ID.", + "type": "string" }, - "xdm:sourceAccountID" : { - "title" : "Source Account ID", - "description" : "Source account ID.", - "type" : "string" + "xdm:sourceAccountID": { + "title": "Source Account ID", + "description": "Source account ID.", + "type": "string" }, - "xdm:sourceConvertedContactID" : { - "title" : "Source Converted Contact ID", - "description" : "Source converted contact ID.", - "type" : "string" + "xdm:sourceConvertedContactID": { + "title": "Source Converted Contact ID", + "description": "Source converted contact ID.", + "type": "string" }, - "xdm:sourceExternalID" : { - "title" : "Source External ID", - "description" : "External source unique identifier at the source.", - "type" : "string" + "xdm:sourceExternalID": { + "title": "Source External ID", + "description": "External source unique identifier at the source.", + "type": "string" }, - "xdm:workEmail" : { - "title" : "Work Email ID of B2B Person", - "$ref" : "https://ns.adobe.com/xdm/context/emailaddress" + "xdm:workEmail": { + "title": "Work Email ID of B2B Person", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress" }, - "xdm:personType" : { - "title" : "Person Type", - "description" : "Type of the B2B person.", - "type" : "string" + "xdm:personType": { + "title": "Person Type", + "description": "Type of the B2B person.", + "type": "string" }, - "xdm:personStatus" : { - "title" : "Person Status", - "description" : "Field recording the current marketing/sales status of the Person.", - "type" : "string" + "xdm:personStatus": { + "title": "Person Status", + "description": "Field recording the current marketing/sales status of the Person.", + "type": "string" }, - "xdm:personSource" : { - "title" : "Person Source", - "description" : "Source from where the information regarding the person was received.", - "type" : "string" + "xdm:personSource": { + "title": "Person Source", + "description": "Source from where the information regarding the person was received.", + "type": "string" }, - "xdm:personScore" : { - "title" : "Person Score", - "description" : "A Score generated for a person by the CRM system.", - "type" : "number" + "xdm:personScore": { + "title": "Person Score", + "description": "A Score generated for a person by the CRM system.", + "type": "number" }, - "xdm:personGroupID" : { - "title" : "Person Group ID", - "description" : "Group identifier for the person.", - "type" : "string" + "xdm:personGroupID": { + "title": "Person Group ID", + "description": "Group identifier for the person.", + "type": "string" } } } @@ -71,11 +76,14 @@ } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/b2b-person-components" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-09-09" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/b2b-person-components" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-09-09" +} diff --git a/components/mixins/profile/b2b-person-details.schema.json b/components/mixins/profile/b2b-person-details.schema.json index 22957fcb5..f72413e1f 100644 --- a/components/mixins/profile/b2b-person-details.schema.json +++ b/components/mixins/profile/b2b-person-details.schema.json @@ -1,126 +1,141 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/b2b-person-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Business Person Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/b2b-person-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Business Person Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "This mixin is used to capture B2B Person specific attributes. A B2B Person could be a contact/lead etc.", - "definitions" : { - "b2b-person-segment-traits" : { - "properties" : { - "xdm:b2b" : { - "type" : "object", - "properties" : { - "xdm:personType" : { - "title" : "Person Type", - "description" : "Type of the B2B person.", - "type" : "string" + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "This mixin is used to capture B2B Person specific attributes. A B2B Person could be a contact/lead etc.", + "definitions": { + "b2b-person-segment-traits": { + "properties": { + "xdm:b2b": { + "type": "object", + "properties": { + "xdm:personType": { + "title": "Person Type", + "description": "Type of the B2B person.", + "type": "string" }, - "xdm:personStatus" : { - "title" : "Person Status", - "description" : "Field recording the current marketing/sales status of the Person.", - "type" : "string" + "xdm:personStatus": { + "title": "Person Status", + "description": "Field recording the current marketing/sales status of the Person.", + "type": "string" }, - "xdm:personSource" : { - "title" : "Person Source", - "description" : "Source from where the information regarding the person was received.", - "type" : "string" + "xdm:personSource": { + "title": "Person Source", + "description": "Source from where the information regarding the person was received.", + "type": "string" }, - "xdm:personScore" : { - "title" : "Person Score", - "description" : "A Score generated for a person by the CRM system.", - "type" : "number" + "xdm:personScore": { + "title": "Person Score", + "description": "A Score generated for a person by the CRM system.", + "type": "number" }, - "xdm:personGroupID" : { - "title" : "Person Group ID", - "description" : "Group identifier for the person.", - "type" : "string" + "xdm:personGroupID": { + "title": "Person Group ID", + "description": "Group identifier for the person.", + "type": "string" } } } } }, - "b2b-person-details" : { - "properties" : { - "xdm:b2b" : { - "type" : "object", - "properties" : { - "xdm:accountID" : { - "title" : "Contact Account id", - "description" : "ID of the account that’s the parent of this person.", - "type" : "string" + "b2b-person-details": { + "properties": { + "xdm:b2b": { + "type": "object", + "properties": { + "xdm:accountID": { + "title": "Contact Account id", + "description": "ID of the account that’s the parent of this person.", + "type": "string" }, - "xdm:isBlocked" : { - "title" : "Blocked Indicator", - "description" : "Indicator if the person is blocked or not.", - "type" : "boolean" + "xdm:isBlocked": { + "title": "Blocked Indicator", + "description": "Indicator if the person is blocked or not.", + "type": "boolean" }, - "xdm:blockedCause" : { - "title" : "Blocked Cause", - "description" : "Reason why the person is blocked.", - "type" : "string" + "xdm:blockedCause": { + "title": "Blocked Cause", + "description": "Reason why the person is blocked.", + "type": "string" }, - "xdm:isMarketingSuspended" : { - "title" : "Marketing Suspended Indicator", - "description" : "Marketing suspended flag.", - "type" : "boolean" + "xdm:isMarketingSuspended": { + "title": "Marketing Suspended Indicator", + "description": "Marketing suspended flag.", + "type": "boolean" }, - "xdm:marketingSuspendedCause" : { - "title" : "Marketing Suspended Cause", - "description" : "Reason why the person is suspended for any marketing purposes.", - "type" : "string" + "xdm:marketingSuspendedCause": { + "title": "Marketing Suspended Cause", + "description": "Reason why the person is suspended for any marketing purposes.", + "type": "string" }, - "xdm:isConverted" : { - "title" : "Converted Indicator", - "description" : "Indicates whether the Lead was successfully converted or not.", - "type" : "boolean" + "xdm:isConverted": { + "title": "Converted Indicator", + "description": "Indicates whether the Lead was successfully converted or not.", + "type": "boolean" }, - "xdm:convertedDate" : { - "title" : "Converted Date", - "description" : "Date of conversion if the lead was successfully converted.", - "type" : "string", - "format" : "date-time" + "xdm:convertedDate": { + "title": "Converted Date", + "description": "Date of conversion if the lead was successfully converted.", + "type": "string", + "format": "date-time" }, - "xdm:convertedContactID" : { - "title" : "Converted Contact ID", - "description" : "Contact Id if the lead was successfully converted.", - "type" : "string" + "xdm:convertedContactID": { + "title": "Converted Contact ID", + "description": "Contact Id if the lead was successfully converted.", + "type": "string" }, - "xdm:personOptInOut" : { - "title" : "Person Preferences", - "description" : "Holds opt out values for different channels as selected by the person.", - "$ref" : "https://ns.adobe.com/xdm/context/optinout" + "xdm:personOptInOut": { + "title": "Person Preferences", + "description": "Holds opt out values for different channels as selected by the person.", + "$ref": "https://ns.adobe.com/xdm/context/optinout" } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/b2b-person-details" - }, { - "$ref" : "#/definitions/b2b-person-segment-traits" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/profile-personal-details" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/profile-person-details" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/profile-other-work-details" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/profile-work-details" - }, { - "$ref" : "https://ns.adobe.com/xdm/context/identitymap" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/external-source-system-audit-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-09-09" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/b2b-person-details" + }, + { + "$ref": "#/definitions/b2b-person-segment-traits" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-person-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-other-work-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/profile-work-details" + }, + { + "$ref": "https://ns.adobe.com/xdm/context/identitymap" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-09-09" +} diff --git a/components/mixins/profile/profile-consents.schema.json b/components/mixins/profile/profile-consents.schema.json index fb4ac3da4..debd35540 100644 --- a/components/mixins/profile/profile-consents.schema.json +++ b/components/mixins/profile/profile-consents.schema.json @@ -1,17 +1,24 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/profile-consents", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Privacy/Personalization/Marketing Preferences (Consents)", - "description" : "This schema captures privacy, personalization and marketing preferences (consents).", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "definitions" : { }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/profile-consents" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-11-04" -} \ No newline at end of file + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile-consents", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Privacy/Personalization/Marketing Preferences (Consents)", + "description": "This schema captures privacy, personalization and marketing preferences (consents).", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "definitions": {}, + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/datatypes/consents-and-preferences#/definitions/profile-consents" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-11-04" +} diff --git a/components/mixins/profile/profile-directmarketing.schema.json b/components/mixins/profile/profile-directmarketing.schema.json index 500e1aa26..0e7efcf00 100644 --- a/components/mixins/profile/profile-directmarketing.schema.json +++ b/components/mixins/profile/profile-directmarketing.schema.json @@ -1,39 +1,47 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-directmarketing", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Profile direct marketing", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Use for direct marketing activities such as addresses, emails, and phone numbers.", - "definitions" : { - "profile-directmarketing" : { - "properties" : { - "xdm:directMarketingAddress" : { - "title" : "Direct marketing address", - "$ref" : "https://ns.adobe.com/xdm/context/directmarketing-address", - "description" : "Direct marketing postal address." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-directmarketing", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile direct marketing", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Use for direct marketing activities such as addresses, emails, and phone numbers.", + "definitions": { + "profile-directmarketing": { + "properties": { + "xdm:directMarketingAddress": { + "title": "Direct marketing address", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-address", + "description": "Direct marketing postal address." }, - "xdm:directMarketingEmail" : { - "title" : "Direct marketing email", - "$ref" : "https://ns.adobe.com/xdm/context/directmarketing-emailaddress", - "description" : "Direct marketing email address." + "xdm:directMarketingEmail": { + "title": "Direct marketing email", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-emailaddress", + "description": "Direct marketing email address." }, - "xdm:directMarketingPhone" : { - "title" : "Direct marketing phone", - "$ref" : "https://ns.adobe.com/xdm/context/directmarketing-phonenumber", - "description" : "Direct marketing phone number." + "xdm:directMarketingPhone": { + "title": "Direct marketing phone", + "$ref": "https://ns.adobe.com/xdm/context/directmarketing-phonenumber", + "description": "Direct marketing phone number." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-directmarketing" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-directmarketing" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-inferred-person.schema.json b/components/mixins/profile/profile-inferred-person.schema.json index e3ce88424..116e2da66 100644 --- a/components/mixins/profile/profile-inferred-person.schema.json +++ b/components/mixins/profile/profile-inferred-person.schema.json @@ -1,52 +1,59 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/profile-inferred-person", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "XDM Inferred Person", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "This mixin is used to capture inferred details about a person where they are not directly avaialble.", - "definitions" : { - "profile-inferred-person" : { - "properties" : { - "xdm:anonymousHostname" : { - "title" : "Anonymous Hostname", - "description" : "Anonymous hostname.", - "type" : "string" + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile-inferred-person", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "XDM Inferred Person", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "This mixin is used to capture inferred details about a person where they are not directly avaialble.", + "definitions": { + "profile-inferred-person": { + "properties": { + "xdm:anonymousHostname": { + "title": "Anonymous Hostname", + "description": "Anonymous hostname.", + "type": "string" }, - "xdm:inferredAddress" : { - "title" : "Inferred Address", - "description" : "Address details inferred by reverse IP lookup of the lead’s first recorded web visit.", - "$ref" : "https://ns.adobe.com/xdm/common/address" + "xdm:inferredAddress": { + "title": "Inferred Address", + "description": "Address details inferred by reverse IP lookup of the lead’s first recorded web visit.", + "$ref": "https://ns.adobe.com/xdm/common/address" }, - "xdm:inferredCompany" : { - "title" : "Inferred Company", - "description" : "Company name inferred by reverse IP lookup of the lead’s first recorded web visit.", - "type" : "string" + "xdm:inferredCompany": { + "title": "Inferred Company", + "description": "Company name inferred by reverse IP lookup of the lead’s first recorded web visit.", + "type": "string" }, - "xdm:inferredCompanyStatus" : { - "title" : "Inferred Company Status", - "description" : "Status of the company name inferred by reverse IP lookup of the lead’s first recorded web visit.", - "type" : "string" + "xdm:inferredCompanyStatus": { + "title": "Inferred Company Status", + "description": "Status of the company name inferred by reverse IP lookup of the lead’s first recorded web visit.", + "type": "string" }, - "xdm:inferredMetropolitanArea" : { - "title" : "Inferred Metropolitan Area", - "description" : "Metropolitan area inferred by reverse IP lookup of lead’s first recorded web visit.", - "type" : "string" + "xdm:inferredMetropolitanArea": { + "title": "Inferred Metropolitan Area", + "description": "Metropolitan area inferred by reverse IP lookup of lead’s first recorded web visit.", + "type": "string" }, - "xdm:inferredPhoneAreaCode" : { - "title" : "Inferred Phone Area Code", - "description" : "Phone area code inferred by reverse IP lookup of lead’s first recorded web visit.", - "type" : "string" + "xdm:inferredPhoneAreaCode": { + "title": "Inferred Phone Area Code", + "description": "Phone area code inferred by reverse IP lookup of lead’s first recorded web visit.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/profile-inferred-person" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-11-23" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/profile-inferred-person" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-11-23" +} diff --git a/components/mixins/profile/profile-loyalty-details.schema.json b/components/mixins/profile/profile-loyalty-details.schema.json index 9347f009c..626a46d80 100644 --- a/components/mixins/profile/profile-loyalty-details.schema.json +++ b/components/mixins/profile/profile-loyalty-details.schema.json @@ -1,93 +1,107 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Loyalty Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "travel_and_hospitality", "automotive", "health_and_life_sciences", "high_tech", "manufacturing" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile/profile-loyalty-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Loyalty Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "travel_and_hospitality", + "automotive", + "health_and_life_sciences", + "high_tech", + "manufacturing" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Loyalty details such as ID, points, join date, program, and status. ", - "definitions" : { - "loyalty-details" : { - "properties" : { - "xdm:loyalty" : { - "type" : "object", - "properties" : { - "xdm:joinDate" : { - "title" : "Program Join Date", - "type" : "string", - "format" : "date-time", - "description" : "Date which the visitor registered for the loyalty program." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Loyalty details such as ID, points, join date, program, and status. ", + "definitions": { + "loyalty-details": { + "properties": { + "xdm:loyalty": { + "type": "object", + "properties": { + "xdm:joinDate": { + "title": "Program Join Date", + "type": "string", + "format": "date-time", + "description": "Date which the visitor registered for the loyalty program." }, - "xdm:loyaltyID" : { - "title" : "Program ID", - "type" : "array", - "items" : { - "type" : "string" + "xdm:loyaltyID": { + "title": "Program ID", + "type": "array", + "items": { + "type": "string" }, - "description" : "The loyalty program ID(s) associated with a specific user, if they are enrolled in the client's loyalty program." + "description": "The loyalty program ID(s) associated with a specific user, if they are enrolled in the client's loyalty program." }, - "xdm:points" : { - "title" : "Program Points Balance", - "type" : "number", - "description" : "Current balance of the loyalty points/awards in a visitor's loyalty account." + "xdm:points": { + "title": "Program Points Balance", + "type": "number", + "description": "Current balance of the loyalty points/awards in a visitor's loyalty account." }, - "xdm:pointsExpiration" : { - "title" : "Points Expiration", - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:pointsExpiring" : { - "title" : "Points Expiring", - "type" : "number", - "description" : "Point balance expiring as of the associated expiration date." + "xdm:pointsExpiration": { + "title": "Points Expiration", + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:pointsExpiring": { + "title": "Points Expiring", + "type": "number", + "description": "Point balance expiring as of the associated expiration date." }, - "xdm:pointsExpirationDate" : { - "type" : "string", - "format" : "date-time", - "description" : "Date on which the given portion of the loyalty points expire." + "xdm:pointsExpirationDate": { + "type": "string", + "format": "date-time", + "description": "Date on which the given portion of the loyalty points expire." } } } }, - "xdm:pointsRedeemed" : { - "title" : "Points Redeemed", - "type" : "number", - "description" : "Amount of points applied toward a purchase or otherwise redeemed." + "xdm:pointsRedeemed": { + "title": "Points Redeemed", + "type": "number", + "description": "Amount of points applied toward a purchase or otherwise redeemed." }, - "xdm:program" : { - "title" : "Program Name", - "type" : "string", - "description" : "This should define the loyalty progam in which a visitor is enrolled." + "xdm:program": { + "title": "Program Name", + "type": "string", + "description": "This should define the loyalty progam in which a visitor is enrolled." }, - "xdm:upgradeDate" : { - "title" : "Program Name", - "type" : "string", - "description" : "Date which the customer was upgraded to the next tier level." + "xdm:upgradeDate": { + "title": "Program Name", + "type": "string", + "description": "Date which the customer was upgraded to the next tier level." }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "description" : "Captures the visitor's loyalty progam status, such as active, disabled, or suspended." + "xdm:status": { + "title": "Status", + "type": "string", + "description": "Captures the visitor's loyalty progam status, such as active, disabled, or suspended." }, - "xdm:tier" : { - "title" : "Tier", - "type" : "string", - "description" : "Captures the loyalty progam tier in which a visitor is enrolled." + "xdm:tier": { + "title": "Tier", + "type": "string", + "description": "Captures the loyalty progam tier in which a visitor is enrolled." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/loyalty-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/loyalty-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/profile/profile-other-work-details.schema.json b/components/mixins/profile/profile-other-work-details.schema.json index 0b81ac1a1..74c640b5b 100644 --- a/components/mixins/profile/profile-other-work-details.schema.json +++ b/components/mixins/profile/profile-other-work-details.schema.json @@ -1,80 +1,88 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-other-work-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Profile Other Work Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "This mixin is used to capture information regarding additional/other work-related details of the individual such as work address, work email, work phone number, and organizations to which the profile belongs.", - "definitions" : { - "profile-other-work-details" : { - "properties" : { - "xdm:otherAddress" : { - "title" : "Other Address", - "$ref" : "https://ns.adobe.com/xdm/common/address", - "description" : "Other/Alternate postal address of the person." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-other-work-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile Other Work Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "This mixin is used to capture information regarding additional/other work-related details of the individual such as work address, work email, work phone number, and organizations to which the profile belongs.", + "definitions": { + "profile-other-work-details": { + "properties": { + "xdm:otherAddress": { + "title": "Other Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "Other/Alternate postal address of the person." }, - "xdm:otherPhone" : { - "title" : "Other Phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Other/Alternate phone number of the person." + "xdm:otherPhone": { + "title": "Other Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Other/Alternate phone number of the person." }, - "xdm:extendedWorkDetails" : { - "type" : "object", - "title" : "Some Additional Person Work Details", - "properties" : { - "xdm:assistantDetails" : { - "type" : "object", - "title" : "Assitant Details", - "properties" : { - "xdm:name" : { - "title" : "Assistant Name", - "$ref" : "https://ns.adobe.com/xdm/context/person-name", - "description" : "Person's assistant full name." + "xdm:extendedWorkDetails": { + "type": "object", + "title": "Some Additional Person Work Details", + "properties": { + "xdm:assistantDetails": { + "type": "object", + "title": "Assitant Details", + "properties": { + "xdm:name": { + "title": "Assistant Name", + "$ref": "https://ns.adobe.com/xdm/context/person-name", + "description": "Person's assistant full name." }, - "xdm:phone" : { - "title" : "Assistant Phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Person's assistant phone number." + "xdm:phone": { + "title": "Assistant Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Person's assistant phone number." } } }, - "xdm:reportsToID" : { - "title" : "Reports To Id", - "description" : "Identifier of the Reporting Manager.", - "type" : "string" + "xdm:reportsToID": { + "title": "Reports To Id", + "description": "Identifier of the Reporting Manager.", + "type": "string" }, - "xdm:departments" : { - "title" : "Department Name", - "description" : "Department name where the person works.", - "type" : "array", - "items" : { - "type" : "string" + "xdm:departments": { + "title": "Department Name", + "description": "Department name where the person works.", + "type": "array", + "items": { + "type": "string" } }, - "xdm:jobTitle" : { - "title" : "Job Title", - "description" : "Job title of the person.", - "type" : "string" + "xdm:jobTitle": { + "title": "Job Title", + "description": "Job title of the person.", + "type": "string" }, - "xdm:photoUrl" : { - "title" : "Photo Url", - "description" : "Photo url of the person.", - "type" : "string", - "format" : "uri" + "xdm:photoUrl": { + "title": "Photo Url", + "description": "Photo url of the person.", + "type": "string", + "format": "uri" } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-other-work-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-08-18" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-other-work-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-08-18" +} diff --git a/components/mixins/profile/profile-owning-entities.schema.json b/components/mixins/profile/profile-owning-entities.schema.json index 29887c65c..e85b2f324 100644 --- a/components/mixins/profile/profile-owning-entities.schema.json +++ b/components/mixins/profile/profile-owning-entities.schema.json @@ -1,34 +1,42 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-owning-entities", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Profile owning entity details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Geographical unit information such as labels, organization name, and geographical unit name.", - "definitions" : { - "profile-owning-entities" : { - "properties" : { - "xdm:orgUnit" : { - "title" : "Organizational unit", - "$ref" : "https://ns.adobe.com/xdm/common/orgunit", - "description" : "The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-owning-entities", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile owning entity details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Geographical unit information such as labels, organization name, and geographical unit name.", + "definitions": { + "profile-owning-entities": { + "properties": { + "xdm:orgUnit": { + "title": "Organizational unit", + "$ref": "https://ns.adobe.com/xdm/common/orgunit", + "description": "The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset." }, - "xdm:geoUnit" : { - "title" : "Geographical unit", - "$ref" : "https://ns.adobe.com/xdm/common/geounit", - "description" : "The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset." + "xdm:geoUnit": { + "title": "Geographical unit", + "$ref": "https://ns.adobe.com/xdm/common/geounit", + "description": "The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-owning-entities" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-owning-entities" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-person-details-v2.schema.json b/components/mixins/profile/profile-person-details-v2.schema.json index 4f81b80ee..68693d90e 100644 --- a/components/mixins/profile/profile-person-details-v2.schema.json +++ b/components/mixins/profile/profile-person-details-v2.schema.json @@ -1,35 +1,40 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/profile-person-details-v2", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Demographic Details v2", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Demographic information such as name, gender, and birth date of an individual.", - "definitions" : { - "person" : { - "properties" : { - "xdm:person" : { - "title" : "Person", - "$ref" : "https://ns.adobe.com/xdm/context/person", - "description" : "An individual actor, contact, or owner." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile-person-details-v2", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Demographic Details v2", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Demographic information such as name, gender, and birth date of an individual.", + "definitions": { + "person": { + "properties": { + "xdm:person": { + "title": "Person", + "$ref": "https://ns.adobe.com/xdm/context/person", + "description": "An individual actor, contact, or owner." } } }, - "person-name-firstName" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:name" : { - "type" : "object", - "properties" : { - "xdm:firstName" : { - "title" : "First name", - "type" : "string", - "description" : "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." + "person-name-firstName": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:name": { + "type": "object", + "properties": { + "xdm:firstName": { + "title": "First name", + "type": "string", + "description": "The first segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the preferred personal or given name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." } } } @@ -37,18 +42,18 @@ } } }, - "person-name-lastName" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:name" : { - "type" : "object", - "properties" : { - "xdm:lastName" : { - "title" : "Last name", - "type" : "string", - "description" : "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." + "person-name-lastName": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:name": { + "type": "object", + "properties": { + "xdm:lastName": { + "title": "Last name", + "type": "string", + "description": "The last segment of the name in the writing order most commonly accepted in the language of the name. In many cultures this is the inherited family name, surname, patronymic, or matronymic name. The `firstName` and `lastName` properties have been introduced to maintain compatibility with existing systems that model names in a simplified, non-semantic, and non-internationalizable way. Using `xdm:fullName` is always preferable." } } } @@ -56,18 +61,18 @@ } } }, - "person-name-middleName" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:name" : { - "type" : "object", - "properties" : { - "xdm:middleName" : { - "title" : "Middle name", - "type" : "string", - "description" : "Middle, alternative, or additional names supplied between the first name and last name." + "person-name-middleName": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:name": { + "type": "object", + "properties": { + "xdm:middleName": { + "title": "Middle name", + "type": "string", + "description": "Middle, alternative, or additional names supplied between the first name and last name." } } } @@ -75,18 +80,18 @@ } } }, - "person-name-courtesyTitle" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:name" : { - "type" : "object", - "properties" : { - "xdm:courtesyTitle" : { - "title" : "Courtesy title", - "type" : "string", - "description" : "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr." + "person-name-courtesyTitle": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:name": { + "type": "object", + "properties": { + "xdm:courtesyTitle": { + "title": "Courtesy title", + "type": "string", + "description": "Normally an abbreviation of a persons title, honorific, or salutation. The `courtesyTitle` is used in front of full or last name in opening texts. For example, Mr. Miss. or Dr." } } } @@ -94,18 +99,18 @@ } } }, - "person-name-suffix" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:name" : { - "type" : "object", - "properties" : { - "xdm:suffix" : { - "title" : "Suffix", - "type" : "string", - "description" : "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc." + "person-name-suffix": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:name": { + "type": "object", + "properties": { + "xdm:suffix": { + "title": "Suffix", + "type": "string", + "description": "A group of letters provided after a person's name to provide additional information. The `suffix` is used at the end of someones name. For example Jr., Sr., M.D., PhD, I, II, III, etc." } } } @@ -113,18 +118,18 @@ } } }, - "person-name-fullName" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:name" : { - "type" : "object", - "properties" : { - "xdm:fullName" : { - "title" : "Full name", - "type" : "string", - "description" : "The full name of the person, in writing order most commonly accepted in the language of the name." + "person-name-fullName": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:name": { + "type": "object", + "properties": { + "xdm:fullName": { + "title": "Full name", + "type": "string", + "description": "The full name of the person, in writing order most commonly accepted in the language of the name." } } } @@ -132,132 +137,141 @@ } } }, - "person-birthDate" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:birthDate" : { - "title" : "Birth date", - "type" : "string", - "format" : "date", - "description" : "The full date a person was born." + "person-birthDate": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:birthDate": { + "title": "Birth date", + "type": "string", + "format": "date", + "description": "The full date a person was born." } } } } }, - "person-birthDayAndMonth" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:birthDayAndMonth" : { - "title" : "Birth date", - "type" : "string", - "pattern" : "[0-1][0-9]-[0-9][0-9]", - "description" : "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year." + "person-birthDayAndMonth": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:birthDayAndMonth": { + "title": "Birth date", + "type": "string", + "pattern": "[0-1][0-9]-[0-9][0-9]", + "description": "The day and month a person was born, in the format MM-DD. This field should be used when the day and month of a person's birth is known, but not the year." } } } } }, - "person-birthYear" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:birthYear" : { - "title" : "Birth year", - "type" : "integer", - "description" : "The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date.", - "minimum" : 1, - "maximum" : 32767 + "person-birthYear": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:birthYear": { + "title": "Birth year", + "type": "integer", + "description": "The year a person was born including the century, for example, 1983. This field should be used when only the person's age is known, not the full birth date.", + "minimum": 1, + "maximum": 32767 } } } } }, - "person-gender" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:gender" : { - "title" : "Gender", - "type" : "string", - "enum" : [ "male", "female", "not_specified", "non_specific" ], - "meta:enum" : { - "male" : "Male", - "female" : "Female", - "not_specified" : "Not Specified", - "non_specific" : "Non-specific" + "person-gender": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:gender": { + "title": "Gender", + "type": "string", + "enum": ["male", "female", "not_specified", "non_specific"], + "meta:enum": { + "male": "Male", + "female": "Female", + "not_specified": "Not Specified", + "non_specific": "Non-specific" }, - "description" : "Gender identity of the person.\n", - "default" : "not_specified" + "description": "Gender identity of the person.\n", + "default": "not_specified" } } } } }, - "person-maritalStatus" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:maritalStatus" : { - "title" : "Marital Status", - "type" : "string", - "enum" : [ "married", "single", "divorced", "widowed", "not_specified" ], - "meta:enum" : { - "married" : "Married", - "single" : "Single", - "divorced" : "Divorced", - "widowed" : "Widowed", - "not_specified" : "Not Specified" + "person-maritalStatus": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:maritalStatus": { + "title": "Marital Status", + "type": "string", + "enum": [ + "married", + "single", + "divorced", + "widowed", + "not_specified" + ], + "meta:enum": { + "married": "Married", + "single": "Single", + "divorced": "Divorced", + "widowed": "Widowed", + "not_specified": "Not Specified" }, - "description" : "Describes a person's relationship with a significant other.", - "default" : "not_specified" + "description": "Describes a person's relationship with a significant other.", + "default": "not_specified" } } } } }, - "person-nationality" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:nationality" : { - "title" : "Nationality", - "type" : "string", - "pattern" : "^[A-Z]{2}$", - "description" : "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code." + "person-nationality": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:nationality": { + "title": "Nationality", + "type": "string", + "pattern": "^[A-Z]{2}$", + "description": "The legal relationship between a person and their state represented using the ISO 3166-1 Alpha-2 code." } } } } }, - "person-taxId" : { - "properties" : { - "xdm:person" : { - "type" : "object", - "properties" : { - "xdm:taxId" : { - "title" : "Tax ID", - "type" : "string", - "description" : "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain." + "person-taxId": { + "properties": { + "xdm:person": { + "type": "object", + "properties": { + "xdm:taxId": { + "title": "Tax ID", + "type": "string", + "description": "The Tax / Fiscal ID of the person, e.g. the TIN in the US or the CIF/NIF in Spain." } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/person" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-11-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/person" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-11-10" +} diff --git a/components/mixins/profile/profile-person-details.schema.json b/components/mixins/profile/profile-person-details.schema.json index 3ce796298..4f5b40622 100644 --- a/components/mixins/profile/profile-person-details.schema.json +++ b/components/mixins/profile/profile-person-details.schema.json @@ -1,29 +1,37 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-person-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Demographic Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Demographic information such as name, gender, and birth date of an individual.", - "definitions" : { - "profile-person-details" : { - "properties" : { - "xdm:person" : { - "title" : "Person", - "$ref" : "https://ns.adobe.com/xdm/context/person", - "description" : "An individual actor, contact, or owner." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-person-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Demographic Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Demographic information such as name, gender, and birth date of an individual.", + "definitions": { + "profile-person-details": { + "properties": { + "xdm:person": { + "title": "Person", + "$ref": "https://ns.adobe.com/xdm/context/person", + "description": "An individual actor, contact, or owner." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-person-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-person-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-personal-details.schema.json b/components/mixins/profile/profile-personal-details.schema.json index aed514844..84458a59b 100644 --- a/components/mixins/profile/profile-personal-details.schema.json +++ b/components/mixins/profile/profile-personal-details.schema.json @@ -1,52 +1,60 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-personal-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Personal Contact Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-personal-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Personal Contact Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Contact information for an individual person such as home address, phone number, fax, and email.", - "definitions" : { - "profile-personal-details" : { - "properties" : { - "xdm:homeAddress" : { - "title" : "Home address", - "$ref" : "https://ns.adobe.com/xdm/common/address", - "description" : "A home postal address." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Contact information for an individual person such as home address, phone number, fax, and email.", + "definitions": { + "profile-personal-details": { + "properties": { + "xdm:homeAddress": { + "title": "Home address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A home postal address." }, - "xdm:personalEmail" : { - "title" : "Personal email", - "$ref" : "https://ns.adobe.com/xdm/context/emailaddress", - "description" : "A personal email address." + "xdm:personalEmail": { + "title": "Personal email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A personal email address." }, - "xdm:homePhone" : { - "title" : "Home phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Home phone number." + "xdm:homePhone": { + "title": "Home phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Home phone number." }, - "xdm:mobilePhone" : { - "title" : "Mobile phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Mobile phone number." + "xdm:mobilePhone": { + "title": "Mobile phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Mobile phone number." }, - "xdm:faxPhone" : { - "title" : "Fax phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Fax phone number." + "xdm:faxPhone": { + "title": "Fax phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Fax phone number." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-personal-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-personal-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-personal-finance-details.schema.json b/components/mixins/profile/profile-personal-finance-details.schema.json index 21d3f03cd..2e931d2ca 100644 --- a/components/mixins/profile/profile-personal-finance-details.schema.json +++ b/components/mixins/profile/profile-personal-finance-details.schema.json @@ -1,97 +1,111 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/profile-personal-finance-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Personal Finance Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "financial_services" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile-personal-finance-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Personal Finance Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["financial_services"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Personal finance details such as financial account details, credit score, and tax bracket.", - "definitions" : { - "personal-finance-details" : { - "properties" : { - "xdm:personalFinances" : { - "type" : "object", - "properties" : { - "xdm:accountCardsTotal" : { - "title" : "Account Cards Total", - "type" : "integer", - "description" : "Total number of account (financial) cards assigned to a user." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Personal finance details such as financial account details, credit score, and tax bracket.", + "definitions": { + "personal-finance-details": { + "properties": { + "xdm:personalFinances": { + "type": "object", + "properties": { + "xdm:accountCardsTotal": { + "title": "Account Cards Total", + "type": "integer", + "description": "Total number of account (financial) cards assigned to a user." }, - "xdm:assignedBeneficiary" : { - "title" : "Assigned Beneficiaries", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/profile-person-details" + "xdm:assignedBeneficiary": { + "title": "Assigned Beneficiaries", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/profile-person-details" }, - "description" : "Captures the beneficiary(s) assigned to the account." + "description": "Captures the beneficiary(s) assigned to the account." }, - "xdm:creditScore" : { - "title" : "Credit Score", - "type" : "integer", - "description" : "Refers to a number between 300-850 that depicts a consumer's creditworthiness. " + "xdm:creditScore": { + "title": "Credit Score", + "type": "integer", + "description": "Refers to a number between 300-850 that depicts a consumer's creditworthiness. " }, - "xdm:employmentStatus" : { - "title" : "Employment Status", - "type" : "string", - "enum" : [ "full time", "part time", "temporary", "self employed", "retired", "unemployed" ], - "description" : "Tracks the employment status of the user." + "xdm:employmentStatus": { + "title": "Employment Status", + "type": "string", + "enum": [ + "full time", + "part time", + "temporary", + "self employed", + "retired", + "unemployed" + ], + "description": "Tracks the employment status of the user." }, - "xdm:filingJointly" : { - "title" : "Filing Jointly", - "type" : "boolean", - "description" : "Refers to a filing status for married couples that have wed before the end of the tax year." + "xdm:filingJointly": { + "title": "Filing Jointly", + "type": "boolean", + "description": "Refers to a filing status for married couples that have wed before the end of the tax year." }, - "xdm:filingSeparately" : { - "title" : "Filing Separately", - "type" : "boolean", - "description" : "Refers to married couples who choose to record their respective incomes, exemptions, and deductions on separate tax returns." + "xdm:filingSeparately": { + "title": "Filing Separately", + "type": "boolean", + "description": "Refers to married couples who choose to record their respective incomes, exemptions, and deductions on separate tax returns." }, - "xdm:financialAccount" : { - "title" : "financeAccountId", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/datatypes/financial-account" + "xdm:financialAccount": { + "title": "financeAccountId", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/datatypes/financial-account" }, - "description" : "Financial account IDs assigned to the user, and array of Financial Account Details data type." + "description": "Financial account IDs assigned to the user, and array of Financial Account Details data type." }, - "xdm:hasAssignedBeneficiary" : { - "title" : "Has Assigned Beneficiary", - "type" : "boolean", - "description" : "Flag determining if the account has a beneficiary assigned." + "xdm:hasAssignedBeneficiary": { + "title": "Has Assigned Beneficiary", + "type": "boolean", + "description": "Flag determining if the account has a beneficiary assigned." }, - "xdm:isHeadOfHousehold" : { - "title" : "Head of Household", - "type" : "boolean", - "description" : "Users designed as head of household if they pay more than half the cost of supporting and housing a qualifying person." + "xdm:isHeadOfHousehold": { + "title": "Head of Household", + "type": "boolean", + "description": "Users designed as head of household if they pay more than half the cost of supporting and housing a qualifying person." }, - "xdm:householdIncome" : { - "title" : "Household Income", - "$ref" : "https://ns.adobe.com/xdm/datatypes/currency", - "description" : "Refers to the combined gross income of all members of a household." + "xdm:householdIncome": { + "title": "Household Income", + "$ref": "https://ns.adobe.com/xdm/datatypes/currency", + "description": "Refers to the combined gross income of all members of a household." }, - "xdm:singleFiler" : { - "title" : "Single Filer", - "type" : "boolean", - "description" : "Refers to a taxpayer who is unmarried and does not qualify for any other filing status." + "xdm:singleFiler": { + "title": "Single Filer", + "type": "boolean", + "description": "Refers to a taxpayer who is unmarried and does not qualify for any other filing status." }, - "xdm:taxBracket" : { - "title" : "Tax Bracket", - "type" : "string", - "description" : "Refers to a range of incomes subject to a certain income tax rate." + "xdm:taxBracket": { + "title": "Tax Bracket", + "type": "string", + "description": "Refers to a range of incomes subject to a certain income tax rate." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/personal-finance-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-03-23" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/personal-finance-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-03-23" +} diff --git a/components/mixins/profile/profile-phones.schema.json b/components/mixins/profile/profile-phones.schema.json index 156a3a27d..5433bc0cc 100644 --- a/components/mixins/profile/profile-phones.schema.json +++ b/components/mixins/profile/profile-phones.schema.json @@ -1,44 +1,52 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-phones", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Phone Number Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Phone number such as fax, mobile, home, and work.", - "definitions" : { - "profile-phones" : { - "properties" : { - "xdm:homePhone" : { - "title" : "Home Phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Home phone number." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-phones", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Phone Number Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Phone number such as fax, mobile, home, and work.", + "definitions": { + "profile-phones": { + "properties": { + "xdm:homePhone": { + "title": "Home Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Home phone number." }, - "xdm:mobilePhone" : { - "title" : "Mobile Phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Mobile phone number." + "xdm:mobilePhone": { + "title": "Mobile Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Mobile phone number." }, - "xdm:workPhone" : { - "title" : "Work Phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Work phone number." + "xdm:workPhone": { + "title": "Work Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Work phone number." }, - "xdm:faxPhone" : { - "title" : "Fax Phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Fax phone number." + "xdm:faxPhone": { + "title": "Fax Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Fax phone number." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-phones" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-phones" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-preferences-details.schema.json b/components/mixins/profile/profile-preferences-details.schema.json index 03e96785f..9df0488a6 100644 --- a/components/mixins/profile/profile-preferences-details.schema.json +++ b/components/mixins/profile/profile-preferences-details.schema.json @@ -1,56 +1,64 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-preferences-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Preference Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Preferences such as opt-in and opt-out, time zone, preferred language, and email format.", - "definitions" : { - "profile-preferences-details" : { - "properties" : { - "xdm:preferredLanguage" : { - "title" : "Preferred language", - "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)))$", - "examples" : [ "en-GB", "de-DE", "yue-HK" ], - "description" : "Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-preferences-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Preference Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Preferences such as opt-in and opt-out, time zone, preferred language, and email format.", + "definitions": { + "profile-preferences-details": { + "properties": { + "xdm:preferredLanguage": { + "title": "Preferred language", + "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)))$", + "examples": ["en-GB", "de-DE", "yue-HK"], + "description": "Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format." }, - "xdm:profilePictureLink" : { - "title" : "Profile picture link", - "type" : "string", - "description" : "Link to profile's picture." + "xdm:profilePictureLink": { + "title": "Profile picture link", + "type": "string", + "description": "Link to profile's picture." }, - "xdm:emailFormat" : { - "title" : "Email format", - "type" : "string", - "description" : "Email format preferred by the profile. This can be rich text or plain text.", - "meta:enum" : { - "html" : "Rich text", - "plaintext" : "Plain text" + "xdm:emailFormat": { + "title": "Email format", + "type": "string", + "description": "Email format preferred by the profile. This can be rich text or plain text.", + "meta:enum": { + "html": "Rich text", + "plaintext": "Plain text" } }, - "xdm:timeZone" : { - "title" : "Time zone", - "type" : "string", - "examples" : [ "America/Barbados", "Antarctica/Davis", "Asia/Calcutta" ], - "description" : "Describes which time zone the profile is present in, most frequently the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm" + "xdm:timeZone": { + "title": "Time zone", + "type": "string", + "examples": ["America/Barbados", "Antarctica/Davis", "Asia/Calcutta"], + "description": "Describes which time zone the profile is present in, most frequently the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm" }, - "xdm:optInOut" : { - "title" : "OptInOut", - "$ref" : "https://ns.adobe.com/xdm/context/optinout", - "description" : "Describes a users opting in and out preferences for communication by medium and communication type." + "xdm:optInOut": { + "title": "OptInOut", + "$ref": "https://ns.adobe.com/xdm/context/optinout", + "description": "Describes a users opting in and out preferences for communication by medium and communication type." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-preferences-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-preferences-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-privacy.schema.json b/components/mixins/profile/profile-privacy.schema.json index 6c4dc4144..df91c2b82 100644 --- a/components/mixins/profile/profile-privacy.schema.json +++ b/components/mixins/profile/profile-privacy.schema.json @@ -1,96 +1,101 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-privacy", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Privacy Details", - "description" : "Privacy data such as opt-out type, value, and timing.", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-privacy", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Privacy Details", + "description": "Privacy data such as opt-out type, value, and timing.", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "definitions" : { - "profile-privacy" : { - "properties" : { - "xdm:optOutConsentLevel" : { - "type" : "object", - "title" : "Opt-out consent level (deprecated)", - "description" : "Opt-out consent level (deprecated).", - "meta:status" : "deprecated", - "properties" : { - "xdm:privacyOptOuts" : { - "title" : "Privacy opt-outs (deprecated)", - "description" : "Encapsulates different opt-out types for data privacy (deprecated).", - "type" : "array", - "items" : { - "type" : "object", - "properties" : { - "xdm:optOutType" : { - "title" : "Opt-out type", - "type" : "string", - "description" : "The type of opt-out.", - "enum" : [ "general_opt_out", "sales_sharing_opt_out" ], - "meta:enum" : { - "general_opt_out" : "General opt-out", - "sales_sharing_opt_out" : "Sales sharing opt-out" + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "definitions": { + "profile-privacy": { + "properties": { + "xdm:optOutConsentLevel": { + "type": "object", + "title": "Opt-out consent level (deprecated)", + "description": "Opt-out consent level (deprecated).", + "meta:status": "deprecated", + "properties": { + "xdm:privacyOptOuts": { + "title": "Privacy opt-outs (deprecated)", + "description": "Encapsulates different opt-out types for data privacy (deprecated).", + "type": "array", + "items": { + "type": "object", + "properties": { + "xdm:optOutType": { + "title": "Opt-out type", + "type": "string", + "description": "The type of opt-out.", + "enum": ["general_opt_out", "sales_sharing_opt_out"], + "meta:enum": { + "general_opt_out": "General opt-out", + "sales_sharing_opt_out": "Sales sharing opt-out" } }, - "xdm:optOutValue" : { - "title" : "Opt-out value", - "type" : "string", - "description" : "The value of opt-out signal.", - "enum" : [ "not_provided", "pending", "in", "out" ], - "meta:enum" : { - "not_provided" : "Not provided", - "pending" : "Pending verification", - "in" : "Opt-in", - "out" : "Opt-out" + "xdm:optOutValue": { + "title": "Opt-out value", + "type": "string", + "description": "The value of opt-out signal.", + "enum": ["not_provided", "pending", "in", "out"], + "meta:enum": { + "not_provided": "Not provided", + "pending": "Pending verification", + "in": "Opt-in", + "out": "Opt-out" } }, - "xdm:timestamp" : { - "title" : "Opt-out timestamp", - "description" : "Timestamp of the received opt-out signal.", - "type" : "string", - "format" : "date-time" + "xdm:timestamp": { + "title": "Opt-out timestamp", + "description": "Timestamp of the received opt-out signal.", + "type": "string", + "format": "date-time" } } } } } }, - "xdm:identityPrivacyInfo" : { - "title" : "Identity level privacy information", - "description" : "Captured privacy information for identities in profile.", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "title" : "User namespace", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "type" : "object", - "title" : "User Identity", - "properties" : { - "xdm:identityIABConsent" : { - "type" : "object", - "title" : "Identity level consent information", - "description" : "Consent collected for an identity via consent management services.", - "properties" : { - "xdm:consentTimestamp" : { - "title" : "Timestamp of consent", - "description" : "Timestamp (RFC3339) when this identity presented consent information", - "type" : "string", - "format" : "date-time" + "xdm:identityPrivacyInfo": { + "title": "Identity level privacy information", + "description": "Captured privacy information for identities in profile.", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "User namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "object", + "title": "User Identity", + "properties": { + "xdm:identityIABConsent": { + "type": "object", + "title": "Identity level consent information", + "description": "Consent collected for an identity via consent management services.", + "properties": { + "xdm:consentTimestamp": { + "title": "Timestamp of consent", + "description": "Timestamp (RFC3339) when this identity presented consent information", + "type": "string", + "format": "date-time" }, - "xdm:consentString" : { - "title" : "Captured consent information", - "description" : "Consent string and its specification. This can help reading application to use appropriate library.", - "$ref" : "https://ns.adobe.com/xdm/context/consentstring" + "xdm:consentString": { + "title": "Captured consent information", + "description": "Consent string and its specification. This can help reading application to use appropriate library.", + "$ref": "https://ns.adobe.com/xdm/context/consentstring" } }, - "required" : [ "xdm:consentTimestamp" ] + "required": ["xdm:consentTimestamp"] } } } @@ -99,11 +104,14 @@ } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-privacy" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-privacy" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-push-details.schema.json b/components/mixins/profile/profile-push-details.schema.json index 8110f3472..61024be49 100644 --- a/components/mixins/profile/profile-push-details.schema.json +++ b/components/mixins/profile/profile-push-details.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-push-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Push Notification Token Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Information regarding push notifications, such as mobile application and device details.", - "definitions" : { - "profile-push-details" : { - "properties" : { - "xdm:pushNotificationTokens" : { - "title" : "Push notification tokens", - "type" : "array", - "description" : "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/pushnotificationtoken" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-push-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push Notification Token Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Information regarding push notifications, such as mobile application and device details.", + "definitions": { + "profile-push-details": { + "properties": { + "xdm:pushNotificationTokens": { + "title": "Push notification tokens", + "type": "array", + "description": "Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/pushnotificationtoken" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-push-details" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-push-details" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-push-notification-details.schema.json b/components/mixins/profile/profile-push-notification-details.schema.json index b8b830223..083612905 100644 --- a/components/mixins/profile/profile-push-notification-details.schema.json +++ b/components/mixins/profile/profile-push-notification-details.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-push-notification-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Push Notification Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Information regarding push notifications, such as mobile application and device details.", - "definitions" : { - "profile-push-notification-details" : { - "properties" : { - "xdm:pushNotificationDetails" : { - "title" : "Push details", - "type" : "array", - "description" : "Push details array containing notification info required to send mobile push notification to a specific mobile application on a given device.", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/pushdetail" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-push-notification-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Push Notification Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Information regarding push notifications, such as mobile application and device details.", + "definitions": { + "profile-push-notification-details": { + "properties": { + "xdm:pushNotificationDetails": { + "title": "Push details", + "type": "array", + "description": "Push details array containing notification info required to send mobile push notification to a specific mobile application on a given device.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/pushdetail" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-push-notification-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-push-notification-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-segmentation.schema.json b/components/mixins/profile/profile-segmentation.schema.json index 98da99fef..326a00407 100644 --- a/components/mixins/profile/profile-segmentation.schema.json +++ b/components/mixins/profile/profile-segmentation.schema.json @@ -1,45 +1,53 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-segmentation", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Segment Membership Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Segment membership information such as including which segments the individual belongs to, the last qualification time, and when the membership is valid until.", - "definitions" : { - "profile-segmentation" : { - "properties" : { - "xdm:segments" : { - "title" : "Segment membership", - "meta:status" : "deprecated", - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/segmentmembership" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-segmentation", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment Membership Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Segment membership information such as including which segments the individual belongs to, the last qualification time, and when the membership is valid until.", + "definitions": { + "profile-segmentation": { + "properties": { + "xdm:segments": { + "title": "Segment membership", + "meta:status": "deprecated", + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" } }, - "xdm:segmentMembership" : { - "title" : "Segment membership map", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "title" : "Segment membership per namespace", - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "$ref" : "https://ns.adobe.com/xdm/context/segmentmembership" + "xdm:segmentMembership": { + "title": "Segment membership map", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "title": "Segment membership per namespace", + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "$ref": "https://ns.adobe.com/xdm/context/segmentmembership" } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-segmentation" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-segmentation" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-subscriptions.schema.json b/components/mixins/profile/profile-subscriptions.schema.json index 82a0ac923..6e8ada781 100644 --- a/components/mixins/profile/profile-subscriptions.schema.json +++ b/components/mixins/profile/profile-subscriptions.schema.json @@ -1,32 +1,40 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-subscriptions", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Subscription Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Subscription information such as device, environment, and subscriber data.", - "definitions" : { - "profile-subscriptions" : { - "properties" : { - "xdm:subscriptions" : { - "title" : "Subscriptions", - "type" : "array", - "description" : "Subscriptions that the profile is entitled to including terminated, expired, or exhausted subscriptions.", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/subscription" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-subscriptions", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Subscription Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Subscription information such as device, environment, and subscriber data.", + "definitions": { + "profile-subscriptions": { + "properties": { + "xdm:subscriptions": { + "title": "Subscriptions", + "type": "array", + "description": "Subscriptions that the profile is entitled to including terminated, expired, or exhausted subscriptions.", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/subscription" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-subscriptions" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-subscriptions" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-test-profile.schema.json b/components/mixins/profile/profile-test-profile.schema.json index 061788872..ff04df119 100644 --- a/components/mixins/profile/profile-test-profile.schema.json +++ b/components/mixins/profile/profile-test-profile.schema.json @@ -1,30 +1,38 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-test-profile", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Profile test details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Use to indicate that the profile record is in use for testing, verification, and should not be automatically included in normal operations.", - "definitions" : { - "profile-test-profile" : { - "properties" : { - "xdm:testProfile" : { - "title" : "Test profile", - "type" : "boolean", - "description" : "Indicates the `profile` record is for use in testing and verification purposes and should not be automatically included in normal operations.", - "default" : false + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-test-profile", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Profile test details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Use to indicate that the profile record is in use for testing, verification, and should not be automatically included in normal operations.", + "definitions": { + "profile-test-profile": { + "properties": { + "xdm:testProfile": { + "title": "Test profile", + "type": "boolean", + "description": "Indicates the `profile` record is for use in testing and verification purposes and should not be automatically included in normal operations.", + "default": false } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-test-profile" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-test-profile" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/profile/profile-user-account-details.schema.json b/components/mixins/profile/profile-user-account-details.schema.json index c68dfb61c..b196f1fe3 100644 --- a/components/mixins/profile/profile-user-account-details.schema.json +++ b/components/mixins/profile/profile-user-account-details.schema.json @@ -1,75 +1,94 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/profile/profile-user-account-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "User Account Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "retail", "financial_services", "travel_and_hospitality", "telecom", "automotive", "education", "health_and_life_sciences", "high_tech", "manufacturing", "media_and_entertainment", "public_sector" ] + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/profile/profile-user-account-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "User Account Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": [ + "retail", + "financial_services", + "travel_and_hospitality", + "telecom", + "automotive", + "education", + "health_and_life_sciences", + "high_tech", + "manufacturing", + "media_and_entertainment", + "public_sector" + ] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "", - "definitions" : { - "user-account-details" : { - "properties" : { - "xdm:userAccount" : { - "type" : "object", - "properties" : { - "xdm:ID" : { - "title" : "ID", - "type" : "string", - "description" : "Captures the user account ID." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "", + "definitions": { + "user-account-details": { + "properties": { + "xdm:userAccount": { + "type": "object", + "properties": { + "xdm:ID": { + "title": "ID", + "type": "string", + "description": "Captures the user account ID." }, - "xdm:contactDetails" : { - "title" : "Contact Details", - "$ref" : "https://ns.adobe.com/xdm/context/profile-personal-details", - "description" : "Extension of the Personal Profile data type." + "xdm:contactDetails": { + "title": "Contact Details", + "$ref": "https://ns.adobe.com/xdm/context/profile-personal-details", + "description": "Extension of the Personal Profile data type." }, - "xdm:startDate" : { - "title" : "Start Date", - "type" : "string", - "format" : "date-time", - "description" : "Date when the account was opened." + "xdm:startDate": { + "title": "Start Date", + "type": "string", + "format": "date-time", + "description": "Date when the account was opened." }, - "xdm:status" : { - "title" : "Status", - "type" : "string", - "enum" : [ "active", "inactive", "disabled", "other" ], - "description" : "This should describe the current status of the account" + "xdm:status": { + "title": "Status", + "type": "string", + "enum": ["active", "inactive", "disabled", "other"], + "description": "This should describe the current status of the account" }, - "xdm:accountType" : { - "title" : "Account Type", - "type" : "string", - "description" : "Captures the user account type, if applicable." + "xdm:accountType": { + "title": "Account Type", + "type": "string", + "description": "Captures the user account type, if applicable." }, - "xdm:preferences" : { - "title" : "Preferences", - "type" : "array", - "items" : { - "type" : "string" + "xdm:preferences": { + "title": "Preferences", + "type": "array", + "items": { + "type": "string" }, - "description" : "M/F, other shopping preferences. Preferences in personal profile is already captured- things like perferred method of contact, not shopping prefs. " + "description": "M/F, other shopping preferences. Preferences in personal profile is already captured- things like perferred method of contact, not shopping prefs. " }, - "xdm:alertStatus" : { - "title" : "Alert Status", - "type" : "boolean", - "description" : "Captures whether or not alerts have been enabled for the account." + "xdm:alertStatus": { + "title": "Alert Status", + "type": "boolean", + "description": "Captures whether or not alerts have been enabled for the account." }, - "xdm:autopayStatus" : { - "title" : "Autopay Status", - "type" : "boolean", - "description" : "Captures whether or not the account has been enrolled in autopay." + "xdm:autopayStatus": { + "title": "Autopay Status", + "type": "boolean", + "description": "Captures whether or not the account has been enrolled in autopay." } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/user-account-details" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/user-account-details" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/components/mixins/profile/profile-work-details.schema.json b/components/mixins/profile/profile-work-details.schema.json index eb524384e..41f764b2f 100644 --- a/components/mixins/profile/profile-work-details.schema.json +++ b/components/mixins/profile/profile-work-details.schema.json @@ -1,49 +1,57 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/profile-work-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Work Contact Details", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/profile-work-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Work Contact Details", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/profile" ], - "description" : "Work-related details of a person such as work address, work email, work phone number, and organizations to which the person belongs.", - "definitions" : { - "profile-work-details" : { - "properties" : { - "xdm:workAddress" : { - "title" : "Work Address", - "$ref" : "https://ns.adobe.com/xdm/common/address", - "description" : "A work postal address." + "meta:intendedToExtend": ["https://ns.adobe.com/xdm/context/profile"], + "description": "Work-related details of a person such as work address, work email, work phone number, and organizations to which the person belongs.", + "definitions": { + "profile-work-details": { + "properties": { + "xdm:workAddress": { + "title": "Work Address", + "$ref": "https://ns.adobe.com/xdm/common/address", + "description": "A work postal address." }, - "xdm:workEmail" : { - "title" : "Work Email", - "$ref" : "https://ns.adobe.com/xdm/context/emailaddress", - "description" : "A work email address." + "xdm:workEmail": { + "title": "Work Email", + "$ref": "https://ns.adobe.com/xdm/context/emailaddress", + "description": "A work email address." }, - "xdm:workPhone" : { - "title" : "Work Phone", - "$ref" : "https://ns.adobe.com/xdm/context/phonenumber", - "description" : "Work phone number." + "xdm:workPhone": { + "title": "Work Phone", + "$ref": "https://ns.adobe.com/xdm/context/phonenumber", + "description": "Work phone number." }, - "xdm:organizations" : { - "title" : "Organizations", - "type" : "array", - "items" : { - "type" : "string" + "xdm:organizations": { + "title": "Organizations", + "type": "array", + "items": { + "type": "string" } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/profile-work-details" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/profile-work-details" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/segment-definition/segmentdefinition-expression.schema.json b/components/mixins/segment-definition/segmentdefinition-expression.schema.json index 98b80021c..d828cd9fd 100644 --- a/components/mixins/segment-definition/segmentdefinition-expression.schema.json +++ b/components/mixins/segment-definition/segmentdefinition-expression.schema.json @@ -1,47 +1,57 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/segmentdefinition-expression", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Segment Expression Details ", - "type" : "object", - "meta:extensible" : true, - "meta:abstract" : true, - "meta:intendedToExtend" : [ "https://ns.adobe.com/xdm/context/segmentdefinition" ], - "description" : "Segment expression data such as expression type, mime type, and expression value.", - "definitions" : { - "segmentdefinition-expression" : { - "properties" : { - "xdm:segmentExpression" : { - "title" : "Segment expression", - "type" : "object", - "properties" : { - "xdm:expressionType" : { - "title" : "Type", - "type" : "string", - "description" : "Type of expression, for example, PQL, Query Service, or Adobe Audience Manager.", - "meta:enum" : [ "PQL", "AAM", "QUERYSERVICE" ] + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/segmentdefinition-expression", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Segment Expression Details ", + "type": "object", + "meta:extensible": true, + "meta:abstract": true, + "meta:intendedToExtend": [ + "https://ns.adobe.com/xdm/context/segmentdefinition" + ], + "description": "Segment expression data such as expression type, mime type, and expression value.", + "definitions": { + "segmentdefinition-expression": { + "properties": { + "xdm:segmentExpression": { + "title": "Segment expression", + "type": "object", + "properties": { + "xdm:expressionType": { + "title": "Type", + "type": "string", + "description": "Type of expression, for example, PQL, Query Service, or Adobe Audience Manager.", + "meta:enum": ["PQL", "AAM", "QUERYSERVICE"] }, - "xdm:mimeType" : { - "title" : "Expression mime type", - "type" : "string", - "description" : "Mime type of the expression. For example, pql/text or application/sql.", - "pattern" : "\\w+/[-.\\w]+(?:\\+[-.\\w]+)?" + "xdm:mimeType": { + "title": "Expression mime type", + "type": "string", + "description": "Mime type of the expression. For example, pql/text or application/sql.", + "pattern": "\\w+/[-.\\w]+(?:\\+[-.\\w]+)?" }, - "xdm:value" : { - "title" : "Value", - "type" : "string", - "description" : "Actual expression string. The syntax of expression will depend upon specified mime type." + "xdm:value": { + "title": "Value", + "type": "string", + "description": "Actual expression string. The syntax of expression will depend upon specified mime type." } } } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/segmentdefinition-expression" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/segmentdefinition-expression" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/shared/external-source-system-audit-details.schema.json b/components/mixins/shared/external-source-system-audit-details.schema.json index 54cf73f0a..a395268e1 100644 --- a/components/mixins/shared/external-source-system-audit-details.schema.json +++ b/components/mixins/shared/external-source-system-audit-details.schema.json @@ -1,28 +1,36 @@ { - "meta:license" : [ "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/external-source-system-audit-details", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "External Source System Audit Details Mixin", - "type" : "object", - "meta:extensible" : true, - "meta:intendedToExtend" : [ ], - "description" : "Mixin which defines a set a audit properties for extenal sources. It's strongly encouraged to use this mixin given the asynchronous nature of profile ingestion.", - "definitions" : { - "externalSourceSystemAuditDetails" : { - "properties" : { - "xdm:extSourceSystemAudit" : { - "title" : "External Source System Audit Properties", - "$ref" : "https://ns.adobe.com/xdm/common/external-source-system-audit", - "description" : "Audit attributes for external sources." + "meta:license": [ + "Copyright 2020 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/external-source-system-audit-details", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "External Source System Audit Details Mixin", + "type": "object", + "meta:extensible": true, + "meta:intendedToExtend": [], + "description": "Mixin which defines a set a audit properties for extenal sources. It's strongly encouraged to use this mixin given the asynchronous nature of profile ingestion.", + "definitions": { + "externalSourceSystemAuditDetails": { + "properties": { + "xdm:extSourceSystemAudit": { + "title": "External Source System Audit Properties", + "$ref": "https://ns.adobe.com/xdm/common/external-source-system-audit", + "description": "Audit attributes for external sources." } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/externalSourceSystemAuditDetails" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/externalSourceSystemAuditDetails" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/shared/identitymap.schema.json b/components/mixins/shared/identitymap.schema.json index 4fd2682a1..2d5544d3b 100644 --- a/components/mixins/shared/identitymap.schema.json +++ b/components/mixins/shared/identitymap.schema.json @@ -1,34 +1,41 @@ { - "meta:license" : [ "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/context/identitymap", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "IdentityMap", - "type" : "object", - "meta:extensible" : true, - "meta:tags" : { - "industry" : [ "all" ] + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/context/identitymap", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "IdentityMap", + "type": "object", + "meta:extensible": true, + "meta:tags": { + "industry": ["all"] }, - "meta:intendedToExtend" : [ ], - "description" : "Defines a map containing a set of end user identities, keyed on either namespace integration code or the namespace ID of the identity. The values of the map are an array, meaning that more than one identity of each namespace may be carried.", - "definitions" : { - "identitymap" : { - "properties" : { - "xdm:identityMap" : { - "type" : "object", - "meta:xdmType" : "map", - "additionalProperties" : { - "type" : "array", - "items" : { - "$ref" : "https://ns.adobe.com/xdm/context/identityitem" + "meta:intendedToExtend": [], + "description": "Defines a map containing a set of end user identities, keyed on either namespace integration code or the namespace ID of the identity. The values of the map are an array, meaning that more than one identity of each namespace may be carried.", + "definitions": { + "identitymap": { + "properties": { + "xdm:identityMap": { + "type": "object", + "meta:xdmType": "map", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "https://ns.adobe.com/xdm/context/identityitem" } } } } } }, - "allOf" : [ { - "$ref" : "#/definitions/identitymap" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/identitymap" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/components/mixins/shared/person-identifier.schema.json b/components/mixins/shared/person-identifier.schema.json index 1c12318da..234b661fd 100644 --- a/components/mixins/shared/person-identifier.schema.json +++ b/components/mixins/shared/person-identifier.schema.json @@ -1,25 +1,32 @@ { - "meta:license" : [ "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/mixins/person-identifier", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Person Identifier", - "type" : "object", - "meta:intendedToExtend" : [ ], - "description" : "Used to store Person ID for an entity.", - "definitions" : { - "person-id" : { - "properties" : { - "xdm:personID" : { - "title" : "Person ID", - "description" : "Person unique identifier.", - "type" : "string" + "meta:license": [ + "Copyright 2021 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/mixins/person-identifier", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Person Identifier", + "type": "object", + "meta:intendedToExtend": [], + "description": "Used to store Person ID for an entity.", + "definitions": { + "person-id": { + "properties": { + "xdm:personID": { + "title": "Person ID", + "description": "Person unique identifier.", + "type": "string" } } } }, - "allOf" : [ { - "$ref" : "#/definitions/person-id" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/person-id" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/schemas/descriptors/display/alternateDisplayInfo.schema.json b/schemas/descriptors/display/alternateDisplayInfo.schema.json index ea50bf0e1..34ff7eafc 100644 --- a/schemas/descriptors/display/alternateDisplayInfo.schema.json +++ b/schemas/descriptors/display/alternateDisplayInfo.schema.json @@ -1,80 +1,97 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/alternateDisplayInfo", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Friendly Name Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Allows to modify the \"title\" and \"description\" values of the core library schema fields. UI can use these to show a more friendly name for a standard field or to only show fields that have friendly names.", - "definitions" : { - "alternateDisplayInfo" : { - "properties" : { - "@type" : { - "title" : "Type", - "type" : "string", - "const" : "xdm:alternateDisplayInfo" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/alternateDisplayInfo", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Friendly Name Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Allows to modify the \"title\" and \"description\" values of the core library schema fields. UI can use these to show a more friendly name for a standard field or to only show fields that have friendly names.", + "definitions": { + "alternateDisplayInfo": { + "properties": { + "@type": { + "title": "Type", + "type": "string", + "const": "xdm:alternateDisplayInfo" }, - "xdm:title" : { - "title" : "Title", - "type" : "object", - "description" : "When present, user friendly title to display.", - "patternProperties" : { - ".+_.+" : { - "type" : "string" + "xdm:title": { + "title": "Title", + "type": "object", + "description": "When present, user friendly title to display.", + "patternProperties": { + ".+_.+": { + "type": "string" } } }, - "xdm:description" : { - "title" : "Description", - "type" : "object", - "description" : "When present, user friendly description to display.", - "patternProperties" : { - ".+_.+" : { - "type" : "string" + "xdm:description": { + "title": "Description", + "type": "object", + "description": "When present, user friendly description to display.", + "patternProperties": { + ".+_.+": { + "type": "string" } } }, - "xdm:note" : { - "title" : "Note", - "type" : "object", - "description" : "When present, user friendly note to display. Similar to a description, but provides more details about the actual usage of the field.", - "patternProperties" : { - ".+_.+" : { - "type" : "string" + "xdm:note": { + "title": "Note", + "type": "object", + "description": "When present, user friendly note to display. Similar to a description, but provides more details about the actual usage of the field.", + "patternProperties": { + ".+_.+": { + "type": "string" } } }, - "meta:enum" : { - "title" : "Extended meta:enum values", - "type" : "object", - "patternProperties" : { - ".+_.+" : { - "oneOf" : [ { - "type" : "object" - }, { - "type" : "string" - } ] + "meta:enum": { + "title": "Extended meta:enum values", + "type": "object", + "patternProperties": { + ".+_.+": { + "oneOf": [ + { + "type": "object" + }, + { + "type": "string" + } + ] } } } }, - "anyOf" : [ { - "required" : [ "xdm:title" ] - }, { - "required" : [ "xdm:description" ] - }, { - "required" : [ "meta:enum" ] - } ], - "required" : [ "xdm:sourceProperty" ] + "anyOf": [ + { + "required": ["xdm:title"] + }, + { + "required": ["xdm:description"] + }, + { + "required": ["meta:enum"] + } + ], + "required": ["xdm:sourceProperty"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "#/definitions/alternateDisplayInfo" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/alternateDisplayInfo" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/identity/descriptorIdentity.schema.json b/schemas/descriptors/identity/descriptorIdentity.schema.json index 874787977..61e4f9449 100644 --- a/schemas/descriptors/identity/descriptorIdentity.schema.json +++ b/schemas/descriptors/identity/descriptorIdentity.schema.json @@ -1,46 +1,56 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Identity Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Used to mark a field as an identity.", - "definitions" : { - "descriptorIdentity" : { - "properties" : { - "@type" : { - "title" : "Type", - "type" : "string", - "const" : "xdm:descriptorIdentity" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorIdentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Used to mark a field as an identity.", + "definitions": { + "descriptorIdentity": { + "properties": { + "@type": { + "title": "Type", + "type": "string", + "const": "xdm:descriptorIdentity" }, - "xdm:namespace" : { - "title" : "Namespace", - "type" : "string", - "description" : "Identity ID or Code." + "xdm:namespace": { + "title": "Namespace", + "type": "string", + "description": "Identity ID or Code." }, - "xdm:property" : { - "title" : "Property", - "type" : "string", - "description" : "Property of the `xdm:namespace` field.", - "enum" : [ "xdm:id", "xdm:code" ] + "xdm:property": { + "title": "Property", + "type": "string", + "description": "Property of the `xdm:namespace` field.", + "enum": ["xdm:id", "xdm:code"] }, - "xdm:isPrimary" : { - "title" : "Is primary key or not", - "type" : "boolean", - "description" : "When present, only one field should be marked as the primary. Default is false." + "xdm:isPrimary": { + "title": "Is primary key or not", + "type": "boolean", + "description": "When present, only one field should be marked as the primary. Default is false." } }, - "required" : [ "xdm:sourceProperty", "xdm:namespace", "xdm:property" ] + "required": ["xdm:sourceProperty", "xdm:namespace", "xdm:property"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "#/definitions/descriptorIdentity" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/descriptorIdentity" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/identity/descriptorReferenceIdentity.schema.json b/schemas/descriptors/identity/descriptorReferenceIdentity.schema.json index 9a09b70a3..7df30df59 100644 --- a/schemas/descriptors/identity/descriptorReferenceIdentity.schema.json +++ b/schemas/descriptors/identity/descriptorReferenceIdentity.schema.json @@ -1,35 +1,45 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/descriptorReferenceIdentity", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Identity Reference Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Used to assign a namespace that will be used to derive a relationship.", - "definitions" : { - "descriptorReferenceIdentity" : { - "properties" : { - "@type" : { - "title" : "Type", - "type" : "string", - "const" : "xdm:descriptorReferenceIdentity" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorReferenceIdentity", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Identity Reference Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Used to assign a namespace that will be used to derive a relationship.", + "definitions": { + "descriptorReferenceIdentity": { + "properties": { + "@type": { + "title": "Type", + "type": "string", + "const": "xdm:descriptorReferenceIdentity" }, - "xdm:identityNamespace" : { - "title" : "Identity Namespace", - "type" : "string", - "description" : "The namespace code defined in identity system." + "xdm:identityNamespace": { + "title": "Identity Namespace", + "type": "string", + "description": "The namespace code defined in identity system." } }, - "required" : [ "xdm:sourceProperty", "xdm:identityNamespace" ] + "required": ["xdm:sourceProperty", "xdm:identityNamespace"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "#/definitions/descriptorReferenceIdentity" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/descriptorReferenceIdentity" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/itemselector.schema.json b/schemas/descriptors/itemselector.schema.json index a700d071f..33e2cd976 100644 --- a/schemas/descriptors/itemselector.schema.json +++ b/schemas/descriptors/itemselector.schema.json @@ -1,64 +1,76 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/itemselector", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Item Selector", - "meta:extensible" : false, - "meta:abstract" : false, - "type" : "object", - "description" : "Describes how to select or match to a specific item from an array of values described by an XDM schema. Matching may be done based on array index, @id, @type, or schema URI.", - "definitions" : { - "selector" : { - "oneOf" : [ { - "type" : "object", - "properties" : { - "xdm:index" : { - "title" : "Index", - "type" : "integer", - "description" : "When present, indicates the item at this array index should be selected.", - "minimum" : 0 - } + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/itemselector", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Item Selector", + "meta:extensible": false, + "meta:abstract": false, + "type": "object", + "description": "Describes how to select or match to a specific item from an array of values described by an XDM schema. Matching may be done based on array index, @id, @type, or schema URI.", + "definitions": { + "selector": { + "oneOf": [ + { + "type": "object", + "properties": { + "xdm:index": { + "title": "Index", + "type": "integer", + "description": "When present, indicates the item at this array index should be selected.", + "minimum": 0 + } + }, + "required": ["xdm:index"] }, - "required" : [ "xdm:index" ] - }, { - "type" : "object", - "properties" : { - "xdm:id" : { - "title" : "ID", - "type" : "string", - "format" : "uri", - "description" : "When present, indicates the item with this @id value should be selected." - } + { + "type": "object", + "properties": { + "xdm:id": { + "title": "ID", + "type": "string", + "format": "uri", + "description": "When present, indicates the item with this @id value should be selected." + } + }, + "required": ["xdm:id"] }, - "required" : [ "xdm:id" ] - }, { - "type" : "object", - "properties" : { - "xdm:type" : { - "title" : "Type", - "type" : "string", - "format" : "uri", - "description" : "When present, indicates the item with this @type value should be selected." - } + { + "type": "object", + "properties": { + "xdm:type": { + "title": "Type", + "type": "string", + "format": "uri", + "description": "When present, indicates the item with this @type value should be selected." + } + }, + "required": ["xdm:type"] }, - "required" : [ "xdm:type" ] - }, { - "type" : "object", - "properties" : { - "xdm:schema" : { - "title" : "Schema", - "type" : "string", - "format" : "uri", - "description" : "When present, indicates the item which conforms to this schema URI should be selected." - } - }, - "required" : [ "xdm:schema" ] - } ] + { + "type": "object", + "properties": { + "xdm:schema": { + "title": "Schema", + "type": "string", + "format": "uri", + "description": "When present, indicates the item which conforms to this schema URI should be selected." + } + }, + "required": ["xdm:schema"] + } + ] } }, - "allOf" : [ { - "$ref" : "#/definitions/selector" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "#/definitions/selector" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/relationship/descriptorManyToMany.schema.json b/schemas/descriptors/relationship/descriptorManyToMany.schema.json index 3571d2bd5..8b4fb04f5 100644 --- a/schemas/descriptors/relationship/descriptorManyToMany.schema.json +++ b/schemas/descriptors/relationship/descriptorManyToMany.schema.json @@ -1,30 +1,42 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/descriptorManyToMany", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Many to Many Relationship Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Describes many to many relationship descriptor.", - "definitions" : { - "descriptorManyToMany" : { - "properties" : { - "@type" : { - "type" : "string", - "const" : "xdm:descriptorManyToMany" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorManyToMany", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Many to Many Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes many to many relationship descriptor.", + "definitions": { + "descriptorManyToMany": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorManyToMany" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" - }, { - "$ref" : "#/definitions/descriptorManyToMany" - } ], - "meta:status" : "deprecated", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorManyToMany" + } + ], + "meta:status": "deprecated", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/relationship/descriptorManyToOne.schema.json b/schemas/descriptors/relationship/descriptorManyToOne.schema.json index 0c04e29d6..a7b20f28b 100644 --- a/schemas/descriptors/relationship/descriptorManyToOne.schema.json +++ b/schemas/descriptors/relationship/descriptorManyToOne.schema.json @@ -1,30 +1,42 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/descriptorManyToOne", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Many to One Relationship Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor", "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Describes many to one relationship descriptor.", - "definitions" : { - "descriptorManyToOne" : { - "properties" : { - "@type" : { - "type" : "string", - "const" : "xdm:descriptorManyToOne" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorManyToOne", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Many to One Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes many to one relationship descriptor.", + "definitions": { + "descriptorManyToOne": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorManyToOne" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" - }, { - "$ref" : "#/definitions/descriptorManyToOne" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-10-21" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorManyToOne" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-10-21" +} diff --git a/schemas/descriptors/relationship/descriptorOneToMany.schema.json b/schemas/descriptors/relationship/descriptorOneToMany.schema.json index 4b2323882..bfcbfaea9 100644 --- a/schemas/descriptors/relationship/descriptorOneToMany.schema.json +++ b/schemas/descriptors/relationship/descriptorOneToMany.schema.json @@ -1,30 +1,42 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToMany", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "One to Many Relationship Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Describes one to many relationship descriptor.", - "definitions" : { - "descriptorOneToMany" : { - "properties" : { - "@type" : { - "type" : "string", - "const" : "xdm:descriptorOneToMany" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToMany", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "One to Many Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes one to many relationship descriptor.", + "definitions": { + "descriptorOneToMany": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorOneToMany" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" - }, { - "$ref" : "#/definitions/descriptorOneToMany" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorOneToMany" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/relationship/descriptorOneToOne.schema.json b/schemas/descriptors/relationship/descriptorOneToOne.schema.json index 12e985614..4b220568e 100644 --- a/schemas/descriptors/relationship/descriptorOneToOne.schema.json +++ b/schemas/descriptors/relationship/descriptorOneToOne.schema.json @@ -1,30 +1,42 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "One to One Relationship Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Describes one to one relationship descriptor.", - "definitions" : { - "descriptorOneToOne" : { - "properties" : { - "@type" : { - "type" : "string", - "const" : "xdm:descriptorOneToOne" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "One to One Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes one to one relationship descriptor.", + "definitions": { + "descriptorOneToOne": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorOneToOne" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" - }, { - "$ref" : "#/definitions/descriptorOneToOne" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorOneToOne" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/relationship/descriptorRelationship.schema.json b/schemas/descriptors/relationship/descriptorRelationship.schema.json index b3e8d7759..c031d1c80 100644 --- a/schemas/descriptors/relationship/descriptorRelationship.schema.json +++ b/schemas/descriptors/relationship/descriptorRelationship.schema.json @@ -1,30 +1,42 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/descriptorRelationship", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Relationship Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Describes a general relationship between two schemas", - "definitions" : { - "descriptorRelationship" : { - "properties" : { - "@type" : { - "type" : "string", - "const" : "xdm:descriptorRelationship" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/descriptorRelationship", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor", + "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes a general relationship between two schemas", + "definitions": { + "descriptorRelationship": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:descriptorRelationship" } } } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" - }, { - "$ref" : "#/definitions/descriptorRelationship" - } ], - "meta:status" : "experimental", - "meta:createdDate" : "2021-02-19" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor#/definitions/relationshipdescriptor" + }, + { + "$ref": "#/definitions/descriptorRelationship" + } + ], + "meta:status": "experimental", + "meta:createdDate": "2021-02-19" +} diff --git a/schemas/descriptors/relationship/eventRelationship.schema.json b/schemas/descriptors/relationship/eventRelationship.schema.json index f8c3f4511..3a0aed2bf 100644 --- a/schemas/descriptors/relationship/eventRelationship.schema.json +++ b/schemas/descriptors/relationship/eventRelationship.schema.json @@ -1,40 +1,50 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/eventRelationship", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Event Relationship Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Used by the UPS system to assign the specific schema that will used for the timeSeriesEvents field which is part of the union view of a class. If not supplied, the system today will default to the unified ExperienceEvent.", - "definitions" : { - "eventRelationship" : { - "properties" : { - "@type" : { - "type" : "string", - "const" : "xdm:eventRelationship" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/eventRelationship", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Event Relationship Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Used by the UPS system to assign the specific schema that will used for the timeSeriesEvents field which is part of the union view of a class. If not supplied, the system today will default to the unified ExperienceEvent.", + "definitions": { + "eventRelationship": { + "properties": { + "@type": { + "type": "string", + "const": "xdm:eventRelationship" }, - "xdm:destinationSchema" : { - "title" : "Destination Schema", - "type" : "string", - "format" : "uri", - "description" : "The destination schema this descriptor applies to" + "xdm:destinationSchema": { + "title": "Destination Schema", + "type": "string", + "format": "uri", + "description": "The destination schema this descriptor applies to" }, - "xdm:destinationVersion" : { - "title" : "Destination Version", - "type" : "number", - "description" : "When present, major version being referenced." + "xdm:destinationVersion": { + "title": "Destination Version", + "type": "number", + "description": "When present, major version being referenced." } }, - "required" : [ "xdm:destinationSchema", "xdm:destinationVersion" ] + "required": ["xdm:destinationSchema", "xdm:destinationVersion"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "#/definitions/eventRelationship" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/eventRelationship" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/relationshipdescriptor.schema.json b/schemas/descriptors/relationshipdescriptor.schema.json index 75085011c..0bf1a8dad 100644 --- a/schemas/descriptors/relationshipdescriptor.schema.json +++ b/schemas/descriptors/relationshipdescriptor.schema.json @@ -1,95 +1,111 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Relationship Descriptor", - "meta:extensible" : true, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" ], - "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.", - "definitions" : { - "relationshipdescriptor" : { - "properties" : { - "xdm:destinationSchema" : { - "title" : "Destination Schema", - "type" : "string", - "format" : "uri", - "description" : "The destination schema this descriptor applies to" + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/relationshipdescriptor", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Relationship Descriptor", + "meta:extensible": true, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "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.", + "definitions": { + "relationshipdescriptor": { + "properties": { + "xdm:destinationSchema": { + "title": "Destination Schema", + "type": "string", + "format": "uri", + "description": "The destination schema this descriptor applies to" }, - "xdm:destinationProperty" : { - "title" : "Destination Property", - "oneOf" : [ { - "type" : "string" - }, { - "type" : "array", - "items" : { - "type" : "string" + "xdm:destinationProperty": { + "title": "Destination Property", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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" + "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" }, - "xdm:destinationVersion" : { - "title" : "Destination Version", - "type" : "number", - "description" : "Major version being referenced." + "xdm:destinationVersion": { + "title": "Destination Version", + "type": "number", + "description": "Major version being referenced." }, - "xdm:sourceValue" : { - "title" : "Source Value", - "type" : "string", - "description" : "When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations." + "xdm:sourceValue": { + "title": "Source Value", + "type": "string", + "description": "When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations." }, - "xdm:label" : { - "title" : "Label", - "type" : "string", - "description" : "Provides a user friendly name or label to this relationship" + "xdm:label": { + "title": "Label", + "type": "string", + "description": "Provides a user friendly name or label to this relationship" }, - "xdm:sourceNamespace" : { - "title" : "Source Property Namespace", - "type" : "string", - "description" : "Identity Service namespace associated with the source property" + "xdm:sourceNamespace": { + "title": "Source Property Namespace", + "type": "string", + "description": "Identity Service namespace associated with the source property" }, - "xdm:destinationNamespace" : { - "title" : "Source Property Namespace", - "type" : "string", - "description" : "Identity Service namespace associated with the source property" + "xdm:destinationNamespace": { + "title": "Source Property Namespace", + "type": "string", + "description": "Identity Service namespace associated with the source property" }, - "xdm:sourceToDestinationTitle" : { - "title" : "Source to Destination Title", - "type" : "string", - "description" : "Provides a user friendly title for the source->destination edge" + "xdm:sourceToDestinationTitle": { + "title": "Source to Destination Title", + "type": "string", + "description": "Provides a user friendly title for the source->destination edge" }, - "xdm:destinationToSourceTitle" : { - "title" : "Destination to Source Title", - "type" : "string", - "description" : "Provides a user friendly title for the destination->source edge" + "xdm:destinationToSourceTitle": { + "title": "Destination to Source Title", + "type": "string", + "description": "Provides a user friendly title for the destination->source edge" }, - "xdm:cardinality" : { - "title" : "Relationship Cardinality", - "type" : "string", - "description" : "Source to Destination cardinality", - "enum" : [ "M:1", "1:1" ], - "default" : "M:1" + "xdm:cardinality": { + "title": "Relationship Cardinality", + "type": "string", + "description": "Source to Destination cardinality", + "enum": ["M:1", "1:1"], + "default": "M:1" } }, - "oneOf" : [ { - "required" : [ "xdm:label" ] - }, { - "required" : [ "xdm:sourceProperty" ] - } ], - "required" : [ "xdm:destinationSchema", "xdm:destinationVersion" ] + "oneOf": [ + { + "required": ["xdm:label"] + }, + { + "required": ["xdm:sourceProperty"] + } + ], + "required": ["xdm:destinationSchema", "xdm:destinationVersion"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "#/definitions/relationshipdescriptor" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/relationshipdescriptor" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/relationshipv2/relationshipOneToMany.schema.json b/schemas/descriptors/relationshipv2/relationshipOneToMany.schema.json index 47d533074..74ba05c98 100644 --- a/schemas/descriptors/relationshipv2/relationshipOneToMany.schema.json +++ b/schemas/descriptors/relationshipv2/relationshipOneToMany.schema.json @@ -1,55 +1,67 @@ { - "meta:license" : [ "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/relationshipOneToMany", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "One to Many Bi-Directional Relationship Descriptor", - "meta:extensible" : false, - "meta:abstract" : false, - "type" : "object", - "description" : "Describes a bi-directional one to many relationship", - "properties" : { - "@type" : { - "type" : "string", - "const" : "xdm:relationshipOneToMany" - }, - "xdm:oneSideSchema" : { - "type" : "string", - "title" : "One Side Schema ID" - }, - "xdm:oneSideVersion" : { - "type" : "number", - "title" : "One Side Schema Major Version" - }, - "xdm:oneSideProperty" : { - "type" : "string", - "title" : "One Side Field Path" - }, - "xdm:manySideSchema" : { - "type" : "string", - "title" : "Many Side Schema ID" - }, - "xdm:manySideVersion" : { - "type" : "number", - "title" : "Many Side Schema Major Version" - }, - "xdm:manySideProperty" : { - "type" : "string", - "title" : "Many Side Field Path" - }, - "xdm:manySideNamespace" : { - "type" : "string", - "title" : "Identity Namespace Code" - }, - "xdm:oneToManyDisplayName" : { - "type" : "string", - "title" : "One To Many Edge Name" - }, - "xdm:manyToOneDisplayName" : { - "type" : "string", - "title" : "Many To One Edge Name" + "meta:license": [ + "Copyright 2019 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/relationshipOneToMany", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "One to Many Bi-Directional Relationship Descriptor", + "meta:extensible": false, + "meta:abstract": false, + "type": "object", + "description": "Describes a bi-directional one to many relationship", + "properties": { + "@type": { + "type": "string", + "const": "xdm:relationshipOneToMany" + }, + "xdm:oneSideSchema": { + "type": "string", + "title": "One Side Schema ID" + }, + "xdm:oneSideVersion": { + "type": "number", + "title": "One Side Schema Major Version" + }, + "xdm:oneSideProperty": { + "type": "string", + "title": "One Side Field Path" + }, + "xdm:manySideSchema": { + "type": "string", + "title": "Many Side Schema ID" + }, + "xdm:manySideVersion": { + "type": "number", + "title": "Many Side Schema Major Version" + }, + "xdm:manySideProperty": { + "type": "string", + "title": "Many Side Field Path" + }, + "xdm:manySideNamespace": { + "type": "string", + "title": "Identity Namespace Code" + }, + "xdm:oneToManyDisplayName": { + "type": "string", + "title": "One To Many Edge Name" + }, + "xdm:manyToOneDisplayName": { + "type": "string", + "title": "Many To One Edge Name" } }, - "required" : [ "@type", "xdm:oneSideSchema", "xdm:oneSideVersion", "xdm:manySideSchema", "xdm:manySideVersion", "xdm:manySideProperty" ], - "meta:status" : "deprecated", - "meta:createdDate" : "2021-02-05" -} \ No newline at end of file + "required": [ + "@type", + "xdm:oneSideSchema", + "xdm:oneSideVersion", + "xdm:manySideSchema", + "xdm:manySideVersion", + "xdm:manySideProperty" + ], + "meta:status": "deprecated", + "meta:createdDate": "2021-02-05" +} diff --git a/schemas/descriptors/schemadescriptor.schema.json b/schemas/descriptors/schemadescriptor.schema.json index ffec44692..307800a7c 100644 --- a/schemas/descriptors/schemadescriptor.schema.json +++ b/schemas/descriptors/schemadescriptor.schema.json @@ -1,64 +1,75 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Schema Descriptor", - "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.", - "definitions" : { - "descriptor" : { - "properties" : { - "@id" : { - "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'." + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Schema Descriptor", + "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.", + "definitions": { + "descriptor": { + "properties": { + "@id": { + "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'." }, - "@type" : { - "title" : "Type", - "type" : "string", - "description" : "The type of descriptor this object represents.", - "meta:enum" : { } + "@type": { + "title": "Type", + "type": "string", + "description": "The type of descriptor this object represents.", + "meta:enum": {} }, - "xdm:sourceSchema" : { - "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'" + "xdm:sourceSchema": { + "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'" }, - "xdm:sourceProperty" : { - "title" : "Source Property", - "oneOf" : [ { - "type" : "string" - }, { - "type" : "array", - "items" : { - "type" : "string" + "xdm:sourceProperty": { + "title": "Source Property", + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "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:sourceVersion" : { - "title" : "Source Version", - "type" : "number", - "description" : "Major version being referenced." + "xdm:sourceVersion": { + "title": "Source Version", + "type": "number", + "description": "Major version being referenced." }, - "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" + "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" } }, - "required" : [ "xdm:sourceSchema", "xdm:sourceVersion" ] + "required": ["xdm:sourceSchema", "xdm:sourceVersion"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" - }, { - "$ref" : "#/definitions/descriptor" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context" + }, + { + "$ref": "#/definitions/descriptor" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +} diff --git a/schemas/descriptors/search/searchdescriptor.schema.json b/schemas/descriptors/search/searchdescriptor.schema.json index 75d58e731..e0819a95a 100644 --- a/schemas/descriptors/search/searchdescriptor.schema.json +++ b/schemas/descriptors/search/searchdescriptor.schema.json @@ -1,103 +1,113 @@ { - "meta:license" : [ "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", "you may not use this file except in compliance with the License. You may obtain a copy", "of the License at https://creativecommons.org/licenses/by/4.0/" ], - "$id" : "https://ns.adobe.com/xdm/common/descriptors/searchdescriptor", - "$schema" : "http://json-schema.org/draft-06/schema#", - "title" : "Search Descriptor", - "meta:extensible" : false, - "meta:extends" : [ "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" ], - "meta:abstract" : false, - "type" : "object", - "description" : "Describes search annotations for specific properties of the schemas.", - "definitions" : { - "searchdescriptor" : { - "properties" : { - "search:indexed" : { - "title" : "Indexed", - "type" : "boolean", - "description" : "Whether the property is indexable and searchable.", - "default" : false + "meta:license": [ + "Copyright 2018 Adobe Systems Incorporated. All rights reserved.", + "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at https://creativecommons.org/licenses/by/4.0/" + ], + "$id": "https://ns.adobe.com/xdm/common/descriptors/searchdescriptor", + "$schema": "http://json-schema.org/draft-06/schema#", + "title": "Search Descriptor", + "meta:extensible": false, + "meta:extends": [ + "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + ], + "meta:abstract": false, + "type": "object", + "description": "Describes search annotations for specific properties of the schemas.", + "definitions": { + "searchdescriptor": { + "properties": { + "search:indexed": { + "title": "Indexed", + "type": "boolean", + "description": "Whether the property is indexable and searchable.", + "default": false }, - "search:filterable" : { - "title" : "Filterable", - "type" : "boolean", - "description" : "Whether the property can be used as a filter in search queries.", - "default" : false + "search:filterable": { + "title": "Filterable", + "type": "boolean", + "description": "Whether the property can be used as a filter in search queries.", + "default": false }, - "search:store" : { - "title" : "Stored", - "type" : "string", - "description" : "Whether the property value is stored in, and therefore can be retrieved from, the index.", - "meta:enum" : { - "notStored" : "notStored", - "stored" : "stored", - "storedAndFetchByDefault" : "storedAndFetchByDefault" + "search:store": { + "title": "Stored", + "type": "string", + "description": "Whether the property value is stored in, and therefore can be retrieved from, the index.", + "meta:enum": { + "notStored": "notStored", + "stored": "stored", + "storedAndFetchByDefault": "storedAndFetchByDefault" }, - "default" : "notStored" + "default": "notStored" }, - "search:sort" : { - "title" : "Sort Type", - "type" : "string", - "description" : "Whether and how search results can be sorted on this property.", - "meta:enum" : { - "notSortable" : "notSortable", - "sorted" : "sorted", - "sortedCaseSensitive" : "sortedCaseSensitive", - "sortedCaseInsensitive" : "sortedCaseInsensitive" + "search:sort": { + "title": "Sort Type", + "type": "string", + "description": "Whether and how search results can be sorted on this property.", + "meta:enum": { + "notSortable": "notSortable", + "sorted": "sorted", + "sortedCaseSensitive": "sortedCaseSensitive", + "sortedCaseInsensitive": "sortedCaseInsensitive" }, - "default" : "notSortable" + "default": "notSortable" }, - "search:analyzers" : { - "title" : "Analyzers", - "type" : "array", - "items" : { - "type" : "string" + "search:analyzers": { + "title": "Analyzers", + "type": "array", + "items": { + "type": "string" }, - "meta:enum" : { - "noAnalysis" : "noAnalysis", - "standard" : "standard", - "langGeneric" : "langGeneric", - "langFr" : "langFr", - "langTh" : "langTh", - "langDe" : "langDe", - "langJa" : "langJa", - "langZh" : "langZh", - "startsWithDefaultAnalyzer" : "startsWithDefaultAnalyzer", - "startsWithWhiteSpaceAnalyzer" : "startsWithWhiteSpaceAnalyzer", - "fileName" : "fileName", - "fileNameExtension" : "fileNameExtension" + "meta:enum": { + "noAnalysis": "noAnalysis", + "standard": "standard", + "langGeneric": "langGeneric", + "langFr": "langFr", + "langTh": "langTh", + "langDe": "langDe", + "langJa": "langJa", + "langZh": "langZh", + "startsWithDefaultAnalyzer": "startsWithDefaultAnalyzer", + "startsWithWhiteSpaceAnalyzer": "startsWithWhiteSpaceAnalyzer", + "fileName": "fileName", + "fileNameExtension": "fileNameExtension" }, - "description" : "A set of analyzers to be applied when indexing this property.", - "default" : "noAnalysis" + "description": "A set of analyzers to be applied when indexing this property.", + "default": "noAnalysis" }, - "search:defaultAnalyzer" : { - "title" : "Default analyzer", - "type" : "string", - "description" : "Default analyzer to be applied when search queries are made against this property.", - "meta:enum" : { - "noAnalysis" : "noAnalysis", - "standard" : "standard", - "langGeneric" : "langGeneric", - "langFr" : "langFr", - "langTh" : "langTh", - "langDe" : "langDe", - "langJa" : "langJa", - "langZh" : "langZh", - "startsWithDefaultAnalyzer" : "startsWithDefaultAnalyzer", - "startsWithWhiteSpaceAnalyzer" : "startsWithWhiteSpaceAnalyzer", - "fileName" : "fileName", - "fileNameExtension" : "fileNameExtension" + "search:defaultAnalyzer": { + "title": "Default analyzer", + "type": "string", + "description": "Default analyzer to be applied when search queries are made against this property.", + "meta:enum": { + "noAnalysis": "noAnalysis", + "standard": "standard", + "langGeneric": "langGeneric", + "langFr": "langFr", + "langTh": "langTh", + "langDe": "langDe", + "langJa": "langJa", + "langZh": "langZh", + "startsWithDefaultAnalyzer": "startsWithDefaultAnalyzer", + "startsWithWhiteSpaceAnalyzer": "startsWithWhiteSpaceAnalyzer", + "fileName": "fileName", + "fileNameExtension": "fileNameExtension" }, - "default" : "noAnalysis" + "default": "noAnalysis" } }, - "required" : [ "search:indexed" ] + "required": ["search:indexed"] } }, - "allOf" : [ { - "$ref" : "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" - }, { - "$ref" : "#/definitions/searchdescriptor" - } ], - "meta:status" : "stable", - "meta:createdDate" : "2020-08-10" -} \ No newline at end of file + "allOf": [ + { + "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor" + }, + { + "$ref": "#/definitions/searchdescriptor" + } + ], + "meta:status": "stable", + "meta:createdDate": "2020-08-10" +}