Merge result summary deprecation (#5119)

* merge result summary deprecation Step before we depreate the merge summary result. This version will always return the summary fields and define the field as optional. It will enable users to switch to a version which will not break when the field is gone. * Deprecated each field
treeverse · Jan 29, 2023 · 2acb5b8 · 2acb5b8
1 parent 5383e2e
commit 2acb5b8
Show file tree

Hide file tree

Showing 15 changed files with 143 additions and 122 deletions.
diff --git a/api/swagger.yml b/api/swagger.yml
@@ -176,28 +176,33 @@ components:
           items:
             $ref: "#/components/schemas/Repository"
 
+    MergeResultSummary:
+      type: object
+      properties:
+        added:
+          type: integer
+          deprecated: true
+          description: "Deprecated: inaccurate and will be removed."
+        removed:
+          type: integer
+          deprecated: true
+          description: "Deprecated: inaccurate and will be removed."
+        changed:
+          type: integer
+          deprecated: true
+          description: "Deprecated: inaccurate and will be removed."
+        conflict:
+          type: integer
+          deprecated: true
+          description: "Deprecated: inaccurate and will be removed."
+
     MergeResult:
       type: object
       required:
-        - summary
         - reference
       properties:
         summary:
-          type: object
-          required:
-            - added
-            - removed
-            - changed
-            - conflict
-          properties:
-            added:
-              type: integer
-            removed:
-              type: integer
-            changed:
-              type: integer
-            conflict:
-              type: integer
+          $ref: "#/components/schemas/MergeResultSummary"
         reference:
           type: string
 
@@ -2635,7 +2640,9 @@ paths:
         404:
           $ref: "#/components/responses/NotFound"
         409:
-          description: conflict
+          description: |
+            Conflict
+            Deprecated: content schema will return Error format and not an empty MergeResult
           content:
             application/json:
               schema:

diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml
diff --git a/clients/java/docs/MergeResult.md b/clients/java/docs/MergeResult.md
diff --git a/clients/java/docs/MergeResultSummary.md b/clients/java/docs/MergeResultSummary.md
diff --git a/clients/java/docs/RefsApi.md b/clients/java/docs/RefsApi.md
diff --git a/clients/java/src/main/java/io/lakefs/clients/api/RefsApi.java b/clients/java/src/main/java/io/lakefs/clients/api/RefsApi.java
diff --git a/clients/java/src/main/java/io/lakefs/clients/api/model/MergeResult.java b/clients/java/src/main/java/io/lakefs/clients/api/model/MergeResult.java
diff --git a/clients/java/src/main/java/io/lakefs/clients/api/model/MergeResultSummary.java b/clients/java/src/main/java/io/lakefs/clients/api/model/MergeResultSummary.java
diff --git a/clients/python/docs/MergeResult.md b/clients/python/docs/MergeResult.md
diff --git a/clients/python/docs/MergeResultSummary.md b/clients/python/docs/MergeResultSummary.md
diff --git a/clients/python/docs/RefsApi.md b/clients/python/docs/RefsApi.md