chore: fix model docs formatting

fingerprintjs · Nov 18, 2024 · 0812c43 · 0812c43
1 parent a4085e7
commit 0812c43
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 4 deletions.
diff --git 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
@@ -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
@@ -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
@@ -1,7 +1,7 @@
 # {{classname}}
 
 {{#description}}
-{{{description}}}
+{{{unescapedDescription}}}
 {{/description}}
 
 ## Properties