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

docs(pagination): improve parameter descriptions #712

Merged
merged 1 commit into from
Aug 11, 2023
Merged

docs(pagination): improve parameter descriptions #712

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions pagination/migrationpagination/header.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ type RequestParameters struct {
// reference. The next page can be any number and some numbers might return an empty list.
//
// For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
// The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the
// `Link` header.
//
// required: false
// in: query
// default: 1
// min: 1
Page int `json:"page"`
zepatrik marked this conversation as resolved.
Show resolved Hide resolved
}

Expand Down Expand Up @@ -58,5 +58,8 @@ type ResponseHeaderAnnotation struct {
// The X-Total-Count HTTP Header
//
// The `X-Total-Count` header contains the total number of items in the collection.
//
// DEPRECATED: This header will be removed eventually. Please use the `Link` header
// instead to check whether you are on the last page.
TotalCount int `json:"x-total-count"`
}
Loading