rdblue commented on code in PR #9917:
URL: https://github.com/apache/iceberg/pull/9917#discussion_r1523742808
##########
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=`
Review Comment:
To be clear, I prefer removing these examples because this is an area that
should be covered by the OpenAPI spec. The purpose of OpenAPI is to allow us to
specify these things without ambiguity. I would prefer relying on that rather
than giving an example here at all.
But if you want to have an example, there should be only one example.
--
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
