kbendick commented on code in PR #5118:
URL: https://github.com/apache/iceberg/pull/5118#discussion_r908921065
##########
open-api/rest-catalog-open-api.yaml:
##########
@@ -1464,19 +1464,23 @@ components:
LoadTableResult:
description:
Result used when a table is successfully loaded.
-
-
- The table metadata JSON is returned in the `metadata` field. The
corresponding file location of table metadata must be returned in the
`metadata-location` field. Clients can check whether metadata has changed by
comparing metadata locations.
-
-
+
+
+ The table metadata JSON is returned in the `metadata` field. The
corresponding file location of table metadata should be returned in the
`metadata-location` field, unless it hasn't been determined yet - such as when
a transaction begins to stage a table for creation but has not commit.
+
+
+ Clients can check whether metadata has changed by comparing metadata
locations after the table has been created.
+
+
The `config` map returns table-specific configuration for the table's
resources, including its HTTP client and FileIO. For example, config may
contain a specific FileIO implementation class for the table depending on its
underlying storage.
type: object
required:
- - metadata-location
- metadata
properties:
metadata-location:
type: string
+ nullable: true
+ description: Current location of the table's metadata file. Should
only be null if the table has been staged for creation as part of a transaction
but does not yet exist.
Review Comment:
Looks better with the shorter description given that the whole result has a
thorough description.
--
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]
