Skip to content

Commit 44d5e67

Browse files
committed
controllers/helpers/pagination: Update the seek parameter descriptions
1 parent 3f142f8 commit 44d5e67

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

Diff for: src/controllers/helpers/pagination.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,9 @@ pub struct PaginationQueryParams {
8787
/// all requests.
8888
///
8989
/// The seek key can usually be found in the `meta.next_page` field of
90-
/// paginated responses.
90+
/// paginated responses. It can also be found in the `meta.prev_page` field
91+
/// when the endpoint supports backward pagination, in which case the value
92+
/// starts with a `-`.
9193
pub seek: Option<String>,
9294
}
9395

Diff for: src/snapshots/crates_io__openapi__tests__openapi_snapshot.snap

+5-5
Original file line numberDiff line numberDiff line change
@@ -1232,7 +1232,7 @@ expression: response.json()
12321232
}
12331233
},
12341234
{
1235-
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses.",
1235+
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses. It can also be found in the `meta.prev_page` field\nwhen the endpoint supports backward pagination, in which case the value\nstarts with a `-`.",
12361236
"in": "query",
12371237
"name": "seek",
12381238
"required": false,
@@ -1450,7 +1450,7 @@ expression: response.json()
14501450
}
14511451
},
14521452
{
1453-
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses.",
1453+
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses. It can also be found in the `meta.prev_page` field\nwhen the endpoint supports backward pagination, in which case the value\nstarts with a `-`.",
14541454
"in": "query",
14551455
"name": "seek",
14561456
"required": false,
@@ -1758,7 +1758,7 @@ expression: response.json()
17581758
}
17591759
},
17601760
{
1761-
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses.",
1761+
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses. It can also be found in the `meta.prev_page` field\nwhen the endpoint supports backward pagination, in which case the value\nstarts with a `-`.",
17621762
"in": "query",
17631763
"name": "seek",
17641764
"required": false,
@@ -2666,7 +2666,7 @@ expression: response.json()
26662666
}
26672667
},
26682668
{
2669-
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses.",
2669+
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses. It can also be found in the `meta.prev_page` field\nwhen the endpoint supports backward pagination, in which case the value\nstarts with a `-`.",
26702670
"in": "query",
26712671
"name": "seek",
26722672
"required": false,
@@ -3279,7 +3279,7 @@ expression: response.json()
32793279
}
32803280
},
32813281
{
3282-
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses.",
3282+
"description": "The seek key to request.\n\nThis parameter is mutually exclusive with `page` and not supported for\nall requests.\n\nThe seek key can usually be found in the `meta.next_page` field of\npaginated responses. It can also be found in the `meta.prev_page` field\nwhen the endpoint supports backward pagination, in which case the value\nstarts with a `-`.",
32833283
"in": "query",
32843284
"name": "seek",
32853285
"required": false,

0 commit comments

Comments
 (0)