Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/deprecate-504-events-search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@fingerprint/node-sdk': minor
---

**events-search**: The `504` response for the Events Search endpoint is deprecated and will no longer be generated by the Server API.
5 changes: 5 additions & 0 deletions .changeset/deprecate-504-events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@fingerprint/node-sdk': minor
---

**events**: The `504` response for the Get Event endpoint is deprecated and will no longer be generated by the Server API.
5 changes: 5 additions & 0 deletions .changeset/error-response-503-events-search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@fingerprint/node-sdk': minor
---

**events-search**: Add `503` Service Temporarily Unavailable response to the Events Search endpoint
5 changes: 5 additions & 0 deletions .changeset/error-response-503-events.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@fingerprint/node-sdk': minor
---

**events**: Add `503` Service Temporarily Unavailable response to the Get Event endpoint
10 changes: 10 additions & 0 deletions .changeset/pre.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"mode": "pre",
"tag": "test",
"initialVersions": {
"@fingerprint/node-sdk": "7.8.0",
"node-sdk-example": "1.0.0",
"node-sdk-functional-tests": "2.0.0"
},
"changesets": []
}
2 changes: 1 addition & 1 deletion .schema-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v3.8.0
v3.9.0
44 changes: 24 additions & 20 deletions resources/fingerprint-server-api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ info:
email: support@fingerprint.com
license:
name: MIT
url: >-
https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/blob/main/LICENSE
url: https://github.com/fingerprintjs/openapi/blob/main/LICENSE
tags:
- name: Fingerprint
description: >-
Expand Down Expand Up @@ -104,12 +103,8 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: >
description: |
Too Many Requests. The request is throttled.

To protect service stability during rare periods of extreme load, we
may return HTTP 429 responses with message `too many search
requests` even if you are within your assigned rate limits.
content:
application/json:
schema:
Expand All @@ -120,10 +115,15 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: Service Temporarily Unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'504':
description: >-
Gateway Timeout. Search execution exceeded the allowed timeout
window.
description: Gateway Timeout.
x-deprecated-response: true
content:
application/json:
schema:
Expand Down Expand Up @@ -1005,12 +1005,8 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
'429':
description: >
description: |
Too Many Requests. The request is throttled.

To protect service stability during rare periods of extreme load, we
may return HTTP 429 responses with message `too many search
requests` even if you are within your assigned rate limits.
content:
application/json:
schema:
Expand All @@ -1021,10 +1017,15 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'503':
description: Service Temporarily Unavailable.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'504':
description: >-
Gateway Timeout. Search execution exceeded the allowed timeout
window.
description: Gateway Timeout.
x-deprecated-response: true
content:
application/json:
schema:
Expand Down Expand Up @@ -2088,8 +2089,11 @@ components:
type: string
examples:
- SM-G991U
- iPhone14,5
description: Raw device model identifier, as reported by the mobile OS.
- D84AP
description: >-
Raw device model identifier, as reported by the mobile OS. On
Android, this is the vendor-defined model string (e.g., `SM-G991U`).
On iOS, this is an Apple board code (e.g., `D84AP`).
os_version:
type: string
examples:
Expand Down
36 changes: 24 additions & 12 deletions src/generatedApiTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -730,9 +730,9 @@ export interface components {
*/
device_manufacturer?: string
/**
* @description Raw device model identifier, as reported by the mobile OS.
* @description Raw device model identifier, as reported by the mobile OS. On Android, this is the vendor-defined model string (e.g., `SM-G991U`). On iOS, this is an Apple board code (e.g., `D84AP`).
* @example SM-G991U
* @example iPhone14,5
* @example D84AP
*/
device_model?: string
/**
Expand Down Expand Up @@ -1770,10 +1770,7 @@ export interface operations {
'application/json': components['schemas']['ErrorResponse']
}
}
/**
* @description Too Many Requests. The request is throttled.
* To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message `too many search requests` even if you are within your assigned rate limits.
*/
/** @description Too Many Requests. The request is throttled. */
429: {
headers: {
[name: string]: unknown
Expand All @@ -1791,7 +1788,16 @@ export interface operations {
'application/json': components['schemas']['ErrorResponse']
}
}
/** @description Gateway Timeout. Search execution exceeded the allowed timeout window. */
/** @description Service Temporarily Unavailable. */
503: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ErrorResponse']
}
}
/** @description Gateway Timeout. */
504: {
headers: {
[name: string]: unknown
Expand Down Expand Up @@ -2216,10 +2222,7 @@ export interface operations {
'application/json': components['schemas']['ErrorResponse']
}
}
/**
* @description Too Many Requests. The request is throttled.
* To protect service stability during rare periods of extreme load, we may return HTTP 429 responses with message `too many search requests` even if you are within your assigned rate limits.
*/
/** @description Too Many Requests. The request is throttled. */
429: {
headers: {
[name: string]: unknown
Expand All @@ -2237,7 +2240,16 @@ export interface operations {
'application/json': components['schemas']['ErrorResponse']
}
}
/** @description Gateway Timeout. Search execution exceeded the allowed timeout window. */
/** @description Service Temporarily Unavailable. */
503: {
headers: {
[name: string]: unknown
}
content: {
'application/json': components['schemas']['ErrorResponse']
}
}
/** @description Gateway Timeout. */
504: {
headers: {
[name: string]: unknown
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading