docs(changelog): restore pagination entry for list endpoint - #155
Merged
Conversation
Comment on lines
+15
to
+20
| - 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. |
There was a problem hiding this comment.
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. |
Comment on lines
+16
to
+17
| `DatabasesApi.list_databases` gains `limit` and `cursor`, and the response | ||
| gains `count`, `has_more`, and `next_cursor`. Note the behavior change: a call |
There was a problem hiding this comment.
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)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
feat(databases): add pagination support to list endpointbullet was only ever on #148, which is now closed as superseded by #149 and #150. Its code shipped via those follow-ups, but[Unreleased]named the follow-ups and not the feature itself, so the 0.9.0 notes would have missed thelist_databasesdefault-page behavior change.