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
1 change: 1 addition & 0 deletions docs/api/components/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -493,6 +493,7 @@ stale:
enum:
- ok
- update_after
- "false"
key:
name: key
in: query
Expand Down
6 changes: 4 additions & 2 deletions docs/api/components/schemas.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@ User-session-information:
additionalProperties:
x-additionalPropertiesName: channelName
type: integer
format: int64
minimum: 1
description: The sequence number the user was granted access.
title: sequence number
Expand Down Expand Up @@ -586,9 +587,10 @@ Changes-feed:
type: object
properties:
seq:
description: The change sequence number.
description: The change sequence number. This is usually a plain integer, but can be a compound (string) sequence value in some cases, such as during a channel backfill.
oneOf:
- type: integer

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P1] Mark changes feed sequence numbers as int64

seq is backed by db.SequenceID (uint64 for the simple form), and leaving the integer branch unformatted means many OpenAPI generators default this to int32, which can overflow/truncate real-world sequence values. Add format: int64 to the integer variant so generated clients treat sequence numbers as 64-bit.

Suggested change
- type: integer
- type: integer
format: int64

format: int64
- type: string
id:
description: The document ID the change happened on.
Expand Down Expand Up @@ -2777,7 +2779,7 @@ Logging-config:
readOnly: true
stats:
type: object
description: Trace logging configuration.
description: Stats logging configuration.
properties:
enabled:
description: Toggle for this log output
Expand Down
6 changes: 4 additions & 2 deletions docs/api/paths/admin/keyspace-_dumpchannel-channel.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ get:
parameters:
- name: since
in: query
description: Starts the results from the change immediately after the given sequence ID. Sequence IDs should be considered opaque; they come from the last_seq property of a prior response.
description: Starts the results from the change immediately after the given sequence number.
schema:
type: string
type: integer
Comment thread
torcolvin marked this conversation as resolved.
format: int64
minimum: 0
responses:
'200':
description: Successfully got all documents in the channel
Expand Down
Loading