stevenzwu commented on code in PR #12584:
URL: https://github.com/apache/iceberg/pull/12584#discussion_r2599930720
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -1795,6 +1795,61 @@ paths:
5XX:
$ref: '#/components/responses/ServerErrorResponse'
+ /v1/{prefix}/events:
+ parameters:
+ - $ref: '#/components/parameters/prefix'
+ post:
+ tags:
+ - Catalog API
+ summary: Get events for changes to catalog objects
+ description: >
+ Returns a sequence of changes to catalog objects (tables, namespaces,
views)
+ that allows clients to efficiently track metadata modifications
without polling individual
+ resources. Consumers track their progress through a next-page-token,
enabling resumable
+ synchronization after downtime or errors.
+
+ This endpoint primarily supports use cases like catalog federation,
workflow triggering,
+ and basic audit capabilities.
+
+ When a request includes a `next-page-token`, it takes precedence over
Review Comment:
> When a request includes a `next-page-token`, it takes precedence
over
> all other filters including `after-timestamp-ms` and
`operation-type`.
I am wondering if the above restriction is necessary. Server is just
responsible to return events since the provided continuation token and applying
the client provided filters on top of the change events. If clients choose to
change the filters, that should be fine although I am not aware of such
scenarios yet.
Also we probably should replace `next-page-token` to `continuation-token`.
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
