-
-
Notifications
You must be signed in to change notification settings - Fork 105
/
header.go
92 lines (85 loc) · 3.09 KB
/
header.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package migrationpagination
// swagger:model mixedPaginationRequestParameters
type RequestParameters struct {
// Deprecated Items per Page
//
// DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.
//
// This is the number of items per page.
//
// required: false
// in: query
// default: 250
// min: 1
// max: 1000
PerPage int `json:"per_page"`
// Deprecated Pagination Page
//
// DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.
//
// This value is currently an integer, but it is not sequential. The value is not the page number, but a
// 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
Page int `json:"page"`
// Page Size
//
// This is the number of items per page to return. For details on pagination please head over to the
// [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
//
// required: false
// in: query
// default: 250
// min: 1
// max: 500
PageSize int `json:"page_size"`
// Next Page Token
//
// The next page token. For details on pagination please head over to the
// [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
//
// required: false
// in: query
// default: 1
// min: 1
PageToken string `json:"page_token"`
}
// Pagination Response Header
//
// The `Link` HTTP header contains multiple links (`first`, `next`, `last`, `previous`) formatted as:
// `<https://{project-slug}.projects.oryapis.com/admin/clients?page_size={limit}&page_token={offset}>; rel="{page}"`
//
// For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
//
// swagger:model mixedPagePaginationResponseHeaders
type ResponseHeaderAnnotation struct {
// The Link HTTP Header
//
// The `Link` header contains a comma-delimited list of links to the following pages:
//
// - first: The first page of results.
// - next: The next page of results.
// - prev: The previous page of results.
// - last: The last page of results.
//
// Pages are omitted if they do not exist. For example, if there is no next page, the `next` link is omitted.
//
// The header value may look like follows:
//
// </clients?limit=5&offset=0>; rel="first",</clients?limit=5&offset=15>; rel="next",</clients?limit=5&offset=5>; rel="prev",</clients?limit=5&offset=20>; rel="last"
Link string `json:"link"`
// 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"`
}