Fix descriptions (remove extra line breaks, fix block styles)

.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.

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:

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.

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

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.

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.

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

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.       

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.

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

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

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

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:

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.

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

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.

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.

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.

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`.

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:

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.

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.

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.

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

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.

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.

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

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.

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.

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.

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.

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

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.