Recommend in OpenAPI docs to add the source commit to other fields

treeverse · Jan 5, 2025 · fedacd4 · fedacd4
1 parent 3c8641b
commit fedacd4
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 17 deletions.
diff --git a/api/swagger.yml b/api/swagger.yml
@@ -690,10 +690,10 @@ components:
           type: boolean
           default: true
           description: |
-            If set, set only the destination branch as a parent, which
-            "squashes" the merge to appear as a single commit on the
-            destination branch.
-
+            If set, set only the destination branch as a parent, which "squashes" the merge to
+            appear as a single commit on the destination branch.  The source commit is no longer
+            a part of the merge commit; consider adding it to the 'metadata' or 'message'
+            fields.
     BranchCreation:
       type: object
       required:

diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml
diff --git a/clients/java/docs/Merge.md b/clients/java/docs/Merge.md
diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/Merge.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/Merge.java
diff --git a/clients/python/docs/Merge.md b/clients/python/docs/Merge.md
diff --git a/clients/python/lakefs_sdk/models/merge.py b/clients/python/lakefs_sdk/models/merge.py
diff --git a/clients/rust/docs/Merge.md b/clients/rust/docs/Merge.md
diff --git a/clients/rust/src/models/merge.rs b/clients/rust/src/models/merge.rs
diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml
@@ -690,10 +690,10 @@ components:
           type: boolean
           default: true
           description: |
-            If set, set only the destination branch as a parent, which
-            "squashes" the merge to appear as a single commit on the
-            destination branch.
-
+            If set, set only the destination branch as a parent, which "squashes" the merge to
+            appear as a single commit on the destination branch.  The source commit is no longer
+            a part of the merge commit; consider adding it to the 'metadata' or 'message'
+            fields.
     BranchCreation:
       type: object
       required: