Skip to content

Sync OpenAPI Schema (17877) - events-search: Prefer RFC3339 for start and end query parameters#417

Merged
JuroUhlar merged 3 commits into
mainfrom
sync-17877
Jul 15, 2026
Merged

Sync OpenAPI Schema (17877) - events-search: Prefer RFC3339 for start and end query parameters#417
JuroUhlar merged 3 commits into
mainfrom
sync-17877

Conversation

@fingerprint-dx-team-actions-runner

Copy link
Copy Markdown
Contributor

This PR automatically updates the OpenAPI schema.

Changes

1 file(s) modified

Modified files
  • schemas/paths/events.yaml

Note for reviewers: Please review the schema changes.
You likely need to manually add a changeset file to this branch before merging.

@fingerprint-dx-team-actions-runner

Copy link
Copy Markdown
Contributor Author

✅The changes have been finalized. This PR is ready for review.

@changeset-bot

changeset-bot Bot commented Jul 13, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 63d8f11

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Schema Diff vs Published Schemas

  • Generated at: 2026-07-15T09:32:10.766Z
  • Published source: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas
  • Compared schemas: 8
  • Changed schemas: 3

fingerprint-server-api-v4-normalized.yaml

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4-normalized.yaml
Summary: +0 added, -0 removed, ~16 modified

Added elements (0)

None

Removed elements (0)

None

Modified elements (16)
  • /paths/~1events/get/parameters/18/schema/example
  • /paths/~1events/get/parameters/18/schema/examples/0
  • /paths/~1events/get/parameters/18/schema/format
  • /paths/~1events/get/parameters/18/schema/type
  • /paths/~1events/get/parameters/19/schema/example
  • /paths/~1events/get/parameters/19/schema/examples/0
  • /paths/~1events/get/parameters/19/schema/format
  • /paths/~1events/get/parameters/19/schema/type
  • /paths/~1events/get/parameters/20/schema/example
  • /paths/~1events/get/parameters/20/schema/examples/0
  • /paths/~1events/get/parameters/20/schema/format
  • /paths/~1events/get/parameters/20/schema/type
  • /paths/~1events/get/parameters/21/schema/example
  • /paths/~1events/get/parameters/21/schema/examples/0
  • /paths/~1events/get/parameters/21/schema/format
  • /paths/~1events/get/parameters/21/schema/type
Changed lines patch
--- a/schemas/fingerprint-server-api-v4-normalized.yaml
+++ b/schemas/fingerprint-server-api-v4-normalized.yaml
@@ -530,14 +530,14 @@
             value). Defaults to 7 days ago. Setting `start` does not change the
             default of `now` for `end`/`end_date_time` — adjust it separately if
             needed.
           schema:
             examples:
-              - 1767225600000
-            example: 1767225600000
-            type: integer
-            format: int64
+              - '2026-01-01T00:00:00Z'
+            example: '2026-01-01T00:00:00Z'
+            type: string
+            format: date-time
           x-parameter-alias: start_date_time
         - name: start_date_time
           in: query
           description: >-
             Include events that happened after this point (with timestamp
@@ -545,28 +545,28 @@
             timestamp). Defaults to 7 days ago. Setting `start_date_time` does
             not the default of `now` for `end`/`end_date_time` — adjust it
             separately if needed. This parameter is an alias for `start`.
           schema:
             examples:
-              - '2026-01-01T00:00:00Z'
-            example: '2026-01-01T00:00:00Z'
-            type: string
-            format: date-time
+              - 1767225600000
+            example: 1767225600000
+            type: integer
+            format: int64
           x-aliased-parameter-name: start
         - name: end
           in: query
           description: >-
             Include events that happened before this point (with timestamp less
             than or equal the provided `end` Unix milliseconds value). Defaults
             to now. Setting `end` does not change the default of `7 days ago`
             for `start`/`start_date_time` — adjust it separately if needed.
           schema:
             examples:
