From 467bf02d56c84b0af0bf0e5260937a63e24fa4b6 Mon Sep 17 00:00:00 2001 From: Nikolai Viktorov Date: Mon, 21 Oct 2024 18:26:36 +0700 Subject: [PATCH] Fix descriptions (remove extra line breaks, fix block styles) --- .changeset/short-icons-wish.md | 8 ++++++++ schemas/components/schemas/Botd.yaml | 3 +-- schemas/components/schemas/ClonedApp.yaml | 10 ++++------ .../schemas/DeprecatedGeolocation.yaml | 10 +++------- schemas/components/schemas/DeveloperTools.yaml | 3 +-- schemas/components/schemas/Emulator.yaml | 8 ++++---- .../components/schemas/EventsGetResponse.yaml | 3 +-- schemas/components/schemas/FactoryReset.yaml | 18 ++++++------------ schemas/components/schemas/Frida.yaml | 8 ++++---- schemas/components/schemas/Geolocation.yaml | 3 +-- schemas/components/schemas/HighActivity.yaml | 2 +- schemas/components/schemas/IPBlocklist.yaml | 3 +-- schemas/components/schemas/IPInfo.yaml | 3 +-- schemas/components/schemas/Identification.yaml | 7 ++----- .../schemas/IdentificationConfidence.yaml | 6 ++---- schemas/components/schemas/Incognito.yaml | 3 +-- schemas/components/schemas/Jailbroken.yaml | 7 ++++--- .../components/schemas/LocationSpoofing.yaml | 3 +-- .../components/schemas/PrivacySettings.yaml | 3 +-- schemas/components/schemas/Products.yaml | 3 +-- schemas/components/schemas/Proxy.yaml | 3 +-- schemas/components/schemas/RemoteControl.yaml | 3 +-- schemas/components/schemas/RootApps.yaml | 8 ++++---- schemas/components/schemas/Tag.yaml | 3 +-- schemas/components/schemas/Tampering.yaml | 11 +++++++---- schemas/components/schemas/Tor.yaml | 3 +-- schemas/components/schemas/VPN.yaml | 4 +--- schemas/components/schemas/VPNMethods.yaml | 10 +++------- .../components/schemas/VelocityIntervals.yaml | 3 +-- schemas/components/schemas/VirtualMachine.yaml | 3 +-- schemas/components/schemas/Visit.yaml | 5 ++--- .../schemas/VisitorsGetResponse.yaml | 3 +-- schemas/components/schemas/Webhook.yaml | 7 ++----- .../components/schemas/WebhookClonedApp.yaml | 10 ++++------ .../schemas/WebhookDeveloperTools.yaml | 3 +-- .../components/schemas/WebhookEmulator.yaml | 8 ++++---- .../schemas/WebhookFactoryReset.yaml | 18 ++++++------------ schemas/components/schemas/WebhookFrida.yaml | 8 ++++---- .../schemas/WebhookHighActivity.yaml | 2 +- .../components/schemas/WebhookIPBlocklist.yaml | 3 +-- schemas/components/schemas/WebhookIPInfo.yaml | 3 +-- .../components/schemas/WebhookJailbroken.yaml | 7 ++++--- .../schemas/WebhookLocationSpoofing.yaml | 3 +-- .../schemas/WebhookPrivacySettings.yaml | 3 +-- schemas/components/schemas/WebhookProxy.yaml | 3 +-- .../schemas/WebhookRemoteControl.yaml | 3 +-- .../components/schemas/WebhookRootApps.yaml | 8 ++++---- .../components/schemas/WebhookTampering.yaml | 8 +++++--- schemas/components/schemas/WebhookTor.yaml | 3 +-- schemas/components/schemas/WebhookVPN.yaml | 4 +--- .../schemas/WebhookVirtualMachine.yaml | 3 +-- schemas/paths/events.yaml | 4 ++-- schemas/paths/related-visitors.yaml | 2 +- schemas/paths/visitors.yaml | 8 ++++---- 54 files changed, 123 insertions(+), 171 deletions(-) create mode 100644 .changeset/short-icons-wish.md diff --git a/.changeset/short-icons-wish.md b/.changeset/short-icons-wish.md new file mode 100644 index 0000000..bf88b3f --- /dev/null +++ b/.changeset/short-icons-wish.md @@ -0,0 +1,8 @@ +--- +'fingerprint-pro-server-api-openapi': patch +--- + +- Fix descriptions formatting: + - Remove extra line breaks. + - Fix block styles. +- Fix links in descriptions. \ No newline at end of file diff --git a/schemas/components/schemas/Botd.yaml b/schemas/components/schemas/Botd.yaml index 5684a3f..1f99b43 100644 --- a/schemas/components/schemas/Botd.yaml +++ b/schemas/components/schemas/Botd.yaml @@ -28,8 +28,7 @@ properties: format: date-time description: >- Time in UTC when the request from the JS agent was made. We recommend to - treat requests that are older than 2 minutes as malicious. Otherwise, - request replay attacks are possible + treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible. userAgent: type: string requestId: diff --git a/schemas/components/schemas/ClonedApp.yaml b/schemas/components/schemas/ClonedApp.yaml index d0f1cc9..ac9f6be 100644 --- a/schemas/components/schemas/ClonedApp.yaml +++ b/schemas/components/schemas/ClonedApp.yaml @@ -5,9 +5,7 @@ required: properties: result: type: boolean - description: > - 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. + description: | + 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. diff --git a/schemas/components/schemas/DeprecatedGeolocation.yaml b/schemas/components/schemas/DeprecatedGeolocation.yaml index 5dfc738..e88ea87 100644 --- a/schemas/components/schemas/DeprecatedGeolocation.yaml +++ b/schemas/components/schemas/DeprecatedGeolocation.yaml @@ -1,19 +1,15 @@ deprecated: true type: object description: >- - This field is **deprecated** and will not return a result for - **applications created after January 23rd, 2024**. Please use the [IP - Geolocation Smart - signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) - for geolocation information. + This field is **deprecated** and will not return a result for **applications created after January 23rd, 2024**. + Please use the [IP Geolocation Smart signal](https://dev.fingerprint.com/docs/smart-signals-overview#ip-geolocation) for geolocation information. additionalProperties: false properties: accuracyRadius: type: integer minimum: 0 description: >- - The IP address is likely to be within this radius (in km) of the specified - location. + The IP address is likely to be within this radius (in km) of the specified location. latitude: type: number format: double diff --git a/schemas/components/schemas/DeveloperTools.yaml b/schemas/components/schemas/DeveloperTools.yaml index a4e2db4..1001e35 100644 --- a/schemas/components/schemas/DeveloperTools.yaml +++ b/schemas/components/schemas/DeveloperTools.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: > - `true` if the browser is Chrome with DevTools open or Firefox with - Developer Tools open, `false` otherwise. + `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise. diff --git a/schemas/components/schemas/Emulator.yaml b/schemas/components/schemas/Emulator.yaml index 5d512af..833d872 100644 --- a/schemas/components/schemas/Emulator.yaml +++ b/schemas/components/schemas/Emulator.yaml @@ -5,7 +5,7 @@ required: properties: result: type: boolean - description: > - 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. + description: | + 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. diff --git a/schemas/components/schemas/EventsGetResponse.yaml b/schemas/components/schemas/EventsGetResponse.yaml index 6067e01..90c577b 100644 --- a/schemas/components/schemas/EventsGetResponse.yaml +++ b/schemas/components/schemas/EventsGetResponse.yaml @@ -1,7 +1,6 @@ type: object description: >- - Contains results from all activated products - Fingerprint Pro, Bot Detection, - and others. + Contains results from all activated products - Fingerprint Pro, Bot Detection, and others. additionalProperties: false required: - products diff --git a/schemas/components/schemas/FactoryReset.yaml b/schemas/components/schemas/FactoryReset.yaml index 71e07f9..ccdefed 100644 --- a/schemas/components/schemas/FactoryReset.yaml +++ b/schemas/components/schemas/FactoryReset.yaml @@ -8,22 +8,16 @@ properties: type: string format: date-time description: > - Indicates the time (in UTC) of the most recent factory reset that happened - on the **mobile device**. + Indicates the time (in UTC) of the most recent factory reset that happened on the **mobile device**. - 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). + 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). - See [Factory Reset - Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection) - to learn more about this Smart Signal. + See [Factory Reset Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection) to learn more about this Smart Signal. timestamp: type: integer format: int64 description: > - This field is just another representation of the value in the `time` - field. + This field is just another representation of the value in the `time` field. - The time of the most recent factory reset that happened on the **mobile - device** is expressed as Unix epoch time. + The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time. diff --git a/schemas/components/schemas/Frida.yaml b/schemas/components/schemas/Frida.yaml index 7a275b8..66769da 100644 --- a/schemas/components/schemas/Frida.yaml +++ b/schemas/components/schemas/Frida.yaml @@ -5,7 +5,7 @@ required: properties: result: type: boolean - description: > - [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. + description: | + [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. diff --git a/schemas/components/schemas/Geolocation.yaml b/schemas/components/schemas/Geolocation.yaml index 5ebe493..42b46ee 100644 --- a/schemas/components/schemas/Geolocation.yaml +++ b/schemas/components/schemas/Geolocation.yaml @@ -5,8 +5,7 @@ properties: type: integer minimum: 0 description: >- - The IP address is likely to be within this radius (in km) of the specified - location. + The IP address is likely to be within this radius (in km) of the specified location. latitude: type: number format: double diff --git a/schemas/components/schemas/HighActivity.yaml b/schemas/components/schemas/HighActivity.yaml index 7ead2c1..76f3ecd 100644 --- a/schemas/components/schemas/HighActivity.yaml +++ b/schemas/components/schemas/HighActivity.yaml @@ -5,7 +5,7 @@ required: properties: result: type: boolean - description: Flag indicating whether the request came from a high activity visitor. + description: Flag indicating if the request came from a high-activity visitor. dailyRequests: type: integer format: int64 diff --git a/schemas/components/schemas/IPBlocklist.yaml b/schemas/components/schemas/IPBlocklist.yaml index 29197b0..d04fd28 100644 --- a/schemas/components/schemas/IPBlocklist.yaml +++ b/schemas/components/schemas/IPBlocklist.yaml @@ -7,7 +7,6 @@ properties: result: type: boolean description: > - `true` if request IP address is part of any database that we use to search - for known malicious actors, `false` otherwise. + `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise. details: $ref: IPBlocklistDetails.yaml diff --git a/schemas/components/schemas/IPInfo.yaml b/schemas/components/schemas/IPInfo.yaml index 998fc9a..fb3eb0d 100644 --- a/schemas/components/schemas/IPInfo.yaml +++ b/schemas/components/schemas/IPInfo.yaml @@ -1,7 +1,6 @@ type: object description: >- - Details about the request IP address. Has separate fields for v4 and v6 IP - address versions. + Details about the request IP address. Has separate fields for v4 and v6 IP address versions. additionalProperties: false properties: v4: diff --git a/schemas/components/schemas/Identification.yaml b/schemas/components/schemas/Identification.yaml index 41bb43f..e4c12ca 100644 --- a/schemas/components/schemas/Identification.yaml +++ b/schemas/components/schemas/Identification.yaml @@ -16,9 +16,7 @@ required: properties: visitorId: type: string - description: > - String of 20 characters that uniquely identifies the visitor's - browser. + description: String of 20 characters that uniquely identifies the visitor's browser. requestId: type: string description: Unique identifier of the user's request. @@ -45,8 +43,7 @@ properties: format: date-time description: >- Time expressed according to ISO 8601 in UTC format, when the request from the JS agent was made. We recommend to - treat requests that are older than 2 minutes as malicious. Otherwise, - request replay attacks are possible + treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible. url: type: string description: Page URL from which the request was sent. diff --git a/schemas/components/schemas/IdentificationConfidence.yaml b/schemas/components/schemas/IdentificationConfidence.yaml index b30239f..ca26ccb 100644 --- a/schemas/components/schemas/IdentificationConfidence.yaml +++ b/schemas/components/schemas/IdentificationConfidence.yaml @@ -9,13 +9,11 @@ properties: minimum: 0 maximum: 1 description: >- - The confidence score is a floating-point number between 0 and 1 that - represents the probability of accurate identification. + The confidence score is a floating-point number between 0 and 1 that represents the probability of accurate identification. revision: type: string description: >- The revision name of the method used to calculate the Confidence score. - This field is only present for customers who opted in to an alternative - calculation method. + This field is only present for customers who opted in to an alternative calculation method. comment: type: string diff --git a/schemas/components/schemas/Incognito.yaml b/schemas/components/schemas/Incognito.yaml index 7848c57..46be469 100644 --- a/schemas/components/schemas/Incognito.yaml +++ b/schemas/components/schemas/Incognito.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: > - `true` if we detected incognito mode used in the browser, `false` - otherwise. + `true` if we detected incognito mode used in the browser, `false` otherwise. diff --git a/schemas/components/schemas/Jailbroken.yaml b/schemas/components/schemas/Jailbroken.yaml index a1cfde9..12979db 100644 --- a/schemas/components/schemas/Jailbroken.yaml +++ b/schemas/components/schemas/Jailbroken.yaml @@ -5,6 +5,7 @@ required: properties: result: type: boolean - description: > - iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak - detected • `false` - No signs of jailbreak or the client is not iOS. + description: | + iOS specific jailbreak detection. There are 2 values: + * `true` - Jailbreak detected. + * `false` - No signs of jailbreak or the client is not iOS. diff --git a/schemas/components/schemas/LocationSpoofing.yaml b/schemas/components/schemas/LocationSpoofing.yaml index 37f7f13..6a5c51f 100644 --- a/schemas/components/schemas/LocationSpoofing.yaml +++ b/schemas/components/schemas/LocationSpoofing.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: >- - Flag indicating whether the request came from a mobile device with - location spoofing enabled. + Flag indicating whether the request came from a mobile device with location spoofing enabled. diff --git a/schemas/components/schemas/PrivacySettings.yaml b/schemas/components/schemas/PrivacySettings.yaml index c4c014d..ca2149e 100644 --- a/schemas/components/schemas/PrivacySettings.yaml +++ b/schemas/components/schemas/PrivacySettings.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: > - `true` if the request is from a privacy aware browser (e.g. Tor) or from a - browser in which fingerprinting is blocked. Otherwise `false`. + `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`. diff --git a/schemas/components/schemas/Products.yaml b/schemas/components/schemas/Products.yaml index cc5ad44..4d5819b 100644 --- a/schemas/components/schemas/Products.yaml +++ b/schemas/components/schemas/Products.yaml @@ -1,7 +1,6 @@ type: object description: >- - Contains all information about the request identified by `requestId`, - depending on the pricing plan (Pro, Pro Plus, Enterprise) + Contains all information about the request identified by `requestId`, depending on the pricing plan (Pro, Pro Plus, Enterprise) additionalProperties: false properties: identification: diff --git a/schemas/components/schemas/Proxy.yaml b/schemas/components/schemas/Proxy.yaml index b844408..2e5d5b2 100644 --- a/schemas/components/schemas/Proxy.yaml +++ b/schemas/components/schemas/Proxy.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: > - `true` if the request IP address is used by a public proxy provider, - `false` otherwise. + `true` if the request IP address is used by a public proxy provider, `false` otherwise. diff --git a/schemas/components/schemas/RemoteControl.yaml b/schemas/components/schemas/RemoteControl.yaml index 397d29c..09f7dc5 100644 --- a/schemas/components/schemas/RemoteControl.yaml +++ b/schemas/components/schemas/RemoteControl.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: > - `true` if the request came from a machine being remotely controlled (e.g. - TeamViewer), `false` otherwise. + `true` if the request came from a machine being remotely controlled (e.g. TeamViewer), `false` otherwise. diff --git a/schemas/components/schemas/RootApps.yaml b/schemas/components/schemas/RootApps.yaml index 8f4fc60..874ddd7 100644 --- a/schemas/components/schemas/RootApps.yaml +++ b/schemas/components/schemas/RootApps.yaml @@ -5,7 +5,7 @@ required: properties: result: type: boolean - description: > - 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. + description: | + 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. diff --git a/schemas/components/schemas/Tag.yaml b/schemas/components/schemas/Tag.yaml index 15d467c..c691115 100644 --- a/schemas/components/schemas/Tag.yaml +++ b/schemas/components/schemas/Tag.yaml @@ -1,5 +1,4 @@ type: object description: >- - A customer-provided value or an object that was sent with identification - request. + A customer-provided value or an object that was sent with identification request. additionalProperties: true \ No newline at end of file diff --git a/schemas/components/schemas/Tampering.yaml b/schemas/components/schemas/Tampering.yaml index a1db010..dc1cdf8 100644 --- a/schemas/components/schemas/Tampering.yaml +++ b/schemas/components/schemas/Tampering.yaml @@ -7,7 +7,7 @@ required: properties: result: type: boolean - description: >- + description: | Flag indicating browser tampering was detected. This happens when either of these conditions is true: * There are inconsistencies in the browser configuration that cross our internal tampering thresholds (indicated by `anomalyScore`). * The browser signature resembles one of "anti-detect" browsers specifically designed to evade identification and fingerprinting, for example, Incognition (indicated by `antiDetectBrowser`). @@ -16,9 +16,12 @@ properties: format: double minimum: 0 maximum: 1 - description: >- - Confidence score (`0.0 - 1.0`) for tampering detection. Values above `0.5` indicate that there was a tampering attempt. Values below `0.5` indicate genuine browsers. + description: | + Confidence score (`0.0 - 1.0`) for tampering detection: + * Values above `0.5` indicate that there was a tampering attempt. + * Values below `0.5` indicate genuine browsers. antiDetectBrowser: type: boolean description: >- - Is `true` if the identified browser resembles one of "anti-detect" browsers, for example, Incognition. Anti-detect browsers try to evade identification by masking or manipulating their fingerprint to imitate legitimate browser configurations. + Is `true` if the identified browser resembles one of "anti-detect" browsers, for example, Incognition. + Anti-detect browsers try to evade identification by masking or manipulating their fingerprint to imitate legitimate browser configurations. diff --git a/schemas/components/schemas/Tor.yaml b/schemas/components/schemas/Tor.yaml index ed36d59..698c3cb 100644 --- a/schemas/components/schemas/Tor.yaml +++ b/schemas/components/schemas/Tor.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: > - `true` if the request IP address is a known tor exit node, `false` - otherwise. + `true` if the request IP address is a known tor exit node, `false` otherwise. diff --git a/schemas/components/schemas/VPN.yaml b/schemas/components/schemas/VPN.yaml index 82fb4e0..73e1dd4 100644 --- a/schemas/components/schemas/VPN.yaml +++ b/schemas/components/schemas/VPN.yaml @@ -17,8 +17,6 @@ properties: description: Local timezone which is used in timezoneMismatch method. originCountry: type: string - description: >- - Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 - format or unknown). + description: Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). methods: $ref: VPNMethods.yaml diff --git a/schemas/components/schemas/VPNMethods.yaml b/schemas/components/schemas/VPNMethods.yaml index 0906859..1534e4c 100644 --- a/schemas/components/schemas/VPNMethods.yaml +++ b/schemas/components/schemas/VPNMethods.yaml @@ -8,19 +8,15 @@ required: properties: timezoneMismatch: type: boolean - description: >- - The browser timezone doesn't match the timezone inferred from the - request IP address. + description: The browser timezone doesn't match the timezone inferred from the request IP address. publicVPN: type: boolean description: Request IP address is owned and used by a public VPN service provider. auxiliaryMobile: type: boolean description: >- - This method applies to mobile devices only. Indicates the result of - additional methods used to detect a VPN in mobile devices. + This method applies to mobile devices only. Indicates the result of additional methods used to detect a VPN in mobile devices. osMismatch: type: boolean description: >- - The browser runs on a different operating system than the operating - system inferred from the request network signature. + The browser runs on a different operating system than the operating system inferred from the request network signature. diff --git a/schemas/components/schemas/VelocityIntervals.yaml b/schemas/components/schemas/VelocityIntervals.yaml index b74dafb..50c8099 100644 --- a/schemas/components/schemas/VelocityIntervals.yaml +++ b/schemas/components/schemas/VelocityIntervals.yaml @@ -15,5 +15,4 @@ properties: description: > 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. + visitor ID in the last 24 hours (`events.intervals.['24h']`) is higher than 20.000. diff --git a/schemas/components/schemas/VirtualMachine.yaml b/schemas/components/schemas/VirtualMachine.yaml index e464a96..c7e5f25 100644 --- a/schemas/components/schemas/VirtualMachine.yaml +++ b/schemas/components/schemas/VirtualMachine.yaml @@ -6,5 +6,4 @@ properties: result: type: boolean description: > - `true` if the request came from a browser running inside a virtual machine - (e.g. VMWare), `false` otherwise. + `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. diff --git a/schemas/components/schemas/Visit.yaml b/schemas/components/schemas/Visit.yaml index ddb600a..0b1aeaf 100644 --- a/schemas/components/schemas/Visit.yaml +++ b/schemas/components/schemas/Visit.yaml @@ -38,9 +38,8 @@ properties: type: string format: date-time description: >- - Time expressed according to ISO 8601 in UTC format, when the request from the JS agent was made. We recommend to - treat requests that are older than 2 minutes as malicious. Otherwise, - request replay attacks are possible + Time expressed according to ISO 8601 in UTC format, when the request from the client agent was made. We recommend to + treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible. url: type: string description: Page URL from which the request was sent. diff --git a/schemas/components/schemas/VisitorsGetResponse.yaml b/schemas/components/schemas/VisitorsGetResponse.yaml index a020dae..39142e4 100644 --- a/schemas/components/schemas/VisitorsGetResponse.yaml +++ b/schemas/components/schemas/VisitorsGetResponse.yaml @@ -1,7 +1,6 @@ type: object description: >- - Fields `lastTimestamp` and `paginationKey` added when `limit` or `before` - parameter provided and there is more data to show + Pagination-related fields `lastTimestamp` and `paginationKey` are included if you use a pagination parameter like `limit` or `before` and there is more data available on the next page. additionalProperties: false required: - visitorId diff --git a/schemas/components/schemas/Webhook.yaml b/schemas/components/schemas/Webhook.yaml index 1730548..0e4612b 100644 --- a/schemas/components/schemas/Webhook.yaml +++ b/schemas/components/schemas/Webhook.yaml @@ -23,8 +23,7 @@ properties: format: date-time description: >- Time expressed according to ISO 8601 in UTC format, when the request from the JS agent was made. We recommend to - treat requests that are older than 2 minutes as malicious. Otherwise, - request replay attacks are possible + treat requests that are older than 2 minutes as malicious. Otherwise, request replay attacks are possible. timestamp: type: integer format: int64 @@ -36,9 +35,7 @@ properties: description: A customer-provided id that was sent with the request. visitorId: type: string - description: > - String of 20 characters that uniquely identifies the visitor's - browser. + description: String of 20 characters that uniquely identifies the visitor's browser. visitorFound: type: boolean description: Attribute represents if a visitor had been identified before. diff --git a/schemas/components/schemas/WebhookClonedApp.yaml b/schemas/components/schemas/WebhookClonedApp.yaml index 8b6effb..12f95f9 100644 --- a/schemas/components/schemas/WebhookClonedApp.yaml +++ b/schemas/components/schemas/WebhookClonedApp.yaml @@ -3,9 +3,7 @@ additionalProperties: false properties: result: type: boolean - description: > - 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. + description: | + 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. diff --git a/schemas/components/schemas/WebhookDeveloperTools.yaml b/schemas/components/schemas/WebhookDeveloperTools.yaml index fe18b54..41feff0 100644 --- a/schemas/components/schemas/WebhookDeveloperTools.yaml +++ b/schemas/components/schemas/WebhookDeveloperTools.yaml @@ -4,5 +4,4 @@ properties: result: type: boolean description: > - `true` if the browser is Chrome with DevTools open or Firefox with - Developer Tools open, `false` otherwise. + `true` if the browser is Chrome with DevTools open or Firefox with Developer Tools open, `false` otherwise. diff --git a/schemas/components/schemas/WebhookEmulator.yaml b/schemas/components/schemas/WebhookEmulator.yaml index 51ff102..e379b49 100644 --- a/schemas/components/schemas/WebhookEmulator.yaml +++ b/schemas/components/schemas/WebhookEmulator.yaml @@ -3,7 +3,7 @@ additionalProperties: false properties: result: type: boolean - description: > - 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. + description: | + 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. diff --git a/schemas/components/schemas/WebhookFactoryReset.yaml b/schemas/components/schemas/WebhookFactoryReset.yaml index 8e08078..211566d 100644 --- a/schemas/components/schemas/WebhookFactoryReset.yaml +++ b/schemas/components/schemas/WebhookFactoryReset.yaml @@ -5,22 +5,16 @@ properties: type: string format: date-time description: > - Indicates the time (in UTC) of the most recent factory reset that happened - on the **mobile device**. + Indicates the time (in UTC) of the most recent factory reset that happened on the **mobile device**. - 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). + 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). - See [Factory Reset - Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection) - to learn more about this Smart Signal. + See [Factory Reset Detection](https://dev.fingerprint.com/docs/smart-signals-overview#factory-reset-detection) to learn more about this Smart Signal. timestamp: type: integer format: int64 description: > - This field is just another representation of the value in the `time` - field. + This field is just another representation of the value in the `time` field. - The time of the most recent factory reset that happened on the **mobile - device** is expressed as Unix epoch time. + The time of the most recent factory reset that happened on the **mobile device** is expressed as Unix epoch time. diff --git a/schemas/components/schemas/WebhookFrida.yaml b/schemas/components/schemas/WebhookFrida.yaml index 3b0b619..fd3cce4 100644 --- a/schemas/components/schemas/WebhookFrida.yaml +++ b/schemas/components/schemas/WebhookFrida.yaml @@ -3,7 +3,7 @@ additionalProperties: false properties: result: type: boolean - description: > - [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. + description: | + [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. diff --git a/schemas/components/schemas/WebhookHighActivity.yaml b/schemas/components/schemas/WebhookHighActivity.yaml index 7ead2c1..76f3ecd 100644 --- a/schemas/components/schemas/WebhookHighActivity.yaml +++ b/schemas/components/schemas/WebhookHighActivity.yaml @@ -5,7 +5,7 @@ required: properties: result: type: boolean - description: Flag indicating whether the request came from a high activity visitor. + description: Flag indicating if the request came from a high-activity visitor. dailyRequests: type: integer format: int64 diff --git a/schemas/components/schemas/WebhookIPBlocklist.yaml b/schemas/components/schemas/WebhookIPBlocklist.yaml index d15c973..5525a0b 100644 --- a/schemas/components/schemas/WebhookIPBlocklist.yaml +++ b/schemas/components/schemas/WebhookIPBlocklist.yaml @@ -4,7 +4,6 @@ properties: result: type: boolean description: > - `true` if request IP address is part of any database that we use to search - for known malicious actors, `false` otherwise. + `true` if request IP address is part of any database that we use to search for known malicious actors, `false` otherwise. details: $ref: IPBlocklistDetails.yaml diff --git a/schemas/components/schemas/WebhookIPInfo.yaml b/schemas/components/schemas/WebhookIPInfo.yaml index 998fc9a..fb3eb0d 100644 --- a/schemas/components/schemas/WebhookIPInfo.yaml +++ b/schemas/components/schemas/WebhookIPInfo.yaml @@ -1,7 +1,6 @@ type: object description: >- - Details about the request IP address. Has separate fields for v4 and v6 IP - address versions. + Details about the request IP address. Has separate fields for v4 and v6 IP address versions. additionalProperties: false properties: v4: diff --git a/schemas/components/schemas/WebhookJailbroken.yaml b/schemas/components/schemas/WebhookJailbroken.yaml index d836fb6..8e430d9 100644 --- a/schemas/components/schemas/WebhookJailbroken.yaml +++ b/schemas/components/schemas/WebhookJailbroken.yaml @@ -3,6 +3,7 @@ additionalProperties: false properties: result: type: boolean - description: > - iOS specific jailbreak detection. There are 2 values: • `true` - Jailbreak - detected • `false` - No signs of jailbreak or the client is not iOS. + description: | + iOS specific jailbreak detection. There are 2 values: + * `true` - Jailbreak detected. + * `false` - No signs of jailbreak or the client is not iOS. diff --git a/schemas/components/schemas/WebhookLocationSpoofing.yaml b/schemas/components/schemas/WebhookLocationSpoofing.yaml index cbe79c3..3e0971f 100644 --- a/schemas/components/schemas/WebhookLocationSpoofing.yaml +++ b/schemas/components/schemas/WebhookLocationSpoofing.yaml @@ -4,5 +4,4 @@ properties: result: type: boolean description: >- - Flag indicating whether the request came from a mobile device with - location spoofing enabled. + Flag indicating whether the request came from a mobile device with location spoofing enabled. diff --git a/schemas/components/schemas/WebhookPrivacySettings.yaml b/schemas/components/schemas/WebhookPrivacySettings.yaml index ce783c6..54f200c 100644 --- a/schemas/components/schemas/WebhookPrivacySettings.yaml +++ b/schemas/components/schemas/WebhookPrivacySettings.yaml @@ -4,5 +4,4 @@ properties: result: type: boolean description: > - `true` if the request is from a privacy aware browser (e.g. Tor) or from a - browser in which fingerprinting is blocked. Otherwise `false`. + `true` if the request is from a privacy aware browser (e.g. Tor) or from a browser in which fingerprinting is blocked. Otherwise `false`. diff --git a/schemas/components/schemas/WebhookProxy.yaml b/schemas/components/schemas/WebhookProxy.yaml index df97239..1fc18d3 100644 --- a/schemas/components/schemas/WebhookProxy.yaml +++ b/schemas/components/schemas/WebhookProxy.yaml @@ -4,5 +4,4 @@ properties: result: type: boolean description: > - `true` if the request IP address is used by a public proxy provider, - `false` otherwise. + `true` if the request IP address is used by a public proxy provider, `false` otherwise. diff --git a/schemas/components/schemas/WebhookRemoteControl.yaml b/schemas/components/schemas/WebhookRemoteControl.yaml index 4cbe4fa..4b20185 100644 --- a/schemas/components/schemas/WebhookRemoteControl.yaml +++ b/schemas/components/schemas/WebhookRemoteControl.yaml @@ -4,5 +4,4 @@ properties: result: type: boolean description: > - `true` if the request came from a machine being remotely controlled (e.g. - TeamViewer), `false` otherwise. + `true` if the request came from a machine being remotely controlled (e.g. TeamViewer), `false` otherwise. diff --git a/schemas/components/schemas/WebhookRootApps.yaml b/schemas/components/schemas/WebhookRootApps.yaml index a90330b..b9cb414 100644 --- a/schemas/components/schemas/WebhookRootApps.yaml +++ b/schemas/components/schemas/WebhookRootApps.yaml @@ -3,7 +3,7 @@ additionalProperties: false properties: result: type: boolean - description: > - 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. + description: | + 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. diff --git a/schemas/components/schemas/WebhookTampering.yaml b/schemas/components/schemas/WebhookTampering.yaml index dde2733..67b4777 100644 --- a/schemas/components/schemas/WebhookTampering.yaml +++ b/schemas/components/schemas/WebhookTampering.yaml @@ -3,7 +3,7 @@ additionalProperties: false properties: result: type: boolean - description: >- + description: | Flag indicating browser tampering was detected. This happens when either of these conditions is true: * There are inconsistencies in the browser configuration that cross our internal tampering thresholds (indicated by `anomalyScore`). * The browser signature resembles one of "anti-detect" browsers specifically designed to evade identification and fingerprinting, for example, Incognition (indicated by `antiDetectBrowser`). @@ -12,8 +12,10 @@ properties: format: double minimum: 0 maximum: 1 - description: >- - Confidence score (`0.0 - 1.0`) for tampering detection. Values above `0.5` indicate that there was a tampering attempt. Values below `0.5` indicate genuine browsers. + description: | + Confidence score (`0.0 - 1.0`) for tampering detection: + * Values above `0.5` indicate that there was a tampering attempt + * Values below `0.5` indicate genuine browsers. antiDetectBrowser: type: boolean description: >- diff --git a/schemas/components/schemas/WebhookTor.yaml b/schemas/components/schemas/WebhookTor.yaml index 209da5f..1f4cf10 100644 --- a/schemas/components/schemas/WebhookTor.yaml +++ b/schemas/components/schemas/WebhookTor.yaml @@ -4,5 +4,4 @@ properties: result: type: boolean description: > - `true` if the request IP address is a known tor exit node, `false` - otherwise. + `true` if the request IP address is a known tor exit node, `false` otherwise. diff --git a/schemas/components/schemas/WebhookVPN.yaml b/schemas/components/schemas/WebhookVPN.yaml index 53cd1eb..066fbb1 100644 --- a/schemas/components/schemas/WebhookVPN.yaml +++ b/schemas/components/schemas/WebhookVPN.yaml @@ -11,8 +11,6 @@ properties: description: Local timezone which is used in timezoneMismatch method. originCountry: type: string - description: >- - Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 - format or unknown). + description: Country of the request (only for Android SDK version >= 2.4.0, ISO 3166 format or unknown). methods: $ref: VPNMethods.yaml diff --git a/schemas/components/schemas/WebhookVirtualMachine.yaml b/schemas/components/schemas/WebhookVirtualMachine.yaml index a70463d..a6dbe3e 100644 --- a/schemas/components/schemas/WebhookVirtualMachine.yaml +++ b/schemas/components/schemas/WebhookVirtualMachine.yaml @@ -4,5 +4,4 @@ properties: result: type: boolean description: > - `true` if the request came from a browser running inside a virtual machine - (e.g. VMWare), `false` otherwise. + `true` if the request came from a browser running inside a virtual machine (e.g. VMWare), `false` otherwise. diff --git a/schemas/paths/events.yaml b/schemas/paths/events.yaml index d9e8da8..5d24064 100644 --- a/schemas/paths/events.yaml +++ b/schemas/paths/events.yaml @@ -15,7 +15,7 @@ get: required: true schema: type: string - description: The unique [identifier](https://dev.fingerprint.com/docs/js-agent#requestid) of each identification request. + description: The unique [identifier](https://dev.fingerprint.com/reference/get-function#requestid) of each identification request. responses: '200': description: OK. @@ -82,7 +82,7 @@ put: required: true schema: type: string - description: The unique event [identifier](https://dev.fingerprint.com/docs/js-agent#requestid). + description: The unique event [identifier](https://dev.fingerprint.com/reference/get-function#requestid). requestBody: required: true content: diff --git a/schemas/paths/related-visitors.yaml b/schemas/paths/related-visitors.yaml index ffd7dbc..263c505 100644 --- a/schemas/paths/related-visitors.yaml +++ b/schemas/paths/related-visitors.yaml @@ -17,7 +17,7 @@ get: required: true schema: type: string - description: The [visitor ID](https://dev.fingerprint.com/docs/js-agent#visitorid) for which you want to find the other visitor IDs that originated from the same mobile device. + description: The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) for which you want to find the other visitor IDs that originated from the same mobile device. responses: '200': description: OK. diff --git a/schemas/paths/visitors.yaml b/schemas/paths/visitors.yaml index 6377b2d..760fb99 100644 --- a/schemas/paths/visitors.yaml +++ b/schemas/paths/visitors.yaml @@ -16,7 +16,7 @@ get: required: true schema: type: string - description: Unique [visitor identifier](https://dev.fingerprint.com/docs/js-agent#visitorid) issued by Fingerprint Pro. + description: Unique [visitor identifier](https://dev.fingerprint.com/reference/get-function#visitorid) issued by Fingerprint Pro. # example: uYIm7Ksp5rf00SllPhFp - name: request_id in: query @@ -25,7 +25,7 @@ get: description: | Filter visits by `requestId`. - Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/docs/js-agent#requestid). When you filter visits by `requestId`, only one visit will be returned. + Every identification request has a unique identifier associated with it called `requestId`. This identifier is returned to the client in the identification [result](https://dev.fingerprint.com/reference/get-function#requestid). When you filter visits by `requestId`, only one visit will be returned. # example: 1654815516083.OX6kx8 - name: linked_id in: query @@ -34,7 +34,7 @@ get: description: | Filter visits by your custom identifier. - You can use [`linkedId`](https://dev.fingerprint.com/docs/js-agent#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier. + You can use [`linkedId`](https://dev.fingerprint.com/reference/get-function#linkedid) to associate identification requests with your own identifier, for example: session ID, purchase ID, or transaction ID. You can then use this `linked_id` parameter to retrieve all events associated with your custom identifier. # example: some_id - name: limit in: query @@ -160,7 +160,7 @@ delete: required: true schema: type: string - description: The [visitor ID](https://dev.fingerprint.com/docs/js-agent#visitorid) you want to delete. + description: The [visitor ID](https://dev.fingerprint.com/reference/get-function#visitorid) you want to delete. responses: '200': description: OK. The visitor ID is scheduled for deletion.