Pagination: more consistent, add to changelogs (BREAKING CHANGE) #84
Conversation
This file contains 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
Make the pagination handling more consistent where implemented and extend it to the changelogs API.
joshbeard
commented
Aug 19, 2024
bdwellons
approved these changes
Aug 19, 2024
joshbeard
commented
Aug 19, 2024
joshbeard
added a commit
to joshbeard/readme-api-go-client
that referenced
this pull request
Aug 22, 2024
* fix: nested category docs (BREAKING CHANGE)
* Previously, category docs that were nested under a parent document were not
returned in the response. This has been fixed.
* BREAKING CHANGE: The response structure for the `category.GetDocs()` method
has changed. The `CategoryDocsChildren` struct has been removed and the
existing `CategoryDocs` struct is now used for the nested category docs.
The existing `Children` field is present for nested docs, but ReadMe limits
the depth of the nested docs to 1 level. (Category -> Parent Doc -> Child)
* Since this project is still versioned as `0.x.x`, this will
increment the **minor version**.
* fix: pagination results are incomplete
* LiveOakLabs#84 broke pagination because it didn't properly append the results to the
response. This has been fixed.
* maint: Refactor tests
* Update the category tests to be more exhaustive and to use table-driven
tests.
* Particular testing improved for pagination, categories, and docs.
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.
Make the pagination handling more consistent where implemented and extend it to the changelogs API.
Breaking Change
Changelog and Custom Page
GetAll()now returnsnilwhen there are no changelogs, consistent with the API Specification'sGetAll()function.Since this project is still versioned as a development release (
0.x.x), this will increment the minor version.