huaxingao commented on code in PR #14196:
URL: https://github.com/apache/iceberg/pull/14196#discussion_r2389629668
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -1903,6 +1926,39 @@ components:
schema:
type: string
+ idempotency-key:
+ name: Idempotency-Key
+ in: header
+ required: false
+ schema:
+ type: string
+ format: uuid
+ minLength: 36
+ maxLength: 36
+ example: "550e8400-e29b-41d4-a716-446655440000"
+ description: |
+ Optional client-provided idempotency key for safe request retries.
+
+ When present, the server ensures no additional effects for requests
that carry the same
+ Idempotency-Key within the same operation/resource scope. If a prior
request with this key
+ has been finalized, the server returns the previously finalized
response instead of
+ re-executing the mutation.
+
+ Finalization rules:
+ - Finalize & replay: 200, 201, 204, and deterministic terminal 4xx
+ - Do not finalize (not stored/replayed): 5xx, 409 request_in_progress
+
+ Key Requirements:
+ - Must be unique per client mutation operation (e.g., updateTable,
createTable)
+ - Key format: UUID (V7 preferred)
+ - Scoped to operation type and resource path
+ - Catalogs may expire keys according to the advertised token lifetime.
+
+ Best Practices:
+ - Use UUID.randomUUID() or equivalent
Review Comment:
Yes, it's required. "Best practice" is using UUID v7.
I removed this `Best Practices` section because in the above section, it
already has `UUID (V7 preferred)`,
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -1903,6 +1926,39 @@ components:
schema:
type: string
+ idempotency-key:
+ name: Idempotency-Key
+ in: header
+ required: false
+ schema:
+ type: string
+ format: uuid
+ minLength: 36
+ maxLength: 36
+ example: "550e8400-e29b-41d4-a716-446655440000"
+ description: |
+ Optional client-provided idempotency key for safe request retries.
+
+ When present, the server ensures no additional effects for requests
that carry the same
+ Idempotency-Key within the same operation/resource scope. If a prior
request with this key
+ has been finalized, the server returns the previously finalized
response instead of
+ re-executing the mutation.
+
+ Finalization rules:
+ - Finalize & replay: 200, 201, 204, and deterministic terminal 4xx
+ - Do not finalize (not stored/replayed): 5xx, 409 request_in_progress
+
+ Key Requirements:
+ - Must be unique per client mutation operation (e.g., updateTable,
createTable)
+ - Key format: UUID (V7 preferred)
+ - Scoped to operation type and resource path
+ - Catalogs may expire keys according to the advertised token lifetime.
+
+ Best Practices:
+ - Use UUID.randomUUID() or equivalent
+ - Reuse the same key for retries of the same logical operation
+ - Generate new keys for new operations
Review Comment:
I moved this to the requirements
--
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]
