rdblue commented on code in PR #9917:
URL: https://github.com/apache/iceberg/pull/9917#discussion_r1523740390
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -1610,13 +1610,27 @@ components:
PageToken:
description:
- An opaque token which allows clients to make use of pagination for a
list API (e.g. ListTables).
- Clients will initiate the first paginated request by sending an empty
`pageToken` e.g. `GET /tables?pageToken` or `GET /tables?pageToken=`
- signaling to the service that the response should be paginated.
+ An opaque token that allows clients to make use of pagination for list
APIs
+ (e.g. ListTables). Clients may initiate the first paginated request by
sending an empty
+ query parameter `pageToken` to the server e.g. `GET /tables?pageToken`
or `GET /tables?pageToken=`
+
+ Servers that support pagination should identify the `pageToken`
parameter and return a
+ `next-page-token` in the response if there are more results available.
After the initial
+ request, the value of `next-page-token` from each response must be
used as the `pageToken`
+ parameter value for the next request. The server must omit or return
`null` value for the
Review Comment:
Sending `null` and omitting the field are different. This should explicitly
send `null` for `next-page-token`. The idea is to always be clear about what,
exactly, should be sent. Clients need to interpret both `null` and missing to
stop further requests. But for a service what to send must always be clear.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org
For additional commands, e-mail: issues-h...@iceberg.apache.org