-              - 1769903999000
-            example: 1769903999000
-            type: integer
-            format: int64
+              - '2026-01-31T23:59:59Z'
+            example: '2026-01-31T23:59:59Z'
+            type: string
+            format: date-time
           x-parameter-alias: end_date_time
         - name: end_date_time
           in: query
           description: >-
             Include events that happened before this point (with timestamp less
@@ -574,14 +574,14 @@
             Defaults to now. Setting `end_date_time` does not change the default
             of `7 days ago` for `start`/`start_date_time` — adjust it separately
             if needed. This parameter is an alias for `end`.
           schema:
             examples:
-              - '2026-01-31T23:59:59Z'
-            example: '2026-01-31T23:59:59Z'
-            type: string
-            format: date-time
+              - 1769903999000
+            example: 1769903999000
+            type: integer
+            format: int64
           x-aliased-parameter-name: end
         - name: reverse
           in: query
           schema:
             type: boolean

fingerprint-server-api-v4-with-examples.yaml

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4-with-examples.yaml
Summary: +0 added, -0 removed, ~14 modified

Added elements (0)

None

Removed elements (0)

None

Modified elements (14)
  • /paths/~1events/get/parameters/18/description
  • /paths/~1events/get/parameters/18/schema/oneOf/0/examples/0
  • /paths/~1events/get/parameters/18/schema/oneOf/0/format
  • /paths/~1events/get/parameters/18/schema/oneOf/0/type
  • /paths/~1events/get/parameters/18/schema/oneOf/1/examples/0
  • /paths/~1events/get/parameters/18/schema/oneOf/1/format
  • /paths/~1events/get/parameters/18/schema/oneOf/1/type
  • /paths/~1events/get/parameters/19/description
  • /paths/~1events/get/parameters/19/schema/oneOf/0/examples/0
  • /paths/~1events/get/parameters/19/schema/oneOf/0/format
  • /paths/~1events/get/parameters/19/schema/oneOf/0/type
  • /paths/~1events/get/parameters/19/schema/oneOf/1/examples/0
  • /paths/~1events/get/parameters/19/schema/oneOf/1/format
  • /paths/~1events/get/parameters/19/schema/oneOf/1/type
Changed lines patch
--- a/schemas/fingerprint-server-api-v4-with-examples.yaml
+++ b/schemas/fingerprint-server-api-v4-with-examples.yaml
@@ -1645,45 +1645,46 @@
             to web events only (e.g., https://example.com)
         - name: start
           in: query
           schema:
             oneOf:
-              - type: integer
-                format: int64
-                examples:
-                  - 1767225600000
               - type: string
                 format: date-time
                 examples:
                   - '2026-01-01T00:00:00Z'
+              - type: integer
+                format: int64
+                examples:
+                  - 1767225600000
             examples:
               - '2026-01-01T00:00:00Z'
           description: >
-            Include events that happened after this point (with timestamp
-            greater than or equal the provided `start` Unix milliseconds value
-            or RFC3339 timestamp). Defaults to 7 days ago. Setting `start` does
-            not change `end`'s default of `now` — adjust it separately if
-            needed.
+            Include events that happened after the provided `start` date
+            formatted as an RFC3339 timestamp. For backward compatibility, a
+            Unix milliseconds timestamp is also accepted. Defaults to 7 days
+            ago. Setting `start` does not change the default `end` date of `now`
+            — adjust it separately if needed.
         - name: end
           in: query
           schema:
             oneOf:
-              - type: integer
-                format: int64
-                examples:
-                  - 1769903999000
               - type: string
                 format: date-time
                 examples:
                   - '2026-01-31T23:59:59Z'
+              - type: integer
+                format: int64
+                examples:
+                  - 1769903999000
             examples:
               - '2026-01-31T23:59:59Z'
           description: >
-            Include events that happened before this point (with timestamp less
-            than or equal the provided `end` Unix milliseconds value or RFC3339
-            timestamp). Defaults to now. Setting `end` does not change `start`'s
-            default of `7 days ago` — adjust it separately if needed.
+            Include events that happened before the provided `end` date
+            formatted as an RFC3339 timestamp. For backward compatibility, a
+            Unix milliseconds timestamp is also accepted. Defaults to now.
+            Setting `end` does not change the default `start` date of `7 days
+            ago` — adjust it separately if needed.
         - name: reverse
           in: query
           schema:
             type: boolean
           description: >

fingerprint-server-api-v4.yaml

Published URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4.yaml
Summary: +0 added, -0 removed, ~18 modified

Added elements (0)

None

Removed elements (0)

None

Modified elements (18)
  • /paths/~1events/get/parameters/18/description
  • /paths/~1events/get/parameters/18/schema/oneOf/0/example
  • /paths/~1events/get/parameters/18/schema/oneOf/0/examples/0
  • /paths/~1events/get/parameters/18/schema/oneOf/0/format
  • /paths/~1events/get/parameters/18/schema/oneOf/0/type
  • /paths/~1events/get/parameters/18/schema/oneOf/1/example
  • /paths/~1events/get/parameters/18/schema/oneOf/1/examples/0
  • /paths/~1events/get/parameters/18/schema/oneOf/1/format
  • /paths/~1events/get/parameters/18/schema/oneOf/1/type
  • /paths/~1events/get/parameters/19/description
  • /paths/~1events/get/parameters/19/schema/oneOf/0/example
  • /paths/~1events/get/parameters/19/schema/oneOf/0/examples/0
  • /paths/~1events/get/parameters/19/schema/oneOf/0/format
  • /paths/~1events/get/parameters/19/schema/oneOf/0/type
  • /paths/~1events/get/parameters/19/schema/oneOf/1/example
  • /paths/~1events/get/parameters/19/schema/oneOf/1/examples/0
  • /paths/~1events/get/parameters/19/schema/oneOf/1/format
  • /paths/~1events/get/parameters/19/schema/oneOf/1/type
Changed lines patch
--- a/schemas/fingerprint-server-api-v4.yaml
+++ b/schemas/fingerprint-server-api-v4.yaml
@@ -524,51 +524,52 @@
             to web events only (e.g., https://example.com)
         - name: start
           in: query
           schema:
             oneOf:
-              - type: integer
-                format: int64
-                examples:
-                  - 1767225600000
-                example: 1767225600000
               - type: string
                 format: date-time
                 examples:
                   - '2026-01-01T00:00:00Z'
                 example: '2026-01-01T00:00:00Z'
+              - type: integer
+                format: int64
+                examples:
+                  - 1767225600000
+                example: 1767225600000
             examples:
               - '2026-01-01T00:00:00Z'
             example: '2026-01-01T00:00:00Z'
           description: >
-            Include events that happened after this point (with timestamp
-            greater than or equal the provided `start` Unix milliseconds value
-            or RFC3339 timestamp). Defaults to 7 days ago. Setting `start` does
-            not change `end`'s default of `now` — adjust it separately if
-            needed.
+            Include events that happened after the provided `start` date
+            formatted as an RFC3339 timestamp. For backward compatibility, a
+            Unix milliseconds timestamp is also accepted. Defaults to 7 days
+            ago. Setting `start` does not change the default `end` date of `now`
+            — adjust it separately if needed.
         - name: end
           in: query
           schema:
             oneOf:
-              - type: integer
-                format: int64
-                examples:
-                  - 1769903999000
-                example: 1769903999000
               - type: string
                 format: date-time
                 examples:
                   - '2026-01-31T23:59:59Z'
                 example: '2026-01-31T23:59:59Z'
+              - type: integer
+                format: int64
+                examples:
+                  - 1769903999000
+                example: 1769903999000
             examples:
               - '2026-01-31T23:59:59Z'
             example: '2026-01-31T23:59:59Z'
           description: >
-            Include events that happened before this point (with timestamp less
-            than or equal the provided `end` Unix milliseconds value or RFC3339
-            timestamp). Defaults to now. Setting `end` does not change `start`'s
-            default of `7 days ago` — adjust it separately if needed.
+            Include events that happened before the provided `end` date
+            formatted as an RFC3339 timestamp. For backward compatibility, a
+            Unix milliseconds timestamp is also accepted. Defaults to now.
+            Setting `end` does not change the default `start` date of `7 days
+            ago` — adjust it separately if needed.
         - name: reverse
           in: query
           schema:
             type: boolean
           description: >

@fingerprint-dx-team-actions-runner fingerprint-dx-team-actions-runner Bot changed the title Sync OpenAPI Schema (17877) Sync OpenAPI Schema (17877) - events-search: Prefer RFC3339 for start and end query parameters Jul 13, 2026
@fingerprint-dx-team-actions-runner

Copy link
Copy Markdown
Contributor Author

🤖 Added changeset(s) and proposed a new title.

Please verify before merging:

  • Scope prefix is correct (events, visitors, webhook, related-visitors, events-search)
  • Severity (patch / minor / major) matches the actual impact — this is a best-effort guess
  • Summary accurately describes the change

Feel free to edit the changeset file(s) or PR title directly.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ This PR doesn't contain any changesets. If there are user-facing changes, don't forget to run:

pnpm run changeset

to create a changeset.

@JuroUhlar JuroUhlar merged commit 9bd2446 into main Jul 15, 2026
6 checks passed
@JuroUhlar JuroUhlar deleted the sync-17877 branch July 15, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants