Fokko commented on code in PR #13902:
URL: https://github.com/apache/iceberg/pull/13902#discussion_r2294712670


##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -3136,9 +3136,10 @@ components:
           type: string
 
     AssertRefSnapshotId:
-      description:
-        The table branch or tag identified by the requirement's `ref` must 
reference the requirement's `snapshot-id`; 
-        if `snapshot-id` is `null` or missing, the ref must not already exist
+      description: |
+        The table branch or tag identified by the requirement's `ref` must 
reference the requirement's `snapshot-id`.
+        The `snapshot-id` field is required in this object, but its value may 
be `null` or missing.
+        If `snapshot-id` is `null` or missing, the ref must not already exist.

Review Comment:
   Since it is still required, I don't think we can omit it. I'd rather change 
this to:
   ```suggestion
           The `snapshot-id` field is required in this object, but in the case 
of a `null`
           the ref must nota already exist.
   ```
   
   According to Stack', required means that the propety should be present: 
https://stackoverflow.com/questions/45575493/what-does-required-in-openapi-really-mean



##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -3136,9 +3136,10 @@ components:
           type: string
 
     AssertRefSnapshotId:
-      description:
-        The table branch or tag identified by the requirement's `ref` must 
reference the requirement's `snapshot-id`; 
-        if `snapshot-id` is `null` or missing, the ref must not already exist
+      description: |
+        The table branch or tag identified by the requirement's `ref` must 
reference the requirement's `snapshot-id`.
+        The `snapshot-id` field is required in this object, but its value may 
be `null` or missing.
+        If `snapshot-id` is `null` or missing, the ref must not already exist.

Review Comment:
   Since it is still required, I don't think we can omit it. I'd rather change 
this to:
   ```suggestion
           The `snapshot-id` field is required in this object, but in the case 
of a `null`
           the ref must not already exist.
   ```
   
   According to Stack', required means that the propety should be present: 
https://stackoverflow.com/questions/45575493/what-does-required-in-openapi-really-mean



-- 
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]

Reply via email to