Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sizes of cursors and pages are integers in REST. #3938

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Sizes of cursors and pages are integers in REST. #3938

merged 1 commit into from
Jul 19, 2024

Conversation

blkt
Copy link
Contributor

@blkt blkt commented Jul 19, 2024

Summary

This change addresses the problem of uint64 not being representable in javascript, leading to a swagger definition of two numbers related to cursors, namely size and total_records, having string type rather than integer. Using a uint32 generates the desired type and is sufficient for paging purposes.

This is a breaking change, which is why this commit contains changes to CLI as well. For the record, the feature is currently under feature flag.

Fixes #3934

Change Type

Mark the type of change your PR introduces:

  • Bug fix (resolves an issue without affecting existing features)
  • Feature (adds new functionality without breaking changes)
  • Breaking change (may impact existing functionalities or require documentation updates)
  • Documentation (updates or additions to documentation)
  • Refactoring or test improvements (no bug fixes or new functionality)

Testing

Manual and unit tests.

Review Checklist:

  • Reviewed my own code for quality and clarity.
  • Added comments to complex or tricky code sections.
  • Updated any affected documentation.
  • Included tests that validate the fix or feature.
  • Checked that related changes are merged.

@blkt
Sizes of cursors and pages are integers in REST.
eaae653 
This change addresses the problem of uint64 not being representable in
javascript, leading to a swagger definition of two numbers related to
cursors, namely `size` and `total_records`, having string type rather
than integer. Using a uint32 generates the desired type and is
sufficient for paging purposes.

This is a breaking change, which is why this commit contains changes
to CLI as well. For the record, the feature is currently under feature
flag.

Fixes #3934
@blkt blkt self-assigned this Jul 19, 2024
@blkt blkt requested a review from a team as a code owner July 19, 2024 10:42
@blkt blkt merged commit 970df6c into main Jul 19, 2024
22 of 23 checks passed
@blkt blkt deleted the issue-3934 branch July 19, 2024 10:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmjb dmjb dmjb approved these changes

Assignees

@blkt blkt

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Sizes of cursors and pages are not integers in REST
2 participants
@blkt @dmjb