From 519214eead046099f40ba7f89dd0e1a45cdd0894 Mon Sep 17 00:00:00 2001 From: Itai Admi Date: Mon, 9 Oct 2023 13:59:43 +0300 Subject: [PATCH] Add generated code and docs --- clients/java-legacy/api/openapi.yaml | 14 +++++++++++--- clients/java-legacy/docs/CommPrefsInput.md | 4 ++-- clients/java-legacy/docs/User.md | 6 +++--- .../lakefs/clients/api/model/CommPrefsInput.java | 8 ++++---- .../java/io/lakefs/clients/api/model/User.java | 12 ++++++------ clients/java/api/openapi.yaml | 14 +++++++++++--- clients/java/docs/CommPrefsInput.md | 4 ++-- clients/java/docs/User.md | 6 +++--- .../lakefs/clients/sdk/model/CommPrefsInput.java | 4 ++-- .../java/io/lakefs/clients/sdk/model/User.java | 6 +++--- clients/python-legacy/docs/CommPrefsInput.md | 4 ++-- clients/python-legacy/docs/User.md | 6 +++--- .../lakefs_client/model/comm_prefs_input.py | 8 ++++---- clients/python-legacy/lakefs_client/model/user.py | 12 ++++++------ clients/python/docs/CommPrefsInput.md | 4 ++-- clients/python/docs/User.md | 6 +++--- .../python/lakefs_sdk/models/comm_prefs_input.py | 4 ++-- clients/python/lakefs_sdk/models/user.py | 6 +++--- 18 files changed, 72 insertions(+), 56 deletions(-) diff --git a/clients/java-legacy/api/openapi.yaml b/clients/java-legacy/api/openapi.yaml index a71107ccfe5..f596d4e9cbe 100644 --- a/clients/java-legacy/api/openapi.yaml +++ b/clients/java-legacy/api/openapi.yaml @@ -6629,15 +6629,23 @@ components: email: email properties: id: - description: a unique identifier for the user. + description: A unique identifier for the user. Cannot be edited. type: string creation_date: description: Unix Epoch in seconds format: int64 type: integer friendly_name: + description: | + A shorter name for the user than the id. Unlike id it does not identify the user (it + might not be unique). Used in some places in the UI. type: string email: + description: "The email address of the user. If API authentication is enabled,\ + \ this field is mandatory and will be invited to login.\nIf API authentication\ + \ is disabled, this field will be ignored. All current APIAuthenticators\ + \ require the email to be \nlowercase and unique, although custom authenticators\ + \ may not enforce this.\n" type: string required: - creation_date @@ -6786,10 +6794,10 @@ components: description: the provided email type: string featureUpdates: - description: was "feature updates" checked + description: user preference to receive feature updates type: boolean securityUpdates: - description: was "security updates" checked + description: user preference to receive security updates type: boolean required: - featureUpdates diff --git a/clients/java-legacy/docs/CommPrefsInput.md b/clients/java-legacy/docs/CommPrefsInput.md index 1802f87fcde..8a9acd74c1c 100644 --- a/clients/java-legacy/docs/CommPrefsInput.md +++ b/clients/java-legacy/docs/CommPrefsInput.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **String** | the provided email | [optional] -**featureUpdates** | **Boolean** | was \"feature updates\" checked | -**securityUpdates** | **Boolean** | was \"security updates\" checked | +**featureUpdates** | **Boolean** | user preference to receive feature updates | +**securityUpdates** | **Boolean** | user preference to receive security updates | diff --git a/clients/java-legacy/docs/User.md b/clients/java-legacy/docs/User.md index 24f7172f6ef..f513abfabb5 100644 --- a/clients/java-legacy/docs/User.md +++ b/clients/java-legacy/docs/User.md @@ -7,10 +7,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | a unique identifier for the user. | +**id** | **String** | A unique identifier for the user. Cannot be edited. | **creationDate** | **Long** | Unix Epoch in seconds | -**friendlyName** | **String** | | [optional] -**email** | **String** | | [optional] +**friendlyName** | **String** | A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. | [optional] +**email** | **String** | The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. | [optional] diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/CommPrefsInput.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/CommPrefsInput.java index ff3e3b882cb..5d52648fe1a 100644 --- a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/CommPrefsInput.java +++ b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/CommPrefsInput.java @@ -72,11 +72,11 @@ public CommPrefsInput featureUpdates(Boolean featureUpdates) { } /** - * was \"feature updates\" checked + * user preference to receive feature updates * @return featureUpdates **/ @javax.annotation.Nonnull - @ApiModelProperty(required = true, value = "was \"feature updates\" checked") + @ApiModelProperty(required = true, value = "user preference to receive feature updates") public Boolean getFeatureUpdates() { return featureUpdates; @@ -95,11 +95,11 @@ public CommPrefsInput securityUpdates(Boolean securityUpdates) { } /** - * was \"security updates\" checked + * user preference to receive security updates * @return securityUpdates **/ @javax.annotation.Nonnull - @ApiModelProperty(required = true, value = "was \"security updates\" checked") + @ApiModelProperty(required = true, value = "user preference to receive security updates") public Boolean getSecurityUpdates() { return securityUpdates; diff --git a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/User.java b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/User.java index 2e560c3ced6..3becb40c2ec 100644 --- a/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/User.java +++ b/clients/java-legacy/src/main/java/io/lakefs/clients/api/model/User.java @@ -53,11 +53,11 @@ public User id(String id) { } /** - * a unique identifier for the user. + * A unique identifier for the user. Cannot be edited. * @return id **/ @javax.annotation.Nonnull - @ApiModelProperty(required = true, value = "a unique identifier for the user.") + @ApiModelProperty(required = true, value = "A unique identifier for the user. Cannot be edited.") public String getId() { return id; @@ -99,11 +99,11 @@ public User friendlyName(String friendlyName) { } /** - * Get friendlyName + * A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. * @return friendlyName **/ @javax.annotation.Nullable - @ApiModelProperty(value = "") + @ApiModelProperty(value = "A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. ") public String getFriendlyName() { return friendlyName; @@ -122,11 +122,11 @@ public User email(String email) { } /** - * Get email + * The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. * @return email **/ @javax.annotation.Nullable - @ApiModelProperty(value = "") + @ApiModelProperty(value = "The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. ") public String getEmail() { return email; diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml index d642305c73c..fe8e3d3e5ab 100644 --- a/clients/java/api/openapi.yaml +++ b/clients/java/api/openapi.yaml @@ -6603,15 +6603,23 @@ components: email: email properties: id: - description: a unique identifier for the user. + description: A unique identifier for the user. Cannot be edited. type: string creation_date: description: Unix Epoch in seconds format: int64 type: integer friendly_name: + description: | + A shorter name for the user than the id. Unlike id it does not identify the user (it + might not be unique). Used in some places in the UI. type: string email: + description: "The email address of the user. If API authentication is enabled,\ + \ this field is mandatory and will be invited to login.\nIf API authentication\ + \ is disabled, this field will be ignored. All current APIAuthenticators\ + \ require the email to be \nlowercase and unique, although custom authenticators\ + \ may not enforce this.\n" type: string required: - creation_date @@ -6760,10 +6768,10 @@ components: description: the provided email type: string featureUpdates: - description: was "feature updates" checked + description: user preference to receive feature updates type: boolean securityUpdates: - description: was "security updates" checked + description: user preference to receive security updates type: boolean required: - featureUpdates diff --git a/clients/java/docs/CommPrefsInput.md b/clients/java/docs/CommPrefsInput.md index db9e6b52bdb..dfb610b60ff 100644 --- a/clients/java/docs/CommPrefsInput.md +++ b/clients/java/docs/CommPrefsInput.md @@ -8,8 +8,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| |**email** | **String** | the provided email | [optional] | -|**featureUpdates** | **Boolean** | was \"feature updates\" checked | | -|**securityUpdates** | **Boolean** | was \"security updates\" checked | | +|**featureUpdates** | **Boolean** | user preference to receive feature updates | | +|**securityUpdates** | **Boolean** | user preference to receive security updates | | diff --git a/clients/java/docs/User.md b/clients/java/docs/User.md index f1fa3a908b7..2371dbc07d6 100644 --- a/clients/java/docs/User.md +++ b/clients/java/docs/User.md @@ -7,10 +7,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -|**id** | **String** | a unique identifier for the user. | | +|**id** | **String** | A unique identifier for the user. Cannot be edited. | | |**creationDate** | **Long** | Unix Epoch in seconds | | -|**friendlyName** | **String** | | [optional] | -|**email** | **String** | | [optional] | +|**friendlyName** | **String** | A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. | [optional] | +|**email** | **String** | The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. | [optional] | diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/CommPrefsInput.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/CommPrefsInput.java index 1f099f55388..7b183862a0c 100644 --- a/clients/java/src/main/java/io/lakefs/clients/sdk/model/CommPrefsInput.java +++ b/clients/java/src/main/java/io/lakefs/clients/sdk/model/CommPrefsInput.java @@ -95,7 +95,7 @@ public CommPrefsInput featureUpdates(Boolean featureUpdates) { } /** - * was \"feature updates\" checked + * user preference to receive feature updates * @return featureUpdates **/ @javax.annotation.Nonnull @@ -116,7 +116,7 @@ public CommPrefsInput securityUpdates(Boolean securityUpdates) { } /** - * was \"security updates\" checked + * user preference to receive security updates * @return securityUpdates **/ @javax.annotation.Nonnull diff --git a/clients/java/src/main/java/io/lakefs/clients/sdk/model/User.java b/clients/java/src/main/java/io/lakefs/clients/sdk/model/User.java index 102eff20e33..dbe4a28ea90 100644 --- a/clients/java/src/main/java/io/lakefs/clients/sdk/model/User.java +++ b/clients/java/src/main/java/io/lakefs/clients/sdk/model/User.java @@ -78,7 +78,7 @@ public User id(String id) { } /** - * a unique identifier for the user. + * A unique identifier for the user. Cannot be edited. * @return id **/ @javax.annotation.Nonnull @@ -120,7 +120,7 @@ public User friendlyName(String friendlyName) { } /** - * Get friendlyName + * A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. * @return friendlyName **/ @javax.annotation.Nullable @@ -141,7 +141,7 @@ public User email(String email) { } /** - * Get email + * The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. * @return email **/ @javax.annotation.Nullable diff --git a/clients/python-legacy/docs/CommPrefsInput.md b/clients/python-legacy/docs/CommPrefsInput.md index 7bb4a64be1b..462c5edc2c5 100644 --- a/clients/python-legacy/docs/CommPrefsInput.md +++ b/clients/python-legacy/docs/CommPrefsInput.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**feature_updates** | **bool** | was \"feature updates\" checked | -**security_updates** | **bool** | was \"security updates\" checked | +**feature_updates** | **bool** | user preference to receive feature updates | +**security_updates** | **bool** | user preference to receive security updates | **email** | **str** | the provided email | [optional] **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] diff --git a/clients/python-legacy/docs/User.md b/clients/python-legacy/docs/User.md index db1f15130d6..908cdb96d0e 100644 --- a/clients/python-legacy/docs/User.md +++ b/clients/python-legacy/docs/User.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | a unique identifier for the user. | +**id** | **str** | A unique identifier for the user. Cannot be edited. | **creation_date** | **int** | Unix Epoch in seconds | -**friendly_name** | **str** | | [optional] -**email** | **str** | | [optional] +**friendly_name** | **str** | A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. | [optional] +**email** | **str** | The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. | [optional] **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/comm_prefs_input.py b/clients/python-legacy/lakefs_client/model/comm_prefs_input.py index 43e7f337d70..78b3fd0f293 100644 --- a/clients/python-legacy/lakefs_client/model/comm_prefs_input.py +++ b/clients/python-legacy/lakefs_client/model/comm_prefs_input.py @@ -109,8 +109,8 @@ def _from_openapi_data(cls, feature_updates, security_updates, *args, **kwargs): """CommPrefsInput - a model defined in OpenAPI Args: - feature_updates (bool): was \"feature updates\" checked - security_updates (bool): was \"security updates\" checked + feature_updates (bool): user preference to receive feature updates + security_updates (bool): user preference to receive security updates Keyword Args: _check_type (bool): if True, values for parameters in openapi_types @@ -197,8 +197,8 @@ def __init__(self, feature_updates, security_updates, *args, **kwargs): # noqa: """CommPrefsInput - a model defined in OpenAPI Args: - feature_updates (bool): was \"feature updates\" checked - security_updates (bool): was \"security updates\" checked + feature_updates (bool): user preference to receive feature updates + security_updates (bool): user preference to receive security updates Keyword Args: _check_type (bool): if True, values for parameters in openapi_types diff --git a/clients/python-legacy/lakefs_client/model/user.py b/clients/python-legacy/lakefs_client/model/user.py index 7d5bdfd4894..8c5289e3734 100644 --- a/clients/python-legacy/lakefs_client/model/user.py +++ b/clients/python-legacy/lakefs_client/model/user.py @@ -111,7 +111,7 @@ def _from_openapi_data(cls, id, creation_date, *args, **kwargs): # noqa: E501 """User - a model defined in OpenAPI Args: - id (str): a unique identifier for the user. + id (str): A unique identifier for the user. Cannot be edited. creation_date (int): Unix Epoch in seconds Keyword Args: @@ -145,8 +145,8 @@ def _from_openapi_data(cls, id, creation_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - friendly_name (str): [optional] # noqa: E501 - email (str): [optional] # noqa: E501 + friendly_name (str): A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. . [optional] # noqa: E501 + email (str): The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. . [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) @@ -200,7 +200,7 @@ def __init__(self, id, creation_date, *args, **kwargs): # noqa: E501 """User - a model defined in OpenAPI Args: - id (str): a unique identifier for the user. + id (str): A unique identifier for the user. Cannot be edited. creation_date (int): Unix Epoch in seconds Keyword Args: @@ -234,8 +234,8 @@ def __init__(self, id, creation_date, *args, **kwargs): # noqa: E501 Animal class but this time we won't travel through its discriminator because we passed in _visited_composed_classes = (Animal,) - friendly_name (str): [optional] # noqa: E501 - email (str): [optional] # noqa: E501 + friendly_name (str): A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. . [optional] # noqa: E501 + email (str): The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. . [optional] # noqa: E501 """ _check_type = kwargs.pop('_check_type', True) diff --git a/clients/python/docs/CommPrefsInput.md b/clients/python/docs/CommPrefsInput.md index 404b53894fd..4453614a5fa 100644 --- a/clients/python/docs/CommPrefsInput.md +++ b/clients/python/docs/CommPrefsInput.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | the provided email | [optional] -**feature_updates** | **bool** | was \"feature updates\" checked | -**security_updates** | **bool** | was \"security updates\" checked | +**feature_updates** | **bool** | user preference to receive feature updates | +**security_updates** | **bool** | user preference to receive security updates | ## Example diff --git a/clients/python/docs/User.md b/clients/python/docs/User.md index 0d3053f946d..dc056c73663 100644 --- a/clients/python/docs/User.md +++ b/clients/python/docs/User.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **str** | a unique identifier for the user. | +**id** | **str** | A unique identifier for the user. Cannot be edited. | **creation_date** | **int** | Unix Epoch in seconds | -**friendly_name** | **str** | | [optional] -**email** | **str** | | [optional] +**friendly_name** | **str** | A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. | [optional] +**email** | **str** | The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. | [optional] ## Example diff --git a/clients/python/lakefs_sdk/models/comm_prefs_input.py b/clients/python/lakefs_sdk/models/comm_prefs_input.py index ad79235cb05..bea92cbbee7 100644 --- a/clients/python/lakefs_sdk/models/comm_prefs_input.py +++ b/clients/python/lakefs_sdk/models/comm_prefs_input.py @@ -27,8 +27,8 @@ class CommPrefsInput(BaseModel): CommPrefsInput """ email: Optional[StrictStr] = Field(None, description="the provided email") - feature_updates: StrictBool = Field(..., alias="featureUpdates", description="was \"feature updates\" checked") - security_updates: StrictBool = Field(..., alias="securityUpdates", description="was \"security updates\" checked") + feature_updates: StrictBool = Field(..., alias="featureUpdates", description="user preference to receive feature updates") + security_updates: StrictBool = Field(..., alias="securityUpdates", description="user preference to receive security updates") __properties = ["email", "featureUpdates", "securityUpdates"] class Config: diff --git a/clients/python/lakefs_sdk/models/user.py b/clients/python/lakefs_sdk/models/user.py index c3d6dbdc1be..8280240a056 100644 --- a/clients/python/lakefs_sdk/models/user.py +++ b/clients/python/lakefs_sdk/models/user.py @@ -26,10 +26,10 @@ class User(BaseModel): """ User """ - id: StrictStr = Field(..., description="a unique identifier for the user.") + id: StrictStr = Field(..., description="A unique identifier for the user. Cannot be edited.") creation_date: StrictInt = Field(..., description="Unix Epoch in seconds") - friendly_name: Optional[StrictStr] = None - email: Optional[StrictStr] = None + friendly_name: Optional[StrictStr] = Field(None, description="A shorter name for the user than the id. Unlike id it does not identify the user (it might not be unique). Used in some places in the UI. ") + email: Optional[StrictStr] = Field(None, description="The email address of the user. If API authentication is enabled, this field is mandatory and will be invited to login. If API authentication is disabled, this field will be ignored. All current APIAuthenticators require the email to be lowercase and unique, although custom authenticators may not enforce this. ") __properties = ["id", "creation_date", "friendly_name", "email"] class Config: