Skip to content
Merged
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- chore(query-runs): clarify user_public_id documentation
- feat(databases): add search parameter to list endpoint
- chore(databases): make pagination fields nullable
- feat(databases): add pagination support to list endpoint.
`DatabasesApi.list_databases` gains `limit` and `cursor`, and the response
gains `count`, `has_more`, and `next_cursor`. Note the behavior change: a call
Comment on lines +16 to +17

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

super nit: ListDatabasesResponse also gained a limit field ("Page size applied to this response (after clamping to the maximum)"), which isn't listed here. Worth including so the entry matches docs/ListDatabasesResponse.md. (not blocking)

with no `limit` now returns a single page rather than every database, so
callers that relied on one call seeing everything should follow `next_cursor`
while `has_more` is true.
Comment on lines +15 to +20

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nit: this entry describes a behavior break for existing callers (a no-limit call used to return every database, now returns one page), but the two other behavior-breaking notes in this changelog are marked with a **Breaking:** prefix (lines 24 and 58). Adding the marker here keeps the 0.9.0 notes scannable for the thing most likely to break someone. (not blocking)

Suggested change
- feat(databases): add pagination support to list endpoint.
`DatabasesApi.list_databases` gains `limit` and `cursor`, and the response
gains `count`, `has_more`, and `next_cursor`. Note the behavior change: a call
with no `limit` now returns a single page rather than every database, so
callers that relied on one call seeing everything should follow `next_cursor`
while `has_more` is true.
- **Breaking:** feat(databases): add pagination support to list endpoint.
`DatabasesApi.list_databases` gains `limit` and `cursor`, and the response
gains `count`, `has_more`, and `next_cursor`. Note the behavior change: a call
with no `limit` now returns a single page rather than every database, so
callers that relied on one call seeing everything should follow `next_cursor`
while `has_more` is true.


### Removed

Expand Down