Improve documentation of "create tag" API (#7112)

* Document fields of TagCreation API * make gen * [CR] change description of "ref" arg of TagCreation * make gen :-)
treeverse · Dec 10, 2023 · 0787698 · 0787698
1 parent 3dca9c4
commit 0787698
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 23 deletions.
diff --git a/api/swagger.yml b/api/swagger.yml
@@ -585,14 +585,17 @@ components:
 
     TagCreation:
       type: object
+      description: Make tag ID point at this REF.
       required:
         - id
         - ref
       properties:
         id:
           type: string
+          description: ID of tag to create
         ref:
           type: string
+          description: the commit to tag
 
     TaskInfo:
       type: object

diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml
diff --git a/clients/java-legacy/docs/TagCreation.md b/clients/java-legacy/docs/TagCreation.md
diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/TagCreation.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/TagCreation.java
diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml
diff --git a/clients/java/docs/TagCreation.md b/clients/java/docs/TagCreation.md
diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/TagCreation.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/TagCreation.java
diff --git a/clients/python-legacy/docs/TagCreation.md b/clients/python-legacy/docs/TagCreation.md
diff --git a/clients/python-legacy/lakefs_client/model/tag_creation.py b/clients/python-legacy/lakefs_client/model/tag_creation.py
diff --git a/clients/python/docs/TagCreation.md b/clients/python/docs/TagCreation.md
diff --git a/clients/python/lakefs_sdk/models/tag_creation.py b/clients/python/lakefs_sdk/models/tag_creation.py
diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml
@@ -585,14 +585,17 @@ components:
 
     TagCreation:
       type: object
+      description: Make tag ID point at this REF.
       required:
         - id
         - ref
       properties:
         id:
           type: string
+          description: ID of tag to create
         ref:
           type: string
+          description: the commit to tag
 
     TaskInfo:
       type: object