fix: remove wrong documentation links (swagger-codegen bug)

fingerprintjs · Apr 25, 2023 · ae5b376 · ae5b376
1 parent 7dd69c4
commit ae5b376
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 12 deletions.
diff --git a/build.gradle b/build.gradle
@@ -129,3 +129,16 @@ description = "Run the Functional Tests"
 classpath = sourceSets.main.runtimeClasspath
 main = 'com.fingerprint.example.FunctionalTests'
 }
+
+task removeWrongDocumentationLinks {
+    doLast {
+        fileTree("./docs").visit { FileVisitDetails details ->
+            if (details.file.isFile()) {
+                def fileContents = details.file.text
+                fileContents = fileContents.replace("[**OffsetDateTime**](OffsetDateTime.md)", "OffsetDateTime")
+                fileContents = fileContents.replace("[**URI**](URI.md)", "URI")
+                details.file.text = fileContents
+            }
+        }
+    }
+}
diff --git a/docs/BotdResult.md b/docs/BotdResult.md
@@ -9,7 +9,7 @@ Contains all the information from Bot Detection product
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
 |**ip** | **String** | IP address of the requesting browser or bot. |  |
-|**time** | [**OffsetDateTime**](OffsetDateTime.md) | 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 |  |
+|**time** | OffsetDateTime | 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 |  |
 |**url** | **String** | Page URL from which identification request was sent. |  |
 |**bot** | [**BotdDetectionResult**](BotdDetectionResult.md) |  |  |
 

diff --git a/docs/ProductsResponseIdentificationData.md b/docs/ProductsResponseIdentificationData.md
@@ -13,8 +13,8 @@
 |**ip** | **String** |  |  |
 |**ipLocation** | [**IPLocation**](IPLocation.md) |  |  |
 |**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. |  |
-|**time** | [**OffsetDateTime**](OffsetDateTime.md) | Time expressed according to ISO 8601 in UTC format. |  |
-|**url** | [**URI**](URI.md) | Page URL from which identification request was sent. |  |
+|**time** | OffsetDateTime | Time expressed according to ISO 8601 in UTC format. |  |
+|**url** | URI | Page URL from which identification request was sent. |  |
 |**tag** | **Map&lt;String, Object&gt;** | A customer-provided value or an object that was sent with identification request. |  [optional] |
 |**linkedId** | **String** | A customer-provided id that was sent with identification request. |  [optional] |
 |**confidence** | [**Confidence**](Confidence.md) |  |  |

diff --git a/docs/ResponseVisits.md b/docs/ResponseVisits.md
@@ -13,8 +13,8 @@
 |**ip** | **String** |  |  |
 |**ipLocation** | [**IPLocation**](IPLocation.md) |  |  |
 |**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. |  |
-|**time** | [**OffsetDateTime**](OffsetDateTime.md) | Time expressed according to ISO 8601 in UTC format. |  |
-|**url** | [**URI**](URI.md) | Page URL from which identification request was sent. |  |
+|**time** | OffsetDateTime | Time expressed according to ISO 8601 in UTC format. |  |
+|**url** | URI | Page URL from which identification request was sent. |  |
 |**tag** | **Map&lt;String, Object&gt;** | A customer-provided value or an object that was sent with identification request. |  |
 |**linkedId** | **String** | A customer-provided id that was sent with identification request. |  [optional] |
 |**confidence** | [**Confidence**](Confidence.md) |  |  |

diff --git a/docs/SeenAt.md b/docs/SeenAt.md
@@ -7,8 +7,8 @@
 
 | Name | Type | Description | Notes |
 |------------ | ------------- | ------------- | -------------|
-|**global** | [**OffsetDateTime**](OffsetDateTime.md) |  |  |
-|**subscription** | [**OffsetDateTime**](OffsetDateTime.md) |  |  |
+|**global** | OffsetDateTime |  |  |
+|**subscription** | OffsetDateTime |  |  |
 
 
 
diff --git a/docs/Visit.md b/docs/Visit.md
@@ -13,8 +13,8 @@
 |**ip** | **String** |  |  |
 |**ipLocation** | [**IPLocation**](IPLocation.md) |  |  |
 |**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. |  |
-|**time** | [**OffsetDateTime**](OffsetDateTime.md) | Time expressed according to ISO 8601 in UTC format. |  |
-|**url** | [**URI**](URI.md) | Page URL from which identification request was sent. |  |
+|**time** | OffsetDateTime | Time expressed according to ISO 8601 in UTC format. |  |
+|**url** | URI | Page URL from which identification request was sent. |  |
 |**tag** | **Map&lt;String, Object&gt;** | A customer-provided value or an object that was sent with identification request. |  [optional] |
 |**linkedId** | **String** | A customer-provided id that was sent with identification request. |  [optional] |
 |**confidence** | [**Confidence**](Confidence.md) |  |  |

diff --git a/docs/WebhookVisit.md b/docs/WebhookVisit.md
@@ -15,8 +15,8 @@
 |**ip** | **String** |  |  |
 |**ipLocation** | [**IPLocation**](IPLocation.md) |  |  |
 |**timestamp** | **Long** | Timestamp of the event with millisecond precision in Unix time. |  |
-|**time** | [**OffsetDateTime**](OffsetDateTime.md) | Time expressed according to ISO 8601 in UTC format. |  |
-|**url** | [**URI**](URI.md) | Page URL from which identification request was sent. |  |
+|**time** | OffsetDateTime | Time expressed according to ISO 8601 in UTC format. |  |
+|**url** | URI | Page URL from which identification request was sent. |  |
 |**tag** | **Map&lt;String, Object&gt;** | A customer-provided value or an object that was sent with identification request. |  [optional] |
 |**linkedId** | **String** | A customer-provided id that was sent with identification request. |  [optional] |
 |**confidence** | [**Confidence**](Confidence.md) |  |  |

diff --git a/scripts/generate.sh b/scripts/generate.sh
@@ -25,4 +25,6 @@ sed -i "s/artifactVersion: .*/artifactVersion: $VERSION/g" config.yaml
 
 rm -rf pom.xml README.md build.gradle settings.gradle gradle.properties
 
-java -jar ./bin/generator.jar generate -c config.yaml -g java --library jersey2 -i res/fingerprint-server-api.yaml --skip-validate-spec -o . -t template
+java -jar ./bin/generator.jar generate -c config.yaml -g java --library jersey2 -i res/fingerprint-server-api.yaml --skip-validate-spec -o . -t template
+
+./gradlew removeWrongDocumentationLinks
diff --git a/template/libraries/jersey2/build.gradle.mustache b/template/libraries/jersey2/build.gradle.mustache
@@ -148,3 +148,16 @@ description = "Run the Functional Tests"
 classpath = sourceSets.main.runtimeClasspath
 main = 'com.fingerprint.example.FunctionalTests'
 }
+
+task removeWrongDocumentationLinks {
+    doLast {
+        fileTree("./docs").visit { FileVisitDetails details ->
+            if (details.file.isFile()) {
+                def fileContents = details.file.text
+                fileContents = fileContents.replace("[**OffsetDateTime**](OffsetDateTime.md)", "OffsetDateTime")
+                fileContents = fileContents.replace("[**URI**](URI.md)", "URI")
+                details.file.text = fileContents
+            }
+        }
+    }
+}