Skip to content

Commit

Permalink
TM-13283 Update Tag Manager API docs - Release 18.7.0
Browse files Browse the repository at this point in the history 
- added documentation for new trigger type: capturing click
  • Loading branch information
@musial-adam
musial-adam committed Nov 27, 2023
1 parent 7f6171f commit 853b772
Show file tree
Hide file tree
Showing 16 changed files with 190 additions and 7 deletions.
2 changes: 1 addition & 1 deletion tag_manager/authorized_api/src/operations/example/get/operations_get_response_example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"source_trigger_id": "81dde686-86f3-432a-a08f-bfcf796d36fb",
"target_trigger_id": "11c32a79-5409-4427-9809-7ce1937fd401",
"source_name": "Trigger name",
"target_name": "Trigger name - copy",
"target_name": "Trigger name (copy)",
"is_renamed": true
}
],
Expand Down
2 changes: 1 addition & 1 deletion tag_manager/authorized_api/src/tags/example/copy/tags_copy_request_example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "78e49d2b-4d55-4a6b-af8e-67eaea2cbad1",
"type": "tag",
"attributes": {
"name": "Tag - copy",
"name": "Tag (copy)",
"with_triggers": false
},
"relationships": {
Expand Down
2 changes: 1 addition & 1 deletion tag_manager/authorized_api/src/tags/schema/tag_types.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
},
"tag_new_identifier": {
"$ref": "../../common/schema/common_types.json#/definitions/uuid",
"description": "New tag's identifier"
"description": "New tag's identifier. Forbidden in the case of overwriting tags in other apps."
},
"tag_new_name": {
"$ref": "../../common/schema/common_types.json#/definitions/name",
Expand Down
2 changes: 1 addition & 1 deletion tag_manager/authorized_api/src/triggers/example/copy/triggers_copy_request_example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "12e11cbe-16f4-43b7-93ee-10795ccda34e",
"type": "trigger",
"attributes": {
"name": "Trigger - copy"
"name": "Trigger (copy)"
},
"relationships": {
"target_app": {
Expand Down
2 changes: 1 addition & 1 deletion tag_manager/authorized_api/src/triggers/example/copy/triggers_copy_response_example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "12e11cbe-16f4-43b7-93ee-10795ccda34e",
"type": "trigger",
"attributes": {
"name": "Trigger - copy"
"name": "Trigger (copy)"
},
"relationships": {
"operation": {
Expand Down
45 changes: 45 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/create/request/capturing_click_schema.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"description": "Create trigger request",
"type": "object",
"properties": {
"data": {
"title": "JSON:API 1.0 request data",
"type": "object",
"properties": {
"id": {"$ref": "../../trigger_types.json#/definitions/trigger_identifier"},
"type": {"$ref": "../../trigger_types.json#/definitions/trigger_resource_type"},
"attributes": {
"type": "object",
"description": "Trigger attributes",
"properties": {
"name": {"$ref": "../../trigger_attributes.json#/definitions/trigger_name_attribute"},
"trigger_type": {"$ref": "../../trigger_type_attributes.json#/definitions/capturing_click_trigger_type_attribute"},
"conditions": {"$ref": "../../trigger_attributes.json#/definitions/trigger_conditions_attribute_create_edit"}
},
"required": ["name", "trigger_type", "conditions"],
"additionalProperties": false
},
"relationships": {
"allOf": [
{
"$ref": "../../trigger_types.json#/definitions/relationships_description"
},
{
"type": "object",
"properties": {
"tags": {
"$ref": "../../trigger_types.json#/definitions/tag_relationship"
}
},
"additionalProperties": false
}
]
}
},
"required": ["type", "attributes"],
"additionalProperties": false
}
},
"required": ["data"],
"additionalProperties": false
}
4 changes: 4 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/create/triggers_create_request_schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
"$ref": "request/click_schema.json",
"title": "click"
},
{
"$ref": "request/capturing_click_schema.json",
"title": "capturing_click"
},
{
"$ref": "request/element_presence_schema.json",
"title": "element_presence"
Expand Down
4 changes: 4 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/create/triggers_create_response_schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
"$ref": "../get/response/click_schema.json",
"title": "click"
},
{
"$ref": "../get/response/capturing_click_schema.json",
"title": "capturing_click"
},
{
"$ref": "../get/response/element_presence_schema.json",
"title": "element_presence"
Expand Down
44 changes: 44 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/edit/request/capturing_click_schema.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"description": "Edit trigger request",
"type": "object",
"properties": {
"data": {
"title": "JSON:API 1.0 request data",
"type": "object",
"properties": {
"id": {"$ref": "../../trigger_types.json#/definitions/trigger_identifier"},
"type": {"$ref": "../../trigger_types.json#/definitions/trigger_resource_type"},
"attributes": {
"type": "object",
"description": "Trigger attributes",
"properties": {
"name": {"$ref": "../../trigger_attributes.json#/definitions/trigger_name_attribute"},
"trigger_type": {"$ref": "../../trigger_type_attributes.json#/definitions/capturing_click_trigger_type_attribute"},
"conditions": {"$ref": "../../trigger_attributes.json#/definitions/trigger_conditions_attribute_create_edit"}
},
"additionalProperties": false
},
"relationships": {
"allOf": [
{
"$ref": "../../trigger_types.json#/definitions/relationships_description"
},
{
"type": "object",
"properties": {
"tags": {
"$ref": "../../trigger_types.json#/definitions/tag_relationship"
}
},
"additionalProperties": false
}
]
}
},
"required": ["id", "type"],
"additionalProperties": false
}
},
"required": ["data"],
"additionalProperties": false
}
4 changes: 4 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/edit/triggers_edit_request_schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
"$ref": "request/click_schema.json",
"title": "click"
},
{
"$ref": "request/capturing_click_schema.json",
"title": "capturing_click"
},
{
"$ref": "request/element_presence_schema.json",
"title": "element_presence"
Expand Down
71 changes: 71 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/get/response/capturing_click_schema.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"type": "object",
"properties": {
"data": {
"title": "JSON:API 1.0 response data",
"type": "object",
"properties": {
"id": {"$ref": "../../trigger_types.json#/definitions/trigger_identifier"},
"type": {"$ref": "../../trigger_types.json#/definitions/trigger_resource_type"},
"meta": {
"type": "object",
"description": "Trigger meta data",
"properties": {
"has_abandoned_conditions": {"$ref": "../../trigger_attributes.json#/definitions/trigger_has_abandoned_conditions_meta"},
"has_conditions_with_abandoned_variable": {"$ref": "../../trigger_attributes.json#/definitions/trigger_has_conditions_with_abandoned_variable_meta"}
},
"required": ["has_abandoned_conditions", "has_conditions_with_abandoned_variable"],
"additionalProperties": false
},
"attributes": {
"type": "object",
"description": "Trigger attributes",
"properties": {
"name": {"$ref": "../../trigger_attributes.json#/definitions/trigger_name_attribute"},
"trigger_type": {"$ref": "../../trigger_type_attributes.json#/definitions/capturing_click_trigger_type_attribute"},
"is_published": {"$ref": "../../trigger_attributes.json#/definitions/trigger_is_published_attribute"},
"conditions": {"$ref": "../../trigger_attributes.json#/definitions/trigger_conditions_attribute_get"},
"created_at": {"$ref": "../../../../common/schema/common_types.json#/definitions/datetime"},
"updated_at": {"$ref": "../../../../common/schema/common_types.json#/definitions/datetime"}
},
"required": ["name", "trigger_type", "is_published", "conditions", "created_at", "updated_at"],
"additionalProperties": false
},
"relationships": {
"type": "object",
"description": "Trigger relationships",
"properties": {
"tags": {
"type": "object",
"description": "Related tags",
"properties": {
"data": {
"title": "JSON:API 1.0 relationship data",
"type": "array",
"description": "Tag resource identifiers",
"items": {
"type": "object",
"properties": {
"id": {"$ref": "../../../../tags/schema/tag_types.json#/definitions/tag_identifier"},
"type": {"$ref": "../../../../tags/schema/tag_types.json#/definitions/tag_resource_type"}
},
"required": ["id", "type"],
"additionalProperties": false
}
}
},
"required": ["data"],
"additionalProperties": false
}
},
"required": ["tags"],
"additionalProperties": false
}
},
"required": ["id", "type", "meta", "attributes", "relationships"],
"additionalProperties": false
}
},
"required": ["data"],
"additionalProperties": false
}
4 changes: 4 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/get/triggers_get_response_schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@
"$ref": "../get/response/click_schema.json",
"title": "click"
},
{
"$ref": "../get/response/capturing_click_schema.json",
"title": "capturing_click"
},
{
"$ref": "../get/response/element_presence_schema.json",
"title": "element_presence"
Expand Down
2 changes: 2 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/trigger_attributes.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
"debounced_history",
"form_submission",
"click",
"capturing_click",
"element_presence",
"cdp_audience_detection",
"abandoned"
Expand All @@ -38,6 +39,7 @@
"debounced_history",
"form_submission",
"click",
"capturing_click",
"element_presence",
"cdp_audience_detection"
],
Expand Down
5 changes: 5 additions & 0 deletions tag_manager/authorized_api/src/triggers/schema/trigger_type_attributes.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@
"enum": ["click"],
"description": "Trigger click type"
},
"capturing_click_trigger_type_attribute": {
"type": "string",
"enum": ["capturing_click"],
"description": "Trigger capturing_click type"
},
"element_presence_trigger_type_attribute": {
"type": "string",
"enum": ["element_presence"],
Expand Down
2 changes: 1 addition & 1 deletion tag_manager/authorized_api/src/variables/example/copy/variables_copy_request_example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "677423b3-e529-4e03-88fd-d3b9dcacf2cf",
"type": "variable",
"attributes": {
"name": "New variable - copy"
"name": "New variable (copy)"
},
"relationships": {
"target_app": {
Expand Down
2 changes: 1 addition & 1 deletion tag_manager/authorized_api/src/variables/example/copy/variables_copy_response_example.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"id": "21b27740-6cef-438f-860d-a2f9adb9e4a8",
"type": "variable",
"attributes": {
"name": "New variable - copy"
"name": "New variable (copy)"
},
"relationships": {
"operation": {
Expand Down

0 comments on commit 853b772

Please sign in to comment.