stevenzwu commented on code in PR #12584:
URL: https://github.com/apache/iceberg/pull/12584#discussion_r2603127569
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -1825,6 +1825,59 @@ 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
continuation-token, enabling resumable
+ synchronization after downtime or errors.
+
+ This endpoint primarily supports use cases like catalog federation,
workflow triggering,
+ and basic audit capabilities.
+
+ The server encodes all necessary state in the token to ensure
+ consistent filtering across pages. Clients should use the returned
`continuation-token` for
Review Comment:
> The server encodes all necessary state in the token to ensure consistent
filtering across pages
maybe further remove the `consistent filtering` part. e.g. sth like
```
The server encodes all necessary state within the continuation-token. The
client should treat this token as a required opaque value and pass it unchanged
in subsequent requests to resume the changelog consumption.
```
--
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]
