6880 import api location docs (#6886)

* Explain the import destination behaviour for objects and prefixes * gen docs * Fix last comment
treeverse · Nov 5, 2023 · 700216d · 700216d
1 parent f8b95c5
commit 700216d
Show file tree

Hide file tree

Showing 12 changed files with 42 additions and 30 deletions.
diff --git a/api/swagger.yml b/api/swagger.yml
@@ -1250,11 +1250,14 @@ components:
           description: Path type, can either be 'common_prefix' or 'object'
         path:
           type: string
-          description: A source location to import path or to a single object. Must match the lakeFS installation blockstore type.
+          description: A source location to a 'common_prefix' or to a single object. Must match the lakeFS installation blockstore type.
           example: s3://my-bucket/production/collections/
         destination:
           type: string
-          description: Destination for the imported objects on the branch
+          description: |
+            Destination for the imported objects on the branch. Must be a relative path to the branch.
+            If the type is an 'object', the destination is the exact object name under the branch.
+            If the type is a 'common_prefix', the destination is the prefix under the branch.
           example: collections/
 
     ImportCreation:

diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml
diff --git a/clients/java-legacy/docs/ImportLocation.md b/clients/java-legacy/docs/ImportLocation.md
diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ImportLocation.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/ImportLocation.java
diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml
diff --git a/clients/java/docs/ImportLocation.md b/clients/java/docs/ImportLocation.md
diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/ImportLocation.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/ImportLocation.java
diff --git a/clients/python-legacy/docs/ImportLocation.md b/clients/python-legacy/docs/ImportLocation.md
diff --git a/clients/python-legacy/lakefs_client/model/import_location.py b/clients/python-legacy/lakefs_client/model/import_location.py
diff --git a/clients/python/docs/ImportLocation.md b/clients/python/docs/ImportLocation.md
diff --git a/clients/python/lakefs_sdk/models/import_location.py b/clients/python/lakefs_sdk/models/import_location.py
diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml
@@ -1250,11 +1250,14 @@ components:
           description: Path type, can either be 'common_prefix' or 'object'
         path:
           type: string
-          description: A source location to import path or to a single object. Must match the lakeFS installation blockstore type.
+          description: A source location to a 'common_prefix' or to a single object. Must match the lakeFS installation blockstore type.
           example: s3://my-bucket/production/collections/
         destination:
           type: string
-          description: Destination for the imported objects on the branch
+          description: |
+            Destination for the imported objects on the branch. Must be a relative path to the branch.
+            If the type is an 'object', the destination is the exact object name under the branch.
+            If the type is a 'common_prefix', the destination is the prefix under the branch.
           example: collections/
 
     ImportCreation: