chore: add description to enum docs

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

Hide file tree

Showing 4 changed files with 35 additions and 0 deletions.
diff --git a/docs/BotdBotResult.md b/docs/BotdBotResult.md
@@ -1,6 +1,11 @@
 
 
 # BotdBotResult
+    Bot detection result:
+ * `notDetected` - the visitor is not a bot
+ * `good` - good bot detected, such as Google bot, Baidu Spider, AlexaBot and so on
+ * `bad` - bad bot detected, such as Selenium, Puppeteer, Playwright, headless browsers, and so on
+
 
 ## Enum
 

diff --git a/docs/ErrorCode.md b/docs/ErrorCode.md
@@ -1,6 +1,25 @@
 
 
 # ErrorCode
+    Error code:
+ * `RequestCannotBeParsed` - the query parameters or JSON payload contains some errors 
+          that prevented us from parsing it (wrong type/surpassed limits).
+ * `TokenRequired` - `Auth-API-Key` header is missing or empty.
+ * `TokenNotFound` - no Fingerprint application found for specified secret key.
+ * `SubscriptionNotActive` - Fingerprint application is not active.
+ * `WrongRegion` - server and application region differ.
+ * `FeatureNotEnabled` - this feature (for example, Delete API) is not enabled for your application.
+ * `RequestNotFound` - the specified request ID was not found. It never existed, expired, or it has been deleted.
+ * `VisitorNotFound` - The specified visitor ID was not found. It never existed or it may have already been deleted.
+ * `TooManyRequests` - the limit on secret API key requests per second has been exceeded.
+ * `429 Too Many Requests` - the limit on secret API key requests per second has been exceeded.
+ * `StateNotReady` - The event specified with request id is
+          not ready for updates yet. Try again.
+          This error happens in rare cases when update API is called immediately
+          after receiving the request id on the client. In case you need to send
+          information right away, we recommend using the JS agent API instead.
+ * `Failed` - internal server error.
+
 
 ## Enum
 

diff --git a/docs/VPNConfidence.md b/docs/VPNConfidence.md
@@ -1,6 +1,7 @@
 
 
 # VPNConfidence
+    A confidence rating for the VPN detection result — "low", "medium", or "high". Depends on the combination of results returned from all VPN detection methods.
 
 ## Enum
 

diff --git a/template/enum_outer_doc.mustache b/template/enum_outer_doc.mustache
@@ -0,0 +1,10 @@
+# {{classname}}
+{{#unescapedDescription}}
+    {{{.}}}
+
+{{/unescapedDescription}}
+## Enum
+
+{{#allowableValues}}{{#enumVars}}
+* `{{name}}` (value: `{{{value}}}`)
+{{/enumVars}}{{/allowableValues}}