[ci skip] updating documentation

braze-inc · Aug 1, 2022 · c1c5646 · c1c5646
1 parent c076246
commit c1c5646
Show file tree

Hide file tree

Showing 45 changed files with 733 additions and 733 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
@@ -1,6 +1,6 @@
 # Stabilization Candidates
 
-_Generated on **Mon Aug 01 2022 18:24:37 GMT+0000 (UTC)**_
+_Generated on **Mon Aug 01 2022 22:35:07 GMT+0000 (UTC)**_
 
 
 ### Unknown Status, needs immediate attention
@@ -13,7 +13,7 @@ _Generated on **Mon Aug 01 2022 18:24:37 GMT+0000 (UTC)**_
 
 |Schema|Status|Status Modified Date|Last Non-trivial Change|Raw Commit Log Since Status Change|
 |------|------|--------------------|-----------------------|----------------------------------|
-|[schemas/descriptors/relationship/descriptorRelationship](schemas/descriptors/relationship/descriptorRelationship.schema.json)|experimental|**479**|**403**|[613a327](https://github.com/adobe/xdm/commit/613a3270dace69bcfef0d391e0b3717946fa3a22 "Removed extension folder from localization") [b4ac040](https://github.com/adobe/xdm/commit/b4ac0402a6f317427c1b6511584fd79372b028ab "Merge master") [f30f47d](https://github.com/adobe/xdm/commit/f30f47d4fc34a62c3af366b3a2deef5cfc281d04 "Added meta:tileId and meta:descriptionId to resolver of compatibility check") [26c8c21](https://github.com/adobe/xdm/commit/26c8c21ed74e24d631c8edef8945dd1048f99cbb "Excluded null values and append random number to keys") [8616f86](https://github.com/adobe/xdm/commit/8616f862621868dfb4ffa7286938186de4822d96 "Added meta:createdDate attribute")|
+|[schemas/descriptors/relationship/descriptorRelationship](schemas/descriptors/relationship/descriptorRelationship.schema.json)|experimental|**480**|**404**|[613a327](https://github.com/adobe/xdm/commit/613a3270dace69bcfef0d391e0b3717946fa3a22 "Removed extension folder from localization") [b4ac040](https://github.com/adobe/xdm/commit/b4ac0402a6f317427c1b6511584fd79372b028ab "Merge master") [f30f47d](https://github.com/adobe/xdm/commit/f30f47d4fc34a62c3af366b3a2deef5cfc281d04 "Added meta:tileId and meta:descriptionId to resolver of compatibility check") [26c8c21](https://github.com/adobe/xdm/commit/26c8c21ed74e24d631c8edef8945dd1048f99cbb "Excluded null values and append random number to keys") [8616f86](https://github.com/adobe/xdm/commit/8616f862621868dfb4ffa7286938186de4822d96 "Added meta:createdDate attribute")|
 |[schemas/descriptors/time-series/descriptorTimeSeriesGranularity](schemas/descriptors/time-series/descriptorTimeSeriesGranularity.schema.json)|experimental|**119**|**119**|[92c9136](https://github.com/adobe/xdm/commit/92c9136baed4a9dd5400f75ecd65a55d4d9af939 "Added new Summary Metrics class and granularity descriptor")|
 |[schemas/destinations/solutions/analytics-experienceevent](schemas/destinations/solutions/analytics-experienceevent.schema.json)|experimental|**338**|**167**|[24fcf3a](https://github.com/adobe/xdm/commit/24fcf3a96c85c6ae3bfb004d40914f2a233dc67b "Update analytics-experienceevent.schema.json") [5cee23f](https://github.com/adobe/xdm/commit/5cee23f397b7d5408f3a2ea3a3f41b367bbddc0f "Update analytics-experienceevent.schema.json") [30d35d6](https://github.com/adobe/xdm/commit/30d35d60711d136633b7752947c812b0c3307db7 "Update analytics-experienceevent.schema.json") [8245ce9](https://github.com/adobe/xdm/commit/8245ce978f7e238bda59c5f0f0c6e8bb541a7998 "Revert the ID to those in en-US file") [d83cc36](https://github.com/adobe/xdm/commit/d83cc365740a81bf0c470b89b0dd690adb125326 "Added titleId and created Localization files") [613a327](https://github.com/adobe/xdm/commit/613a3270dace69bcfef0d391e0b3717946fa3a22 "Removed extension folder from localization") [b4ac040](https://github.com/adobe/xdm/commit/b4ac0402a6f317427c1b6511584fd79372b028ab "Merge master") [f30f47d](https://github.com/adobe/xdm/commit/f30f47d4fc34a62c3af366b3a2deef5cfc281d04 "Added meta:tileId and meta:descriptionId to resolver of compatibility check") [26c8c21](https://github.com/adobe/xdm/commit/26c8c21ed74e24d631c8edef8945dd1048f99cbb "Excluded null values and append random number to keys")|
 |[schemas/hygiene/aep-hygiene-ops-record](schemas/hygiene/aep-hygiene-ops-record.schema.json)|experimental|**151**|**82**|[dda4f2d](https://github.com/adobe/xdm/commit/dda4f2dc626c2e9744f3c7345db78f902ca8877d "Update aep-hygiene-ops-record.schema.json") [3294f01](https://github.com/adobe/xdm/commit/3294f01075226fc8281bb23c6a1fd96ace64581c "Update aep-hygiene-ops-record.schema.json") [5bf390b](https://github.com/adobe/xdm/commit/5bf390b41feca1d7714ddb41004b11dfd91ba15e "Update aep-hygiene-ops-record.schema.json") [85a121c](https://github.com/adobe/xdm/commit/85a121cd0b12f5d4102d9e3c9bdb50e9e23beb4c "Adding the class for AEP  Hygiene and modified the hygiene ops fg") [a1014ba](https://github.com/adobe/xdm/commit/a1014ba101ef8da2c5ff963a7d54cdb6df69ff7f "Update aep-hygiene-ops-record.schema.json") [882d183](https://github.com/adobe/xdm/commit/882d18336f7eb0652a60eeb7526c9c95b8148fe2 "Changed field name case type") [3969f4f](https://github.com/adobe/xdm/commit/3969f4f33edda465172817cef3ecddf8ce115d58 "Address review comments") [f4ea0de](https://github.com/adobe/xdm/commit/f4ea0de2d23e49b890b15a0a5e2373fc38d03dd7 "Updated schema for fieldUpdate operation") [0e365e8](https://github.com/adobe/xdm/commit/0e365e8dff3ef32e8b87155b6bd7865d3d77c10e "more iterations") [2d60a59](https://github.com/adobe/xdm/commit/2d60a59ad9e6f4acf71e71b79bc7516bdab5e02b "Futher iteration of the schema") [6e093f5](https://github.com/adobe/xdm/commit/6e093f546f0ece4c883d88326a092bbd55e4010d "Futher iteration of the schema") [d16fd0f](https://github.com/adobe/xdm/commit/d16fd0f0ca8e8f54895c563c4802591f3bc95ca4 "fix schema errors") [e31ef53](https://github.com/adobe/xdm/commit/e31ef53663b1e1893da5c4440c0723122c749275 "Revised schema and added example files") [eaf7fcb](https://github.com/adobe/xdm/commit/eaf7fcb09af3c6648af56b8c44bcd4b70b1c2d3d "Moved to global schema location")|

diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.json b/docs/reference/adobe/experience/adcloud/campaign.schema.json
@@ -104,20 +104,6 @@
             "xdm:sampleGroupId": "8676378",
             "xdm:currency": "USD"
         },
-        {
-            "xdm:id": "100001061",
-            "xdm:campaignId": "10001234",
-            "xdm:campaignName": "My First Campaign",
-            "xdm:campaignDescription": "Branded Mobile Campaign",
-            "xdm:campaignStatus": "Active",
-            "xdm:channelType": "Search",
-            "xdm:budget": 123.45,
-            "xdm:budgetType": "Monthly",
-            "xdm.adDeliveryType": "Standard",
-            "xdm.CampaignObjective": "visit_web",
-            "repo:createDate": "2019-04-26T14:00:00+00:00",
-            "repo:modifyDate": "2019-04-26T14:00:00+00:00"
-        },
         {
             "@id": "12",
             "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor",
@@ -147,6 +133,20 @@
             "searchads.CampaignObjective": "visit_web",
             "repo:createDate": "2019-04-26T14:00:00+00:00",
             "repo:modifyDate": "2019-04-26T14:00:00+00:00"
+        },
+        {
+            "xdm:id": "100001061",
+            "xdm:campaignId": "10001234",
+            "xdm:campaignName": "My First Campaign",
+            "xdm:campaignDescription": "Branded Mobile Campaign",
+            "xdm:campaignStatus": "Active",
+            "xdm:channelType": "Search",
+            "xdm:budget": 123.45,
+            "xdm:budgetType": "Monthly",
+            "xdm.adDeliveryType": "Standard",
+            "xdm.CampaignObjective": "visit_web",
+            "repo:createDate": "2019-04-26T14:00:00+00:00",
+            "repo:modifyDate": "2019-04-26T14:00:00+00:00"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.md b/docs/reference/adobe/experience/adcloud/campaign.schema.md
@@ -27,23 +27,6 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
 }
 ```
 
-```json
-{
-  "xdm:id": "100001061",
-  "xdm:campaignId": "10001234",
-  "xdm:campaignName": "My First Campaign",
-  "xdm:campaignDescription": "Branded Mobile Campaign",
-  "xdm:campaignStatus": "Active",
-  "xdm:channelType": "Search",
-  "xdm:budget": 123.45,
-  "xdm:budgetType": "Monthly",
-  "xdm.adDeliveryType": "Standard",
-  "xdm.CampaignObjective": "visit_web",
-  "repo:createDate": "2019-04-26T14:00:00+00:00",
-  "repo:modifyDate": "2019-04-26T14:00:00+00:00"
-}
-```
-
 ```json
 {
   "@id": "12",
@@ -80,6 +63,23 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
 }
 ```
 
+```json
+{
+  "xdm:id": "100001061",
+  "xdm:campaignId": "10001234",
+  "xdm:campaignName": "My First Campaign",
+  "xdm:campaignDescription": "Branded Mobile Campaign",
+  "xdm:campaignStatus": "Active",
+  "xdm:channelType": "Search",
+  "xdm:budget": 123.45,
+  "xdm:budgetType": "Monthly",
+  "xdm.adDeliveryType": "Standard",
+  "xdm.CampaignObjective": "visit_web",
+  "repo:createDate": "2019-04-26T14:00:00+00:00",
+  "repo:modifyDate": "2019-04-26T14:00:00+00:00"
+}
+```
+
 
 # Ad Campaign Detail Properties
 

diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json
@@ -70,12 +70,6 @@
     "meta:titleId": "notificationsubscription##title##11091",
     "meta:descriptionId": "notificationsubscription##description##35941",
     "examples": [
-        {
-            "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
-            "xdm:type": "Campaign/SubscriptionList",
-            "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
-            "xdm:emailAddress": "[email protected]"
-        },
         {
             "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
             "xdm:type": "Campaign/SubscriptionList",
@@ -86,6 +80,12 @@
                 "xdm:remarkID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3be",
                 "xdm:remarkText": "Sorry, leave me alone. These are my personal comments"
             }
+        },
+        {
+            "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
+            "xdm:type": "Campaign/SubscriptionList",
+            "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
+            "xdm:emailAddress": "[email protected]"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md
@@ -20,15 +20,6 @@ Adobe Campaign notification subscriptions allow end-users opt into topics that c
 
 ## Notification Subscription Examples
 
-```json
-{
-  "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
-  "xdm:type": "Campaign/SubscriptionList",
-  "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
-  "xdm:emailAddress": "[email protected]"
-}
-```
-
 ```json
 {
   "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
@@ -43,6 +34,15 @@ Adobe Campaign notification subscriptions allow end-users opt into topics that c
 }
 ```
 
+```json
+{
+  "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
+  "xdm:type": "Campaign/SubscriptionList",
+  "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
+  "xdm:emailAddress": "[email protected]"
+}
+```
+
 
 # Notification Subscription Properties
 

diff --git a/docs/reference/adobe/experience/customerJourneyManagement/message-interaction.schema.json b/docs/reference/adobe/experience/customerJourneyManagement/message-interaction.schema.json
@@ -327,6 +327,20 @@
                 "xdm:activityID": "4567"
             }
         },
+        {
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "subscription",
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags": [
+                "marketing",
+                "apparel"
+            ],
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
+            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription": {
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionListID": "daily-news",
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/source": "landingPageId",
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/sourceType": "internal",
+                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionChoice": "yes"
+            }
+        },
         {
             "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "submit",
             "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/urlID": "123",
@@ -367,20 +381,6 @@
                     "Campaign_Id": "Nike@1234"
                 }
             }
-        },
-        {
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "subscription",
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags": [
-                "marketing",
-                "apparel"
-            ],
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
-            "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription": {
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionListID": "daily-news",
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/source": "landingPageId",
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/sourceType": "internal",
-                "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionChoice": "yes"
-            }
         }
     ]
 }
diff --git a/...erence/adobe/experience/customerJourneyManagement/message-interaction.schema.md b/...erence/adobe/experience/customerJourneyManagement/message-interaction.schema.md
@@ -40,6 +40,23 @@ Describes interaction made by the profile on the message.
 }
 ```
 
+```json
+{
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "subscription",
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags": [
+    "marketing",
+    "apparel"
+  ],
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
+  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription": {
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionListID": "daily-news",
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/source": "landingPageId",
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/sourceType": "internal",
+    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionChoice": "yes"
+  }
+}
+```
+
 ```json
 {
   "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "submit",
@@ -84,23 +101,6 @@ Describes interaction made by the profile on the message.
 }
 ```
 
-```json
-{
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/interactionType": "subscription",
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/tags": [
-    "marketing",
-    "apparel"
-  ],
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/label": "adobe.com",
-  "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription": {
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionListID": "daily-news",
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/source": "landingPageId",
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/sourceType": "internal",
-    "https://ns.adobe.com/experience/customerJourneyManagement/messageInteraction/subscription/subscriptionChoice": "yes"
-  }
-}
-```
-
 
 # Adobe CJM ExperienceEvent - Message interaction details Properties
 

diff --git a/docs/reference/adobe/experience/decisioning/activity.schema.json b/docs/reference/adobe/experience/decisioning/activity.schema.json
@@ -92,6 +92,14 @@
     "meta:titleId": "activity##title##64091",
     "meta:descriptionId": "activity##description##26151",
     "examples": [
+        {
+            "@id": "xcore:offer-activity:fd55d033fea4b82",
+            "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
+            "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
+            "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
+            "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
+            "https://ns.adobe.com/experience/decisioning/status": "draft"
+        },
         {
             "@id": "xcore:offer-activity:fd55d033fea4b82",
             "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
@@ -284,14 +292,6 @@
                     }
                 }
             ]
-        },
-        {
-            "@id": "xcore:offer-activity:fd55d033fea4b82",
-            "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
-            "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
-            "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
-            "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
-            "https://ns.adobe.com/experience/decisioning/status": "draft"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/decisioning/activity.schema.md b/docs/reference/adobe/experience/decisioning/activity.schema.md
@@ -18,6 +18,17 @@ Controls a decisioning process and describes some form of action that is planned
 
 ## Decision Activity Examples
 
+```json
+{
+  "@id": "xcore:offer-activity:fd55d033fea4b82",
+  "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
+  "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
+  "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
+  "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
+  "https://ns.adobe.com/experience/decisioning/status": "draft"
+}
+```
+
 ```json
 {
   "@id": "xcore:offer-activity:fd55d033fea4b82",
@@ -214,17 +225,6 @@ Controls a decisioning process and describes some form of action that is planned
 }
 ```
 
-```json
-{
-  "@id": "xcore:offer-activity:fd55d033fea4b82",
-  "https://ns.adobe.com/experience/decisioning/name": "In App Messages",
-  "https://ns.adobe.com/experience/decisioning/startDate": "2019-06-18T10:52:57.000Z",
-  "https://ns.adobe.com/experience/decisioning/endDate": "2019-09-01T00:00:00.000Z",
-  "https://ns.adobe.com/experience/decisioning/fallback": "xcore:fallback-offer:f6709ad4e7c0bac",
-  "https://ns.adobe.com/experience/decisioning/status": "draft"
-}
-```
-
 
 # Decision Activity Properties