From 624e9ae5c535846613b03e36654b80df9226713a Mon Sep 17 00:00:00 2001 From: "Ariel Shaqed (Scolnicov)" Date: Mon, 4 Dec 2023 16:15:53 +0200 Subject: [PATCH 1/4] Document fields of TagCreation API --- api/swagger.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/api/swagger.yml b/api/swagger.yml index b12b2f39508..d54372d5f91 100644 --- 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: reference to commit to tag TaskInfo: type: object From a9ba12a67e4971afe7645a5d97f35dc77763be93 Mon Sep 17 00:00:00 2001 From: "Ariel Shaqed (Scolnicov)" Date: Mon, 4 Dec 2023 16:16:12 +0200 Subject: [PATCH 2/4] make gen --- clients/java-legacy/api/openapi.yaml | 3 +++ clients/java-legacy/docs/TagCreation.md | 5 +++-- .../java/io/lakefs/clients/api/model/TagCreation.java | 11 ++++++----- clients/java/api/openapi.yaml | 3 +++ clients/java/docs/TagCreation.md | 5 +++-- .../java/io/lakefs/clients/sdk/model/TagCreation.java | 6 +++--- clients/python-legacy/docs/TagCreation.md | 5 +++-- .../python-legacy/lakefs_client/model/tag_creation.py | 8 ++++---- clients/python/docs/TagCreation.md | 5 +++-- clients/python/lakefs_sdk/models/tag_creation.py | 6 +++--- docs/assets/js/swagger.yml | 3 +++ 11 files changed, 37 insertions(+), 23 deletions(-) diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml index ef51906e752..9e0affd9da4 100644 --- a/clients/java-legacy/api/openapi.yaml +++ b/clients/java-legacy/api/openapi.yaml @@ -6742,13 +6742,16 @@ components: - source type: object TagCreation: + description: Make tag ID point at this REF. example: ref: ref id: id properties: id: + description: ID of tag to create type: string ref: + description: reference to commit to tag type: string required: - id diff --git a/clients/java-legacy/docs/TagCreation.md b/clients/java-legacy/docs/TagCreation.md index ee60d98d41a..d67d28a8ef4 100644 --- a/clients/java-legacy/docs/TagCreation.md +++ b/clients/java-legacy/docs/TagCreation.md @@ -2,13 +2,14 @@ # TagCreation +Make tag ID point at this REF. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | | -**ref** | **String** | | +**id** | **String** | ID of tag to create | +**ref** | **String** | reference to commit to tag | 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 index b9d35fcf6d7..ccc954f10d5 100644 --- 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 @@ -25,8 +25,9 @@ import java.io.IOException; /** - * TagCreation + * Make tag ID point at this REF. */ +@ApiModel(description = "Make tag ID point at this REF.") @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") public class TagCreation { public static final String SERIALIZED_NAME_ID = "id"; @@ -45,11 +46,11 @@ public TagCreation id(String id) { } /** - * Get id + * ID of tag to create * @return id **/ @javax.annotation.Nonnull - @ApiModelProperty(required = true, value = "") + @ApiModelProperty(required = true, value = "ID of tag to create") public String getId() { return id; @@ -68,11 +69,11 @@ public TagCreation ref(String ref) { } /** - * Get ref + * reference to commit to tag * @return ref **/ @javax.annotation.Nonnull - @ApiModelProperty(required = true, value = "") + @ApiModelProperty(required = true, value = "reference to commit to tag") public String getRef() { return ref; diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml index 2c74869deb5..fcf68c8a21d 100644 --- a/clients/java/api/openapi.yaml +++ b/clients/java/api/openapi.yaml @@ -6716,13 +6716,16 @@ components: - source type: object TagCreation: + description: Make tag ID point at this REF. example: ref: ref id: id properties: id: + description: ID of tag to create type: string ref: + description: reference to commit to tag type: string required: - id diff --git a/clients/java/docs/TagCreation.md b/clients/java/docs/TagCreation.md index fcb7bc61421..1551044dab3 100644 --- a/clients/java/docs/TagCreation.md +++ b/clients/java/docs/TagCreation.md @@ -2,13 +2,14 @@ # TagCreation +Make tag ID point at this REF. ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**id** | **String** | | | -|**ref** | **String** | | | +|**id** | **String** | ID of tag to create | | +|**ref** | **String** | reference to commit to tag | | 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 index 88b4acb7581..aa7860aefbc 100644 --- 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 @@ -48,7 +48,7 @@ import io.lakefs.clients.sdk.JSON; /** - * TagCreation + * Make tag ID point at this REF. */ @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen") public class TagCreation { @@ -70,7 +70,7 @@ public TagCreation id(String id) { } /** - * Get id + * ID of tag to create * @return id **/ @javax.annotation.Nonnull @@ -91,7 +91,7 @@ public TagCreation ref(String ref) { } /** - * Get ref + * reference to commit to tag * @return ref **/ @javax.annotation.Nonnull diff --git a/clients/python-legacy/docs/TagCreation.md b/clients/python-legacy/docs/TagCreation.md index 2ad290e308f..6d09980488f 100644 --- a/clients/python-legacy/docs/TagCreation.md +++ b/clients/python-legacy/docs/TagCreation.md @@ -1,11 +1,12 @@ # TagCreation +Make tag ID point at this REF. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | -**ref** | **str** | | +**id** | **str** | ID of tag to create | +**ref** | **str** | reference to commit to tag | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python-legacy/lakefs_client/model/tag_creation.py b/clients/python-legacy/lakefs_client/model/tag_creation.py index e06addc4b57..6d622e49318 100644 --- a/clients/python-legacy/lakefs_client/model/tag_creation.py +++ b/clients/python-legacy/lakefs_client/model/tag_creation.py @@ -107,8 +107,8 @@ def _from_openapi_data(cls, id, ref, *args, **kwargs): # noqa: E501 """TagCreation - a model defined in OpenAPI Args: - id (str): - ref (str): + id (str): ID of tag to create + ref (str): reference to commit to tag Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -194,8 +194,8 @@ def __init__(self, id, ref, *args, **kwargs): # noqa: E501 """TagCreation - a model defined in OpenAPI Args: - id (str): - ref (str): + id (str): ID of tag to create + ref (str): reference to commit to tag Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/clients/python/docs/TagCreation.md b/clients/python/docs/TagCreation.md index e684ed04ead..81c81c1c74a 100644 --- a/clients/python/docs/TagCreation.md +++ b/clients/python/docs/TagCreation.md @@ -1,12 +1,13 @@ # TagCreation +Make tag ID point at this REF. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | | -**ref** | **str** | | +**id** | **str** | ID of tag to create | +**ref** | **str** | reference to commit to tag | ## Example diff --git a/clients/python/lakefs_sdk/models/tag_creation.py b/clients/python/lakefs_sdk/models/tag_creation.py index 9b00776abf4..7e5721175db 100644 --- a/clients/python/lakefs_sdk/models/tag_creation.py +++ b/clients/python/lakefs_sdk/models/tag_creation.py @@ -24,10 +24,10 @@ class TagCreation(BaseModel): """ - TagCreation + Make tag ID point at this REF. """ - id: StrictStr = Field(...) - ref: StrictStr = Field(...) + id: StrictStr = Field(..., description="ID of tag to create") + ref: StrictStr = Field(..., description="reference to commit to tag") __properties = ["id", "ref"] class Config: diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml index b12b2f39508..d54372d5f91 100644 --- 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: reference to commit to tag TaskInfo: type: object From 491d46e16964324d0abf7b0058546f7e2c92a686 Mon Sep 17 00:00:00 2001 From: "Ariel Shaqed (Scolnicov)" Date: Sun, 10 Dec 2023 11:01:39 +0200 Subject: [PATCH 3/4] [CR] change description of "ref" arg of TagCreation --- api/swagger.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/swagger.yml b/api/swagger.yml index d54372d5f91..95eb699379f 100644 --- a/api/swagger.yml +++ b/api/swagger.yml @@ -595,7 +595,7 @@ components: description: ID of tag to create ref: type: string - description: reference to commit to tag + description: the commit to tag TaskInfo: type: object From 07e015bc3146c87e6085dd97bce42f06d03366a0 Mon Sep 17 00:00:00 2001 From: "Ariel Shaqed (Scolnicov)" Date: Sun, 10 Dec 2023 11:04:44 +0200 Subject: [PATCH 4/4] make gen :-) --- clients/java-legacy/api/openapi.yaml | 2 +- clients/java-legacy/docs/TagCreation.md | 2 +- .../main/java/io/lakefs/clients/api/model/TagCreation.java | 4 ++-- clients/java/api/openapi.yaml | 2 +- clients/java/docs/TagCreation.md | 2 +- .../main/java/io/lakefs/clients/sdk/model/TagCreation.java | 2 +- clients/python-legacy/docs/TagCreation.md | 2 +- clients/python-legacy/lakefs_client/model/tag_creation.py | 4 ++-- clients/python/docs/TagCreation.md | 2 +- clients/python/lakefs_sdk/models/tag_creation.py | 2 +- docs/assets/js/swagger.yml | 2 +- 11 files changed, 13 insertions(+), 13 deletions(-) diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml index 9e0affd9da4..ba8f367a8d2 100644 --- a/clients/java-legacy/api/openapi.yaml +++ b/clients/java-legacy/api/openapi.yaml @@ -6751,7 +6751,7 @@ components: description: ID of tag to create type: string ref: - description: reference to commit to tag + description: the commit to tag type: string required: - id diff --git a/clients/java-legacy/docs/TagCreation.md b/clients/java-legacy/docs/TagCreation.md index d67d28a8ef4..8e70b5ed5cd 100644 --- a/clients/java-legacy/docs/TagCreation.md +++ b/clients/java-legacy/docs/TagCreation.md @@ -9,7 +9,7 @@ Make tag ID point at this REF. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | ID of tag to create | -**ref** | **String** | reference to commit to tag | +**ref** | **String** | the commit to tag | 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 index ccc954f10d5..0f1d1d3edfb 100644 --- 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 @@ -69,11 +69,11 @@ public TagCreation ref(String ref) { } /** - * reference to commit to tag + * the commit to tag * @return ref **/ @javax.annotation.Nonnull - @ApiModelProperty(required = true, value = "reference to commit to tag") + @ApiModelProperty(required = true, value = "the commit to tag") public String getRef() { return ref; diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml index fcf68c8a21d..7185d8c2851 100644 --- a/clients/java/api/openapi.yaml +++ b/clients/java/api/openapi.yaml @@ -6725,7 +6725,7 @@ components: description: ID of tag to create type: string ref: - description: reference to commit to tag + description: the commit to tag type: string required: - id diff --git a/clients/java/docs/TagCreation.md b/clients/java/docs/TagCreation.md index 1551044dab3..5ff2b8335b1 100644 --- a/clients/java/docs/TagCreation.md +++ b/clients/java/docs/TagCreation.md @@ -9,7 +9,7 @@ Make tag ID point at this REF. | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**id** | **String** | ID of tag to create | | -|**ref** | **String** | reference to commit to tag | | +|**ref** | **String** | the commit to tag | | 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 index aa7860aefbc..7b35c0e3aa3 100644 --- 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 @@ -91,7 +91,7 @@ public TagCreation ref(String ref) { } /** - * reference to commit to tag + * the commit to tag * @return ref **/ @javax.annotation.Nonnull diff --git a/clients/python-legacy/docs/TagCreation.md b/clients/python-legacy/docs/TagCreation.md index 6d09980488f..52786f34ef2 100644 --- a/clients/python-legacy/docs/TagCreation.md +++ b/clients/python-legacy/docs/TagCreation.md @@ -6,7 +6,7 @@ Make tag ID point at this REF. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ID of tag to create | -**ref** | **str** | reference to commit to tag | +**ref** | **str** | the commit to tag | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/clients/python-legacy/lakefs_client/model/tag_creation.py b/clients/python-legacy/lakefs_client/model/tag_creation.py index 6d622e49318..4b9d053d6bb 100644 --- a/clients/python-legacy/lakefs_client/model/tag_creation.py +++ b/clients/python-legacy/lakefs_client/model/tag_creation.py @@ -108,7 +108,7 @@ def _from_openapi_data(cls, id, ref, *args, **kwargs): # noqa: E501 Args: id (str): ID of tag to create - ref (str): reference to commit to tag + ref (str): the commit to tag Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -195,7 +195,7 @@ def __init__(self, id, ref, *args, **kwargs): # noqa: E501 Args: id (str): ID of tag to create - ref (str): reference to commit to tag + ref (str): the commit to tag Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/clients/python/docs/TagCreation.md b/clients/python/docs/TagCreation.md index 81c81c1c74a..bc5c7d81d24 100644 --- a/clients/python/docs/TagCreation.md +++ b/clients/python/docs/TagCreation.md @@ -7,7 +7,7 @@ Make tag ID point at this REF. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ID of tag to create | -**ref** | **str** | reference to commit to tag | +**ref** | **str** | the commit to tag | ## Example diff --git a/clients/python/lakefs_sdk/models/tag_creation.py b/clients/python/lakefs_sdk/models/tag_creation.py index 7e5721175db..8a89cb06d2c 100644 --- a/clients/python/lakefs_sdk/models/tag_creation.py +++ b/clients/python/lakefs_sdk/models/tag_creation.py @@ -27,7 +27,7 @@ class TagCreation(BaseModel): Make tag ID point at this REF. """ id: StrictStr = Field(..., description="ID of tag to create") - ref: StrictStr = Field(..., description="reference to commit to tag") + ref: StrictStr = Field(..., description="the commit to tag") __properties = ["id", "ref"] class Config: diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml index d54372d5f91..95eb699379f 100644 --- a/docs/assets/js/swagger.yml +++ b/docs/assets/js/swagger.yml @@ -595,7 +595,7 @@ components: description: ID of tag to create ref: type: string - description: reference to commit to tag + description: the commit to tag TaskInfo: type: object