From 0812c433b0ca08349b7e214030c45857ecc6d451 Mon Sep 17 00:00:00 2001 From: Ilya Taratukhin Date: Mon, 18 Nov 2024 17:12:18 +0100 Subject: [PATCH] chore: fix model docs formatting --- docs/Velocity.md | 17 ++++++++++++++++- docs/VelocityIntervals.md | 3 ++- docs/WebhookVelocity.md | 17 ++++++++++++++++- template/pojo_doc.mustache | 2 +- 4 files changed, 35 insertions(+), 4 deletions(-) diff --git a/docs/Velocity.md b/docs/Velocity.md index 2343fc65..47962ed0 100644 --- a/docs/Velocity.md +++ b/docs/Velocity.md @@ -2,7 +2,22 @@ # Velocity -Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor ID. - Number of distinct linked IDs associated with the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of identification events associated with the visitor ID. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked ID. - Number of distinct visitor IDs associated with the provided linked ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000. +Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time +intervals: 5 minutes, 1 hour, and 24 hours as follows: + +- Number of distinct IP addresses associated to the visitor ID. +- Number of distinct linked IDs associated with the visitor ID. +- Number of distinct countries associated with the visitor ID. +- Number of identification events associated with the visitor ID. +- Number of identification events associated with the detected IP address. +- Number of distinct IP addresses associated with the provided linked ID. +- Number of distinct visitor IDs associated with the provided linked ID. + +The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, +`distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted +if the number of `events` for the visitor ID in the last 24 +hours (`events.intervals.['24h']`) is higher than 20.000. + ## Properties diff --git a/docs/VelocityIntervals.md b/docs/VelocityIntervals.md index e4ed630e..41a688d7 100644 --- a/docs/VelocityIntervals.md +++ b/docs/VelocityIntervals.md @@ -2,7 +2,8 @@ # VelocityIntervals -Is absent if the velocity data could not be generated for the visitor ID. +Is absent if the velocity data could not be generated for the visitor ID. + ## Properties diff --git a/docs/WebhookVelocity.md b/docs/WebhookVelocity.md index 41c49475..841b5997 100644 --- a/docs/WebhookVelocity.md +++ b/docs/WebhookVelocity.md @@ -2,7 +2,22 @@ # WebhookVelocity -Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time intervals: 5 minutes, 1 hour, and 24 hours as follows: - Number of distinct IP addresses associated to the visitor ID. - Number of distinct linked IDs associated with the visitor ID. - Number of distinct countries associated with the visitor ID. - Number of identification events associated with the visitor ID. - Number of identification events associated with the detected IP address. - Number of distinct IP addresses associated with the provided linked ID. - Number of distinct visitor IDs associated with the provided linked ID. The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, `distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted if the number of `events` for the visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000. +Sums key data points for a specific `visitorId`, `ipAddress` and `linkedId` at three distinct time +intervals: 5 minutes, 1 hour, and 24 hours as follows: + +- Number of distinct IP addresses associated to the visitor ID. +- Number of distinct linked IDs associated with the visitor ID. +- Number of distinct countries associated with the visitor ID. +- Number of identification events associated with the visitor ID. +- Number of identification events associated with the detected IP address. +- Number of distinct IP addresses associated with the provided linked ID. +- Number of distinct visitor IDs associated with the provided linked ID. + +The `24h` interval of `distinctIp`, `distinctLinkedId`, `distinctCountry`, +`distinctIpByLinkedId` and `distinctVisitorIdByLinkedId` will be omitted +if the number of `events` for the visitor ID in the last 24 +hours (`events.intervals.['24h']`) is higher than 20.000. + ## Properties diff --git a/template/pojo_doc.mustache b/template/pojo_doc.mustache index 99f6613c..ee0791bf 100644 --- a/template/pojo_doc.mustache +++ b/template/pojo_doc.mustache @@ -1,7 +1,7 @@ # {{classname}} {{#description}} -{{{description}}} +{{{unescapedDescription}}} {{/description}} ## Properties