Document that size_bytes is optional for clients but not for lakeFS (#…

…7923) * Document that size_bytes is optional for clients but not for lakeFS * [CR] Fix English in description * make gen
treeverse · Jun 26, 2024 · ee782a9 · ee782a9
1 parent c7fb429
commit ee782a9
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 11 deletions.
diff --git a/api/swagger.yml b/api/swagger.yml
@@ -320,6 +320,10 @@ components:
         size_bytes:
           type: integer
           format: int64
+          description: |
+            The number of bytes in the object.  lakeFS always populates this
+            field when returning ObjectStats.  This field is optional _for
+            the client_ to supply, for instance on upload.
         mtime:
           type: integer
           format: int64

diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml
diff --git a/clients/java-legacy/docs/ObjectStats.md b/clients/java-legacy/docs/ObjectStats.md
diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ObjectStats.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ObjectStats.java
diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml
diff --git a/clients/java/docs/ObjectStats.md b/clients/java/docs/ObjectStats.md
diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/ObjectStats.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/ObjectStats.java
diff --git a/clients/python-legacy/docs/ObjectStats.md b/clients/python-legacy/docs/ObjectStats.md
diff --git a/clients/python-legacy/lakefs_client/model/object_stats.py b/clients/python-legacy/lakefs_client/model/object_stats.py
diff --git a/clients/python/docs/ObjectStats.md b/clients/python/docs/ObjectStats.md
diff --git a/clients/python/lakefs_sdk/models/object_stats.py b/clients/python/lakefs_sdk/models/object_stats.py
diff --git a/clients/rust/docs/ObjectStats.md b/clients/rust/docs/ObjectStats.md
diff --git a/clients/rust/src/models/object_stats.rs b/clients/rust/src/models/object_stats.rs
diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml
@@ -320,6 +320,10 @@ components:
         size_bytes:
           type: integer
           format: int64
+          description: |
+            The number of bytes in the object.  lakeFS always populates this
+            field when returning ObjectStats.  This field is optional _for
+            the client_ to supply, for instance on upload.
         mtime:
           type: integer
           format: int64