Skip to content

Commit ea3fc3a

Browse files
committed
fix: only escape < and > in docs
- Update the templates to use the unescaped version of a few variables to ensure that the generated .md files don't use unnecessary escape sequences.
1 parent c87df8c commit ea3fc3a

18 files changed

Lines changed: 102 additions & 65 deletions

docs/BotInfo.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ Extended bot information.
1010
|------------ | ------------- | ------------- | -------------|
1111
|**category** | **String** | The type and purpose of the bot. | |
1212
|**provider** | **String** | The organization or company operating the bot. | |
13-
|**providerUrl** | **String** | The URL of the bot provider&#39;s website. | [optional] |
13+
|**providerUrl** | **String** | The URL of the bot provider's website. | [optional] |
1414
|**name** | **String** | The specific name or identifier of the bot. | |
15-
|**identity** | [**IdentityEnum**](#IdentityEnum) | The verification status of the bot&#39;s identity: * &#x60;verified&#x60; - well-known bot with publicly verifiable identity, directed by the bot provider. * &#x60;signed&#x60; - bot that signs its platform via Web Bot Auth, directed by the bot provider’s customers. * &#x60;spoofed&#x60; - bot that claims a public identity but fails verification. * &#x60;unknown&#x60; - bot that does not publish a verifiable identity. | |
15+
|**identity** | [**IdentityEnum**](#IdentityEnum) | The verification status of the bot's identity: * `verified` - well-known bot with publicly verifiable identity, directed by the bot provider. * `signed` - bot that signs its platform via Web Bot Auth, directed by the bot provider’s customers. * `spoofed` - bot that claims a public identity but fails verification. * `unknown` - bot that does not publish a verifiable identity. | |
1616
|**confidence** | [**ConfidenceEnum**](#ConfidenceEnum) | Confidence level of the bot identification. | |
1717

1818

@@ -21,20 +21,20 @@ Extended bot information.
2121

2222
| Name | Value |
2323
|---- | -----|
24-
| VERIFIED | &quot;verified&quot; |
25-
| SIGNED | &quot;signed&quot; |
26-
| SPOOFED | &quot;spoofed&quot; |
27-
| UNKNOWN | &quot;unknown&quot; |
24+
| VERIFIED | "verified" |
25+
| SIGNED | "signed" |
26+
| SPOOFED | "spoofed" |
27+
| UNKNOWN | "unknown" |
2828

2929

3030

3131
## Enum: ConfidenceEnum
3232

3333
| Name | Value |
3434
|---- | -----|
35-
| LOW | &quot;low&quot; |
36-
| MEDIUM | &quot;medium&quot; |
37-
| HIGH | &quot;high&quot; |
35+
| LOW | "low" |
36+
| MEDIUM | "medium" |
37+
| HIGH | "high" |
3838

3939

4040

docs/Canvas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Canvas fingerprint containing winding flag plus geometry/text hashes.
99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
1111
|**winding** | **Boolean** | | [optional] |
12-
|**geometry** | **String** | Hash of geometry rendering output or &#x60;unsupported&#x60; markers. | [optional] |
13-
|**text** | **String** | Hash of text rendering output or &#x60;unsupported&#x60; markers. | [optional] |
12+
|**geometry** | **String** | Hash of geometry rendering output or `unsupported` markers. | [optional] |
13+
|**text** | **String** | Hash of text rendering output or `unsupported` markers. | [optional] |
1414

1515

1616

docs/Event.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8,53 +8,53 @@ Contains results from Fingerprint Identification and all active Smart Signals.
88

99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
11-
|**eventId** | **String** | Unique identifier of the user&#39;s request. The first portion of the event_id is a unix epoch milliseconds timestamp For example: &#x60;1758130560902.8tRtrH&#x60; | |
11+
|**eventId** | **String** | Unique identifier of the user's request. The first portion of the event_id is a unix epoch milliseconds timestamp For example: `1758130560902.8tRtrH` | |
1212
|**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. | |
1313
|**linkedId** | **String** | A customer-provided id that was sent with the request. | [optional] |
14-
|**environmentId** | **String** | Environment Id of the event. For example: &#x60;ae_47abaca3db2c7c43&#x60; | [optional] |
15-
|**suspect** | **Boolean** | Field is &#x60;true&#x60; if you have previously set the &#x60;suspect&#x60; flag for this event using the [Server API Update event endpoint](https://dev.fingerprint.com/reference/updateevent). | [optional] |
14+
|**environmentId** | **String** | Environment Id of the event. For example: `ae_47abaca3db2c7c43` | [optional] |
15+
|**suspect** | **Boolean** | Field is `true` if you have previously set the `suspect` flag for this event using the [Server API Update event endpoint](https://dev.fingerprint.com/reference/updateevent). | [optional] |
1616
|**sdk** | [**SDK**](SDK.md) | | [optional] |
17-
|**replayed** | **Boolean** | &#x60;true&#x60; if we determined that this payload was replayed, &#x60;false&#x60; otherwise. | [optional] |
17+
|**replayed** | **Boolean** | `true` if we determined that this payload was replayed, `false` otherwise. | [optional] |
1818
|**identification** | [**Identification**](Identification.md) | | [optional] |
1919
|**supplementaryIdHighRecall** | [**SupplementaryIDHighRecall**](SupplementaryIDHighRecall.md) | | [optional] |
2020
|**tags** | **Object** | A customer-provided value or an object that was sent with the identification request or updated later. | [optional] |
21-
|**url** | **String** | Page URL from which the request was sent. For example &#x60;https://example.com/&#x60; | [optional] |
22-
|**bundleId** | **String** | Bundle Id of the iOS application integrated with the Fingerprint SDK for the event. For example: &#x60;com.foo.app&#x60; | [optional] |
23-
|**packageName** | **String** | Package name of the Android application integrated with the Fingerprint SDK for the event. For example: &#x60;com.foo.app&#x60; | [optional] |
21+
|**url** | **String** | Page URL from which the request was sent. For example `https://example.com/` | [optional] |
22+
|**bundleId** | **String** | Bundle Id of the iOS application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` | [optional] |
23+
|**packageName** | **String** | Package name of the Android application integrated with the Fingerprint SDK for the event. For example: `com.foo.app` | [optional] |
2424
|**ipAddress** | **String** | IP address of the requesting browser or bot. | [optional] |
25-
|**userAgent** | **String** | User Agent of the client, for example: &#x60;Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....&#x60; | [optional] |
26-
|**clientReferrer** | **String** | Client Referrer field corresponds to the &#x60;document.referrer&#x60; field gathered during an identification request. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, by using a bookmark) For example: &#x60;https://example.com/blog/my-article&#x60; | [optional] |
25+
|**userAgent** | **String** | User Agent of the client, for example: `Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....` | [optional] |
26+
|**clientReferrer** | **String** | Client Referrer field corresponds to the `document.referrer` field gathered during an identification request. The value is an empty string if the user navigated to the page directly (not through a link, but, for example, by using a bookmark) For example: `https://example.com/blog/my-article` | [optional] |
2727
|**browserDetails** | [**BrowserDetails**](BrowserDetails.md) | | [optional] |
2828
|**proximity** | [**Proximity**](Proximity.md) | | [optional] |
2929
|**bot** | **BotResult** | | [optional] |
3030
|**botType** | **String** | Additional classification of the bot type if detected. | [optional] |
3131
|**botInfo** | [**BotInfo**](BotInfo.md) | | [optional] |
32-
|**clonedApp** | **Boolean** | Android specific cloned application detection. There are 2 values: * &#x60;true&#x60; - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). * &#x60;false&#x60; - No signs of cloned application detected or the client is not Android. | [optional] |
33-
|**developerTools** | **Boolean** | &#x60;true&#x60; if the browser is Chrome with DevTools open or Firefox with Developer Tools open, &#x60;false&#x60; otherwise. | [optional] |
34-
|**emulator** | **Boolean** | Android specific emulator detection. There are 2 values: * &#x60;true&#x60; - Emulated environment detected (e.g. launch inside of AVD). * &#x60;false&#x60; - No signs of emulated environment detected or the client is not Android. | [optional] |
32+
|**clonedApp** | **Boolean** | Android specific cloned application detection. There are 2 values: * `true` - Presence of app cloners work detected (e.g. fully cloned application found or launch of it inside of a not main working profile detected). * `false` - No signs of cloned application detected or the client is not Android. | [optional] |
33+
|**developerTools** | **Boolean** | `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise. | [optional] |
34+
|**emulator** | **Boolean** | Android specific emulator detection. There are 2 values: * `true` - Emulated environment detected (e.g. launch inside of AVD). * `false` - No signs of emulated environment detected or the client is not Android. | [optional] |
3535
|**factoryResetTimestamp** | **Long** | The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time. When a factory reset cannot be detected on the mobile device or when the request is initiated from a browser, this field will correspond to the *epoch* time (i.e 1 Jan 1970 UTC) as a value of 0. See [Factory Reset Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection) to learn more about this Smart Signal. | [optional] |
36-
|**frida** | **Boolean** | [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values: * &#x60;true&#x60; - Frida detected * &#x60;false&#x60; - No signs of Frida or the client is not a mobile device. | [optional] |
36+
|**frida** | **Boolean** | [Frida](https://frida.re/docs/) detection for Android and iOS devices. There are 2 values: * `true` - Frida detected * `false` - No signs of Frida or the client is not a mobile device. | [optional] |
3737
|**ipBlocklist** | [**IPBlockList**](IPBlockList.md) | | [optional] |
3838
|**ipInfo** | [**IPInfo**](IPInfo.md) | | [optional] |
3939
|**proxy** | **Boolean** | IP address was used by a public proxy provider or belonged to a known recent residential proxy | [optional] |
4040
|**proxyConfidence** | **ProxyConfidence** | | [optional] |
4141
|**proxyDetails** | [**ProxyDetails**](ProxyDetails.md) | | [optional] |
42-
|**incognito** | **Boolean** | &#x60;true&#x60; if we detected incognito mode used in the browser, &#x60;false&#x60; otherwise. | [optional] |
43-
|**jailbroken** | **Boolean** | iOS specific jailbreak detection. There are 2 values: * &#x60;true&#x60; - Jailbreak detected. * &#x60;false&#x60; - No signs of jailbreak or the client is not iOS. | [optional] |
42+
|**incognito** | **Boolean** | `true` if we detected incognito mode used in the browser, `false` otherwise. | [optional] |
43+
|**jailbroken** | **Boolean** | iOS specific jailbreak detection. There are 2 values: * `true` - Jailbreak detected. * `false` - No signs of jailbreak or the client is not iOS. | [optional] |
4444
|**locationSpoofing** | **Boolean** | Flag indicating whether the request came from a mobile device with location spoofing enabled. | [optional] |
45-
|**mitmAttack** | **Boolean** | * &#x60;true&#x60; - When requests made from your users&#39; mobile devices to Fingerprint servers have been intercepted and potentially modified. * &#x60;false&#x60; - Otherwise or when the request originated from a browser. See [MitM Attack Detection](https://dev.fingerprint.com/docs/smart-signals-reference#mitm-attack-detection) to learn more about this Smart Signal. | [optional] |
46-
|**privacySettings** | **Boolean** | &#x60;true&#x60; if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise &#x60;false&#x60;. | [optional] |
47-
|**rootApps** | **Boolean** | Android specific root management apps detection. There are 2 values: * &#x60;true&#x60; - Root Management Apps detected (e.g. Magisk). * &#x60;false&#x60; - No Root Management Apps detected or the client isn&#39;t Android. | [optional] |
45+
|**mitmAttack** | **Boolean** | * `true` - When requests made from your users' mobile devices to Fingerprint servers have been intercepted and potentially modified. * `false` - Otherwise or when the request originated from a browser. See [MitM Attack Detection](https://dev.fingerprint.com/docs/smart-signals-reference#mitm-attack-detection) to learn more about this Smart Signal. | [optional] |
46+
|**privacySettings** | **Boolean** | `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`. | [optional] |
47+
|**rootApps** | **Boolean** | Android specific root management apps detection. There are 2 values: * `true` - Root Management Apps detected (e.g. Magisk). * `false` - No Root Management Apps detected or the client isn't Android. | [optional] |
4848
|**ruleAction** | [**EventRuleAction**](EventRuleAction.md) | | [optional] |
4949
|**suspectScore** | **Integer** | Suspect Score is an easy way to integrate Smart Signals into your fraud protection work flow. It is a weighted representation of all Smart Signals present in the payload that helps identify suspicious activity. The value range is [0; S] where S is sum of all Smart Signals weights. See more details here: https://dev.fingerprint.com/docs/suspect-score | [optional] |
50-
|**tampering** | **Boolean** | Flag indicating browser tampering was detected. This happens when either: * There are inconsistencies in the browser configuration that cross internal tampering thresholds (see &#x60;tampering_details.anomaly_score&#x60;). * The browser signature resembles an \&quot;anti-detect\&quot; browser specifically designed to evade fingerprinting (see &#x60;tampering_details.anti_detect_browser&#x60;). | [optional] |
50+
|**tampering** | **Boolean** | Flag indicating browser tampering was detected. This happens when either: * There are inconsistencies in the browser configuration that cross internal tampering thresholds (see `tampering_details.anomaly_score`). * The browser signature resembles an \"anti-detect\" browser specifically designed to evade fingerprinting (see `tampering_details.anti_detect_browser`). | [optional] |
5151
|**tamperingDetails** | [**TamperingDetails**](TamperingDetails.md) | | [optional] |
5252
|**velocity** | [**Velocity**](Velocity.md) | | [optional] |
53-
|**virtualMachine** | **Boolean** | &#x60;true&#x60; if the request came from a browser running inside a virtual machine (e.g. VMWare), &#x60;false&#x60; otherwise. | [optional] |
53+
|**virtualMachine** | **Boolean** | `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. | [optional] |
5454
|**vpn** | **Boolean** | VPN or other anonymizing service has been used when sending the request. | [optional] |
5555
|**vpnConfidence** | **VpnConfidence** | | [optional] |
5656
|**vpnOriginTimezone** | **String** | Local timezone which is used in timezone_mismatch method. | [optional] |
57-
|**vpnOriginCountry** | **String** | Country of the request (only for Android SDK version &gt;&#x3D; 2.4.0, ISO 3166 format or unknown). | [optional] |
57+
|**vpnOriginCountry** | **String** | Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). | [optional] |
5858
|**vpnMethods** | [**VpnMethods**](VpnMethods.md) | | [optional] |
5959
|**highActivityDevice** | **Boolean** | Flag indicating if the request came from a high-activity visitor. | [optional] |
6060
|**rawDeviceAttributes** | [**RawDeviceAttributes**](RawDeviceAttributes.md) | | [optional] |

docs/EventSearch.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Contains a list of all identification events matching the specified search crite
99
| Name | Type | Description | Notes |
1010
|------------ | ------------- | ------------- | -------------|
1111
|**events** | [**List&lt;Event&gt;**](Event.md) | | |
12-
|**paginationKey** | **String** | Use this value in the &#x60;pagination_key&#x60; parameter to request the next page of search results. | [optional] |
13-
|**totalHits** | **Long** | This value represents the total number of events matching the search query, up to the limit provided in the &#x60;total_hits&#x60; query parameter. Only present if the &#x60;total_hits&#x60; query parameter was provided. | [optional] |
12+
|**paginationKey** | **String** | Use this value in the `pagination_key` parameter to request the next page of search results. | [optional] |
13+
|**totalHits** | **Long** | This value represents the total number of events matching the search query, up to the limit provided in the `total_hits` query parameter. Only present if the `total_hits` query parameter was provided. | [optional] |
1414

1515

1616

docs/FingerprintApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ null (empty response body)
104104
| **200** | OK. The visitor ID is scheduled for deletion. | - |
105105
| **400** | Bad request. The visitor ID parameter is missing or in the wrong format. | - |
106106
| **403** | Forbidden. Access to this API is denied. | - |
107-
| **404** | Not found. The visitor ID cannot be found in this workspace&#39;s data. | - |
107+
| **404** | Not found. The visitor ID cannot be found in this workspace's data. | - |
108108
| **429** | Too Many Requests. The request is throttled. | - |
109109

110110

@@ -193,7 +193,7 @@ Object containing optional parameters for API method. Supports a fluent interfac
193193
| **200** | OK. | - |
194194
| **400** | Bad request. The event Id provided is not valid. | - |
195195
| **403** | Forbidden. Access to this API is denied. | - |
196-
| **404** | Not found. The event Id cannot be found in this workspace&#39;s data. | - |
196+
| **404** | Not found. The event Id cannot be found in this workspace's data. | - |
197197
| **429** | Too Many Requests. The request is throttled. | - |
198198
| **500** | Workspace error. | - |
199199

@@ -497,6 +497,6 @@ null (empty response body)
497497
| **200** | OK. | - |
498498
| **400** | Bad request. The request payload is not valid. | - |
499499
| **403** | Forbidden. Access to this API is denied. | - |
500-
| **404** | Not found. The event Id cannot be found in this workspace&#39;s data. | - |
500+
| **404** | Not found. The event Id cannot be found in this workspace's data. | - |
501501
| **409** | Conflict. The event is not mutable yet. | - |
502502

docs/Identification.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
|**visitorId** | **String** | String of 20 characters that uniquely identifies the visitor&#39;s browser or mobile device. | |
10+
|**visitorId** | **String** | String of 20 characters that uniquely identifies the visitor's browser or mobile device. | |
1111
|**confidence** | [**IdentificationConfidence**](IdentificationConfidence.md) | | [optional] |
1212
|**visitorFound** | **Boolean** | Attribute represents if a visitor had been identified before. | |
13-
|**firstSeenAt** | **Long** | Unix epoch time milliseconds timestamp indicating the time at which this visitor ID was first seen. example: &#x60;1758069706642&#x60; - Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000 | [optional] |
14-
|**lastSeenAt** | **Long** | Unix epoch time milliseconds timestamp indicating the time at which this visitor ID was last seen. example: &#x60;1758069706642&#x60; - Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000 | [optional] |
13+
|**firstSeenAt** | **Long** | Unix epoch time milliseconds timestamp indicating the time at which this visitor ID was first seen. example: `1758069706642` - Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000 | [optional] |
14+
|**lastSeenAt** | **Long** | Unix epoch time milliseconds timestamp indicating the time at which this visitor ID was last seen. example: `1758069706642` - Corresponding to Wed Sep 17 2025 00:41:46 GMT+0000 | [optional] |
1515

1616

1717

docs/Integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
| Name | Type | Description | Notes |
99
|------------ | ------------- | ------------- | -------------|
10-
|**name** | **String** | The name of the specific integration, e.g. \&quot;fingerprint-pro-react\&quot;. | [optional] |
11-
|**version** | **String** | The version of the specific integration, e.g. \&quot;3.11.10\&quot;. | [optional] |
10+
|**name** | **String** | The name of the specific integration, e.g. \"fingerprint-pro-react\". | [optional] |
11+
|**version** | **String** | The version of the specific integration, e.g. \"3.11.10\". | [optional] |
1212
|**subintegration** | [**IntegrationSubintegration**](IntegrationSubintegration.md) | | [optional] |
1313

1414

0 commit comments

Comments
 (0)