From e79749a9a24b0c27c3c0ae3f3778e5da5f54bb55 Mon Sep 17 00:00:00 2001 From: zepatrik Date: Tue, 8 Aug 2023 10:42:39 +0200 Subject: [PATCH] docs(pagination): improve parameter descriptions --- pagination/migrationpagination/header.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/pagination/migrationpagination/header.go b/pagination/migrationpagination/header.go index d78b6d29..0a24143c 100644 --- a/pagination/migrationpagination/header.go +++ b/pagination/migrationpagination/header.go @@ -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"` } @@ -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"` }