From 897a063d800795b6f8c80f2c1198bdbe702f9882 Mon Sep 17 00:00:00 2001 From: Barak Amar Date: Mon, 11 Sep 2023 14:23:15 +0300 Subject: [PATCH] api: switch api that used for internal --- api/swagger.yml | 18 +- clients/java/README.md | 18 +- clients/java/api/openapi.yaml | 18 +- clients/java/docs/AuthApi.md | 58 - clients/java/docs/ConfigApi.md | 185 --- clients/java/docs/InternalApi.md | 718 ++++++++++ clients/java/docs/ObjectsApi.md | 96 -- clients/java/docs/RepositoriesApi.md | 92 -- clients/java/docs/RetentionApi.md | 91 -- clients/java/docs/StagingApi.md | 97 -- clients/java/docs/StatisticsApi.md | 99 -- .../java/io/lakefs/clients/api/AuthApi.java | 107 -- .../java/io/lakefs/clients/api/ConfigApi.java | 352 ----- .../io/lakefs/clients/api/InternalApi.java | 1175 +++++++++++++++++ .../io/lakefs/clients/api/ObjectsApi.java | 147 --- .../lakefs/clients/api/RepositoriesApi.java | 124 -- .../io/lakefs/clients/api/RetentionApi.java | 120 -- .../io/lakefs/clients/api/StagingApi.java | 148 --- .../io/lakefs/clients/api/StatisticsApi.java | 177 --- .../io/lakefs/clients/api/AuthApiTest.java | 15 - .../io/lakefs/clients/api/ConfigApiTest.java | 48 - .../lakefs/clients/api/InternalApiTest.java | 179 +++ .../io/lakefs/clients/api/ObjectsApiTest.java | 17 - .../clients/api/RepositoriesApiTest.java | 15 - .../lakefs/clients/api/RetentionApiTest.java | 15 - .../io/lakefs/clients/api/StagingApiTest.java | 18 - .../lakefs/clients/api/StatisticsApiTest.java | 51 - clients/python/.openapi-generator/FILES | 6 +- clients/python/README.md | 18 +- clients/python/docs/AuthApi.md | 64 - clients/python/docs/ConfigApi.md | 214 --- clients/python/docs/InternalApi.md | 837 ++++++++++++ clients/python/docs/ObjectsApi.md | 110 -- clients/python/docs/RepositoriesApi.md | 106 -- clients/python/docs/RetentionApi.md | 105 -- clients/python/docs/StagingApi.md | 115 -- clients/python/docs/StatisticsApi.md | 123 -- clients/python/lakefs_client/api/auth_api.py | 103 -- .../python/lakefs_client/api/config_api.py | 336 ----- .../python/lakefs_client/api/internal_api.py | 1122 ++++++++++++++++ .../python/lakefs_client/api/objects_api.py | 140 -- .../lakefs_client/api/repositories_api.py | 120 -- .../python/lakefs_client/api/retention_api.py | 120 -- .../python/lakefs_client/api/staging_api.py | 142 -- .../lakefs_client/api/statistics_api.py | 161 --- clients/python/lakefs_client/apis/__init__.py | 2 +- clients/python/lakefs_client/client.py | 4 +- clients/python/test/test_auth_api.py | 7 - clients/python/test/test_config_api.py | 21 - clients/python/test/test_internal_api.py | 89 ++ clients/python/test/test_objects_api.py | 6 - clients/python/test/test_repositories_api.py | 6 - clients/python/test/test_retention_api.py | 6 - clients/python/test/test_staging_api.py | 7 - clients/python/test/test_statistics_api.py | 36 - docs/assets/js/swagger.yml | 18 +- 56 files changed, 4171 insertions(+), 4171 deletions(-) create mode 100644 clients/java/docs/InternalApi.md delete mode 100644 clients/java/docs/StatisticsApi.md create mode 100644 clients/java/src/main/java/io/lakefs/clients/api/InternalApi.java delete mode 100644 clients/java/src/main/java/io/lakefs/clients/api/StatisticsApi.java create mode 100644 clients/java/src/test/java/io/lakefs/clients/api/InternalApiTest.java delete mode 100644 clients/java/src/test/java/io/lakefs/clients/api/StatisticsApiTest.java create mode 100644 clients/python/docs/InternalApi.md delete mode 100644 clients/python/docs/StatisticsApi.md create mode 100644 clients/python/lakefs_client/api/internal_api.py delete mode 100644 clients/python/lakefs_client/api/statistics_api.py create mode 100644 clients/python/test/test_internal_api.py delete mode 100644 clients/python/test/test_statistics_api.py diff --git a/api/swagger.yml b/api/swagger.yml index 06c5368bef9..0093fa7e250 100644 --- a/api/swagger.yml +++ b/api/swagger.yml @@ -1470,7 +1470,7 @@ paths: /setup_comm_prefs: post: tags: - - config + - internal operationId: setupCommPrefs summary: setup communications preferences security: [] @@ -1501,7 +1501,7 @@ paths: /setup_lakefs: get: tags: - - config + - internal operationId: getSetupState summary: check if the lakeFS installation is already set up security: [] @@ -1516,7 +1516,7 @@ paths: $ref: "#/components/responses/ServerError" post: tags: - - config + - internal operationId: setup summary: setup lakeFS and create a first user security: [] @@ -1633,7 +1633,7 @@ paths: /auth/capabilities: get: tags: - - auth + - internal operationId: getAuthCapabilities summary: list authentication capabilities supported security: [] @@ -3620,7 +3620,7 @@ paths: type: string put: tags: - - staging + - internal operationId: updateBranchToken summary: modify branch staging token requestBody: @@ -3663,7 +3663,7 @@ paths: type: string get: tags: - - objects + - internal operationId: uploadObjectPreflight responses: 204: @@ -4269,7 +4269,7 @@ paths: type: string get: tags: - - retention + - internal operationId: setGarbageCollectionRulesPreflight responses: 204: @@ -4412,7 +4412,7 @@ paths: type: string get: tags: - - repositories + - internal operationId: createBranchProtectionRulePreflight responses: 204: @@ -4593,7 +4593,7 @@ paths: /statistics: post: tags: - - statistics + - internal operationId: postStatsEvents summary: post stats events, this endpoint is meant for internal use only requestBody: diff --git a/clients/java/README.md b/clients/java/README.md index 287a583d0fc..9d8f701f9d9 100644 --- a/clients/java/README.md +++ b/clients/java/README.md @@ -154,7 +154,6 @@ Class | Method | HTTP request | Description *AuthApi* | [**detachPolicyFromGroup**](docs/AuthApi.md#detachPolicyFromGroup) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group *AuthApi* | [**detachPolicyFromUser**](docs/AuthApi.md#detachPolicyFromUser) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user *AuthApi* | [**forgotPassword**](docs/AuthApi.md#forgotPassword) | **POST** /auth/password/forgot | forgot password request initiates the password reset process -*AuthApi* | [**getAuthCapabilities**](docs/AuthApi.md#getAuthCapabilities) | **GET** /auth/capabilities | list authentication capabilities supported *AuthApi* | [**getCredentials**](docs/AuthApi.md#getCredentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials *AuthApi* | [**getCurrentUser**](docs/AuthApi.md#getCurrentUser) | **GET** /user | get current user *AuthApi* | [**getGroup**](docs/AuthApi.md#getGroup) | **GET** /auth/groups/{groupId} | get group @@ -185,10 +184,7 @@ Class | Method | HTTP request | Description *CommitsApi* | [**getCommit**](docs/CommitsApi.md#getCommit) | **GET** /repositories/{repository}/commits/{commitId} | get commit *ConfigApi* | [**getGarbageCollectionConfig**](docs/ConfigApi.md#getGarbageCollectionConfig) | **GET** /config/garbage-collection | *ConfigApi* | [**getLakeFSVersion**](docs/ConfigApi.md#getLakeFSVersion) | **GET** /config/version | -*ConfigApi* | [**getSetupState**](docs/ConfigApi.md#getSetupState) | **GET** /setup_lakefs | check if the lakeFS installation is already set up *ConfigApi* | [**getStorageConfig**](docs/ConfigApi.md#getStorageConfig) | **GET** /config/storage | -*ConfigApi* | [**setup**](docs/ConfigApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user -*ConfigApi* | [**setupCommPrefs**](docs/ConfigApi.md#setupCommPrefs) | **POST** /setup_comm_prefs | setup communications preferences *ExperimentalApi* | [**getOtfDiffs**](docs/ExperimentalApi.md#getOtfDiffs) | **GET** /otf/diffs | get the available Open Table Format diffs *ExperimentalApi* | [**otfDiff**](docs/ExperimentalApi.md#otfDiff) | **GET** /repositories/{repository}/otf/refs/{left_ref}/diff/{right_ref} | perform otf diff *HealthCheckApi* | [**healthCheck**](docs/HealthCheckApi.md#healthCheck) | **GET** /healthcheck | @@ -197,6 +193,15 @@ Class | Method | HTTP request | Description *ImportApi* | [**importStart**](docs/ImportApi.md#importStart) | **POST** /repositories/{repository}/branches/{branch}/import | import data from object store *ImportApi* | [**importStatus**](docs/ImportApi.md#importStatus) | **GET** /repositories/{repository}/branches/{branch}/import | get import status *ImportApi* | [**ingestRange**](docs/ImportApi.md#ingestRange) | **POST** /repositories/{repository}/branches/ranges | create a lakeFS range file from the source uri +*InternalApi* | [**createBranchProtectionRulePreflight**](docs/InternalApi.md#createBranchProtectionRulePreflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | +*InternalApi* | [**getAuthCapabilities**](docs/InternalApi.md#getAuthCapabilities) | **GET** /auth/capabilities | list authentication capabilities supported +*InternalApi* | [**getSetupState**](docs/InternalApi.md#getSetupState) | **GET** /setup_lakefs | check if the lakeFS installation is already set up +*InternalApi* | [**postStatsEvents**](docs/InternalApi.md#postStatsEvents) | **POST** /statistics | post stats events, this endpoint is meant for internal use only +*InternalApi* | [**setGarbageCollectionRulesPreflight**](docs/InternalApi.md#setGarbageCollectionRulesPreflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | +*InternalApi* | [**setup**](docs/InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user +*InternalApi* | [**setupCommPrefs**](docs/InternalApi.md#setupCommPrefs) | **POST** /setup_comm_prefs | setup communications preferences +*InternalApi* | [**updateBranchToken**](docs/InternalApi.md#updateBranchToken) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token +*InternalApi* | [**uploadObjectPreflight**](docs/InternalApi.md#uploadObjectPreflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | *MetadataApi* | [**createSymlinkFile**](docs/MetadataApi.md#createSymlinkFile) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory *MetadataApi* | [**getMetaRange**](docs/MetadataApi.md#getMetaRange) | **GET** /repositories/{repository}/metadata/meta_range/{meta_range} | return URI to a meta-range file *MetadataApi* | [**getRange**](docs/MetadataApi.md#getRange) | **GET** /repositories/{repository}/metadata/range/{range} | return URI to a range file @@ -210,7 +215,6 @@ Class | Method | HTTP request | Description *ObjectsApi* | [**stageObject**](docs/ObjectsApi.md#stageObject) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch *ObjectsApi* | [**statObject**](docs/ObjectsApi.md#statObject) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata *ObjectsApi* | [**uploadObject**](docs/ObjectsApi.md#uploadObject) | **POST** /repositories/{repository}/branches/{branch}/objects | -*ObjectsApi* | [**uploadObjectPreflight**](docs/ObjectsApi.md#uploadObjectPreflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | *RefsApi* | [**diffRefs**](docs/RefsApi.md#diffRefs) | **GET** /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references *RefsApi* | [**dumpRefs**](docs/RefsApi.md#dumpRefs) | **PUT** /repositories/{repository}/refs/dump | Dump repository refs (tags, commits, branches) to object store *RefsApi* | [**findMergeBase**](docs/RefsApi.md#findMergeBase) | **GET** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | find the merge base for 2 references @@ -218,7 +222,6 @@ Class | Method | HTTP request | Description *RefsApi* | [**mergeIntoBranch**](docs/RefsApi.md#mergeIntoBranch) | **POST** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | merge references *RefsApi* | [**restoreRefs**](docs/RefsApi.md#restoreRefs) | **PUT** /repositories/{repository}/refs/restore | Restore repository refs (tags, commits, branches) from object store *RepositoriesApi* | [**createBranchProtectionRule**](docs/RepositoriesApi.md#createBranchProtectionRule) | **POST** /repositories/{repository}/branch_protection | -*RepositoriesApi* | [**createBranchProtectionRulePreflight**](docs/RepositoriesApi.md#createBranchProtectionRulePreflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | *RepositoriesApi* | [**createRepository**](docs/RepositoriesApi.md#createRepository) | **POST** /repositories | create repository *RepositoriesApi* | [**deleteBranchProtectionRule**](docs/RepositoriesApi.md#deleteBranchProtectionRule) | **DELETE** /repositories/{repository}/branch_protection | *RepositoriesApi* | [**deleteRepository**](docs/RepositoriesApi.md#deleteRepository) | **DELETE** /repositories/{repository} | delete repository @@ -231,11 +234,8 @@ Class | Method | HTTP request | Description *RetentionApi* | [**prepareGarbageCollectionCommits**](docs/RetentionApi.md#prepareGarbageCollectionCommits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active and expired commits for garbage collection *RetentionApi* | [**prepareGarbageCollectionUncommitted**](docs/RetentionApi.md#prepareGarbageCollectionUncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection *RetentionApi* | [**setGarbageCollectionRules**](docs/RetentionApi.md#setGarbageCollectionRules) | **POST** /repositories/{repository}/gc/rules | -*RetentionApi* | [**setGarbageCollectionRulesPreflight**](docs/RetentionApi.md#setGarbageCollectionRulesPreflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | *StagingApi* | [**getPhysicalAddress**](docs/StagingApi.md#getPhysicalAddress) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | get a physical address and a return token to write object to underlying storage *StagingApi* | [**linkPhysicalAddress**](docs/StagingApi.md#linkPhysicalAddress) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path -*StagingApi* | [**updateBranchToken**](docs/StagingApi.md#updateBranchToken) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token -*StatisticsApi* | [**postStatsEvents**](docs/StatisticsApi.md#postStatsEvents) | **POST** /statistics | post stats events, this endpoint is meant for internal use only *TagsApi* | [**createTag**](docs/TagsApi.md#createTag) | **POST** /repositories/{repository}/tags | create tag *TagsApi* | [**deleteTag**](docs/TagsApi.md#deleteTag) | **DELETE** /repositories/{repository}/tags/{tag} | delete tag *TagsApi* | [**getTag**](docs/TagsApi.md#getTag) | **GET** /repositories/{repository}/tags/{tag} | get tag diff --git a/clients/java/api/openapi.yaml b/clients/java/api/openapi.yaml index 8fd33956f4d..f596adac701 100644 --- a/clients/java/api/openapi.yaml +++ b/clients/java/api/openapi.yaml @@ -49,7 +49,7 @@ paths: security: [] summary: setup communications preferences tags: - - config + - internal x-contentType: application/json x-accepts: application/json /setup_lakefs: @@ -71,7 +71,7 @@ paths: security: [] summary: check if the lakeFS installation is already set up tags: - - config + - internal x-accepts: application/json post: operationId: setup @@ -109,7 +109,7 @@ paths: security: [] summary: setup lakeFS and create a first user tags: - - config + - internal x-contentType: application/json x-accepts: application/json /user: @@ -246,7 +246,7 @@ paths: security: [] summary: list authentication capabilities supported tags: - - auth + - internal x-accepts: application/json /auth/users: get: @@ -3941,7 +3941,7 @@ paths: description: Internal Server Error summary: modify branch staging token tags: - - staging + - internal x-contentType: application/json x-accepts: application/json /repositories/{repository}/branches/{branch}/objects/stage_allowed: @@ -4000,7 +4000,7 @@ paths: $ref: '#/components/schemas/Error' description: Internal Server Error tags: - - objects + - internal x-accepts: application/json /repositories/{repository}/branches/{branch}/objects: delete: @@ -5034,7 +5034,7 @@ paths: $ref: '#/components/schemas/Error' description: Internal Server Error tags: - - retention + - internal x-accepts: application/json /repositories/{repository}/gc/rules: delete: @@ -5288,7 +5288,7 @@ paths: $ref: '#/components/schemas/Error' description: Internal Server Error tags: - - repositories + - internal x-accepts: application/json /repositories/{repository}/branch_protection: delete: @@ -5577,7 +5577,7 @@ paths: description: Internal Server Error summary: post stats events, this endpoint is meant for internal use only tags: - - statistics + - internal x-contentType: application/json x-accepts: application/json components: diff --git a/clients/java/docs/AuthApi.md b/clients/java/docs/AuthApi.md index e91b7d12d3a..02dd8998e57 100644 --- a/clients/java/docs/AuthApi.md +++ b/clients/java/docs/AuthApi.md @@ -19,7 +19,6 @@ Method | HTTP request | Description [**detachPolicyFromGroup**](AuthApi.md#detachPolicyFromGroup) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group [**detachPolicyFromUser**](AuthApi.md#detachPolicyFromUser) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user [**forgotPassword**](AuthApi.md#forgotPassword) | **POST** /auth/password/forgot | forgot password request initiates the password reset process -[**getAuthCapabilities**](AuthApi.md#getAuthCapabilities) | **GET** /auth/capabilities | list authentication capabilities supported [**getCredentials**](AuthApi.md#getCredentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials [**getCurrentUser**](AuthApi.md#getCurrentUser) | **GET** /user | get current user [**getGroup**](AuthApi.md#getGroup) | **GET** /auth/groups/{groupId} | get group @@ -1381,63 +1380,6 @@ No authorization required **400** | Bad Request | - | **0** | Internal Server Error | - | - -# **getAuthCapabilities** -> AuthCapabilities getAuthCapabilities() - -list authentication capabilities supported - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.AuthApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - AuthApi apiInstance = new AuthApi(defaultClient); - try { - AuthCapabilities result = apiInstance.getAuthCapabilities(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AuthApi#getAuthCapabilities"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**AuthCapabilities**](AuthCapabilities.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | auth capabilities | - | -**0** | Internal Server Error | - | - # **getCredentials** > Credentials getCredentials(userId, accessKeyId) diff --git a/clients/java/docs/ConfigApi.md b/clients/java/docs/ConfigApi.md index ea2d029bd75..db0d43749a8 100644 --- a/clients/java/docs/ConfigApi.md +++ b/clients/java/docs/ConfigApi.md @@ -6,10 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**getGarbageCollectionConfig**](ConfigApi.md#getGarbageCollectionConfig) | **GET** /config/garbage-collection | [**getLakeFSVersion**](ConfigApi.md#getLakeFSVersion) | **GET** /config/version | -[**getSetupState**](ConfigApi.md#getSetupState) | **GET** /setup_lakefs | check if the lakeFS installation is already set up [**getStorageConfig**](ConfigApi.md#getStorageConfig) | **GET** /config/storage | -[**setup**](ConfigApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user -[**setupCommPrefs**](ConfigApi.md#setupCommPrefs) | **POST** /setup_comm_prefs | setup communications preferences @@ -186,63 +183,6 @@ This endpoint does not need any parameter. **200** | lakeFS version | - | **401** | Unauthorized | - | - -# **getSetupState** -> SetupState getSetupState() - -check if the lakeFS installation is already set up - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.ConfigApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - ConfigApi apiInstance = new ConfigApi(defaultClient); - try { - SetupState result = apiInstance.getSetupState(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ConfigApi#getSetupState"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SetupState**](SetupState.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | lakeFS setup state | - | -**0** | Internal Server Error | - | - # **getStorageConfig** > StorageConfig getStorageConfig() @@ -330,128 +270,3 @@ This endpoint does not need any parameter. **200** | lakeFS storage configuration | - | **401** | Unauthorized | - | - -# **setup** -> CredentialsWithSecret setup(setup) - -setup lakeFS and create a first user - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.ConfigApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - ConfigApi apiInstance = new ConfigApi(defaultClient); - Setup setup = new Setup(); // Setup | - try { - CredentialsWithSecret result = apiInstance.setup(setup); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling ConfigApi#setup"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **setup** | [**Setup**](Setup.md)| | - -### Return type - -[**CredentialsWithSecret**](CredentialsWithSecret.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | user created successfully | - | -**400** | Bad Request | - | -**409** | setup was already called | - | -**0** | Internal Server Error | - | - - -# **setupCommPrefs** -> setupCommPrefs(commPrefsInput) - -setup communications preferences - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.ConfigApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - ConfigApi apiInstance = new ConfigApi(defaultClient); - CommPrefsInput commPrefsInput = new CommPrefsInput(); // CommPrefsInput | - try { - apiInstance.setupCommPrefs(commPrefsInput); - } catch (ApiException e) { - System.err.println("Exception when calling ConfigApi#setupCommPrefs"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **commPrefsInput** | [**CommPrefsInput**](CommPrefsInput.md)| | - -### Return type - -null (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | communication preferences saved successfully | - | -**409** | setup was already completed | - | -**412** | wrong setup state for this operation | - | -**0** | Internal Server Error | - | - diff --git a/clients/java/docs/InternalApi.md b/clients/java/docs/InternalApi.md new file mode 100644 index 00000000000..ba761086508 --- /dev/null +++ b/clients/java/docs/InternalApi.md @@ -0,0 +1,718 @@ +# InternalApi + +All URIs are relative to *http://localhost/api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createBranchProtectionRulePreflight**](InternalApi.md#createBranchProtectionRulePreflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | +[**getAuthCapabilities**](InternalApi.md#getAuthCapabilities) | **GET** /auth/capabilities | list authentication capabilities supported +[**getSetupState**](InternalApi.md#getSetupState) | **GET** /setup_lakefs | check if the lakeFS installation is already set up +[**postStatsEvents**](InternalApi.md#postStatsEvents) | **POST** /statistics | post stats events, this endpoint is meant for internal use only +[**setGarbageCollectionRulesPreflight**](InternalApi.md#setGarbageCollectionRulesPreflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | +[**setup**](InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user +[**setupCommPrefs**](InternalApi.md#setupCommPrefs) | **POST** /setup_comm_prefs | setup communications preferences +[**updateBranchToken**](InternalApi.md#updateBranchToken) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token +[**uploadObjectPreflight**](InternalApi.md#uploadObjectPreflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | + + + +# **createBranchProtectionRulePreflight** +> createBranchProtectionRulePreflight(repository) + + + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.auth.*; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + // Configure HTTP basic authorization: basic_auth + HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); + basic_auth.setUsername("YOUR USERNAME"); + basic_auth.setPassword("YOUR PASSWORD"); + + // Configure API key authorization: cookie_auth + ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); + cookie_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //cookie_auth.setApiKeyPrefix("Token"); + + // Configure HTTP bearer authorization: jwt_token + HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); + jwt_token.setBearerToken("BEARER TOKEN"); + + // Configure API key authorization: oidc_auth + ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); + oidc_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //oidc_auth.setApiKeyPrefix("Token"); + + // Configure API key authorization: saml_auth + ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); + saml_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //saml_auth.setApiKeyPrefix("Token"); + + InternalApi apiInstance = new InternalApi(defaultClient); + String repository = "repository_example"; // String | + try { + apiInstance.createBranchProtectionRulePreflight(repository); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#createBranchProtectionRulePreflight"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **String**| | + +### Return type + +null (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | User has permissions to create a branch protection rule in this repository | - | +**401** | Unauthorized | - | +**404** | Resource Not Found | - | +**409** | Resource Conflicts With Target | - | +**0** | Internal Server Error | - | + + +# **getAuthCapabilities** +> AuthCapabilities getAuthCapabilities() + +list authentication capabilities supported + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + InternalApi apiInstance = new InternalApi(defaultClient); + try { + AuthCapabilities result = apiInstance.getAuthCapabilities(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#getAuthCapabilities"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**AuthCapabilities**](AuthCapabilities.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | auth capabilities | - | +**0** | Internal Server Error | - | + + +# **getSetupState** +> SetupState getSetupState() + +check if the lakeFS installation is already set up + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + InternalApi apiInstance = new InternalApi(defaultClient); + try { + SetupState result = apiInstance.getSetupState(); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#getSetupState"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**SetupState**](SetupState.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | lakeFS setup state | - | +**0** | Internal Server Error | - | + + +# **postStatsEvents** +> postStatsEvents(statsEventsList) + +post stats events, this endpoint is meant for internal use only + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.auth.*; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + // Configure HTTP basic authorization: basic_auth + HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); + basic_auth.setUsername("YOUR USERNAME"); + basic_auth.setPassword("YOUR PASSWORD"); + + // Configure API key authorization: cookie_auth + ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); + cookie_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //cookie_auth.setApiKeyPrefix("Token"); + + // Configure HTTP bearer authorization: jwt_token + HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); + jwt_token.setBearerToken("BEARER TOKEN"); + + // Configure API key authorization: oidc_auth + ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); + oidc_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //oidc_auth.setApiKeyPrefix("Token"); + + // Configure API key authorization: saml_auth + ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); + saml_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //saml_auth.setApiKeyPrefix("Token"); + + InternalApi apiInstance = new InternalApi(defaultClient); + StatsEventsList statsEventsList = new StatsEventsList(); // StatsEventsList | + try { + apiInstance.postStatsEvents(statsEventsList); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#postStatsEvents"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **statsEventsList** | [**StatsEventsList**](StatsEventsList.md)| | + +### Return type + +null (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | reported successfully | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**0** | Internal Server Error | - | + + +# **setGarbageCollectionRulesPreflight** +> setGarbageCollectionRulesPreflight(repository) + + + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.auth.*; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + // Configure HTTP basic authorization: basic_auth + HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); + basic_auth.setUsername("YOUR USERNAME"); + basic_auth.setPassword("YOUR PASSWORD"); + + // Configure API key authorization: cookie_auth + ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); + cookie_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //cookie_auth.setApiKeyPrefix("Token"); + + // Configure HTTP bearer authorization: jwt_token + HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); + jwt_token.setBearerToken("BEARER TOKEN"); + + // Configure API key authorization: oidc_auth + ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); + oidc_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //oidc_auth.setApiKeyPrefix("Token"); + + // Configure API key authorization: saml_auth + ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); + saml_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //saml_auth.setApiKeyPrefix("Token"); + + InternalApi apiInstance = new InternalApi(defaultClient); + String repository = "repository_example"; // String | + try { + apiInstance.setGarbageCollectionRulesPreflight(repository); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#setGarbageCollectionRulesPreflight"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **String**| | + +### Return type + +null (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | User has permissions to set garbage collection rules on this repository | - | +**401** | Unauthorized | - | +**404** | Resource Not Found | - | +**0** | Internal Server Error | - | + + +# **setup** +> CredentialsWithSecret setup(setup) + +setup lakeFS and create a first user + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + InternalApi apiInstance = new InternalApi(defaultClient); + Setup setup = new Setup(); // Setup | + try { + CredentialsWithSecret result = apiInstance.setup(setup); + System.out.println(result); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#setup"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setup** | [**Setup**](Setup.md)| | + +### Return type + +[**CredentialsWithSecret**](CredentialsWithSecret.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | user created successfully | - | +**400** | Bad Request | - | +**409** | setup was already called | - | +**0** | Internal Server Error | - | + + +# **setupCommPrefs** +> setupCommPrefs(commPrefsInput) + +setup communications preferences + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + InternalApi apiInstance = new InternalApi(defaultClient); + CommPrefsInput commPrefsInput = new CommPrefsInput(); // CommPrefsInput | + try { + apiInstance.setupCommPrefs(commPrefsInput); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#setupCommPrefs"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **commPrefsInput** | [**CommPrefsInput**](CommPrefsInput.md)| | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | communication preferences saved successfully | - | +**409** | setup was already completed | - | +**412** | wrong setup state for this operation | - | +**0** | Internal Server Error | - | + + +# **updateBranchToken** +> updateBranchToken(repository, branch, updateToken) + +modify branch staging token + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.auth.*; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + // Configure HTTP basic authorization: basic_auth + HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); + basic_auth.setUsername("YOUR USERNAME"); + basic_auth.setPassword("YOUR PASSWORD"); + + // Configure API key authorization: cookie_auth + ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); + cookie_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //cookie_auth.setApiKeyPrefix("Token"); + + // Configure HTTP bearer authorization: jwt_token + HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); + jwt_token.setBearerToken("BEARER TOKEN"); + + // Configure API key authorization: oidc_auth + ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); + oidc_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //oidc_auth.setApiKeyPrefix("Token"); + + // Configure API key authorization: saml_auth + ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); + saml_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //saml_auth.setApiKeyPrefix("Token"); + + InternalApi apiInstance = new InternalApi(defaultClient); + String repository = "repository_example"; // String | + String branch = "branch_example"; // String | + UpdateToken updateToken = new UpdateToken(); // UpdateToken | + try { + apiInstance.updateBranchToken(repository, branch, updateToken); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#updateBranchToken"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **String**| | + **branch** | **String**| | + **updateToken** | [**UpdateToken**](UpdateToken.md)| | + +### Return type + +null (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | branch updated successfully | - | +**400** | Validation Error | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Resource Not Found | - | +**0** | Internal Server Error | - | + + +# **uploadObjectPreflight** +> uploadObjectPreflight(repository, branch, path) + + + +### Example +```java +// Import classes: +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.auth.*; +import io.lakefs.clients.api.models.*; +import io.lakefs.clients.api.InternalApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://localhost/api/v1"); + + // Configure HTTP basic authorization: basic_auth + HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); + basic_auth.setUsername("YOUR USERNAME"); + basic_auth.setPassword("YOUR PASSWORD"); + + // Configure API key authorization: cookie_auth + ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); + cookie_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //cookie_auth.setApiKeyPrefix("Token"); + + // Configure HTTP bearer authorization: jwt_token + HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); + jwt_token.setBearerToken("BEARER TOKEN"); + + // Configure API key authorization: oidc_auth + ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); + oidc_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //oidc_auth.setApiKeyPrefix("Token"); + + // Configure API key authorization: saml_auth + ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); + saml_auth.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //saml_auth.setApiKeyPrefix("Token"); + + InternalApi apiInstance = new InternalApi(defaultClient); + String repository = "repository_example"; // String | + String branch = "branch_example"; // String | + String path = "path_example"; // String | relative to the branch + try { + apiInstance.uploadObjectPreflight(repository, branch, path); + } catch (ApiException e) { + System.err.println("Exception when calling InternalApi#uploadObjectPreflight"); + System.err.println("Status code: " + e.getCode()); + System.err.println("Reason: " + e.getResponseBody()); + System.err.println("Response headers: " + e.getResponseHeaders()); + e.printStackTrace(); + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **String**| | + **branch** | **String**| | + **path** | **String**| relative to the branch | + +### Return type + +null (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Resource Not Found | - | +**0** | Internal Server Error | - | + diff --git a/clients/java/docs/ObjectsApi.md b/clients/java/docs/ObjectsApi.md index bddd9beceb7..a6488d371c3 100644 --- a/clients/java/docs/ObjectsApi.md +++ b/clients/java/docs/ObjectsApi.md @@ -14,7 +14,6 @@ Method | HTTP request | Description [**stageObject**](ObjectsApi.md#stageObject) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch [**statObject**](ObjectsApi.md#statObject) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata [**uploadObject**](ObjectsApi.md#uploadObject) | **POST** /repositories/{repository}/branches/{branch}/objects | -[**uploadObjectPreflight**](ObjectsApi.md#uploadObjectPreflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | @@ -1012,98 +1011,3 @@ Name | Type | Description | Notes **412** | Precondition Failed | - | **0** | Internal Server Error | - | - -# **uploadObjectPreflight** -> uploadObjectPreflight(repository, branch, path) - - - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.auth.*; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.ObjectsApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - // Configure HTTP basic authorization: basic_auth - HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); - basic_auth.setUsername("YOUR USERNAME"); - basic_auth.setPassword("YOUR PASSWORD"); - - // Configure API key authorization: cookie_auth - ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); - cookie_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //cookie_auth.setApiKeyPrefix("Token"); - - // Configure HTTP bearer authorization: jwt_token - HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); - jwt_token.setBearerToken("BEARER TOKEN"); - - // Configure API key authorization: oidc_auth - ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); - oidc_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //oidc_auth.setApiKeyPrefix("Token"); - - // Configure API key authorization: saml_auth - ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); - saml_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //saml_auth.setApiKeyPrefix("Token"); - - ObjectsApi apiInstance = new ObjectsApi(defaultClient); - String repository = "repository_example"; // String | - String branch = "branch_example"; // String | - String path = "path_example"; // String | relative to the branch - try { - apiInstance.uploadObjectPreflight(repository, branch, path); - } catch (ApiException e) { - System.err.println("Exception when calling ObjectsApi#uploadObjectPreflight"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **String**| | - **branch** | **String**| | - **path** | **String**| relative to the branch | - -### Return type - -null (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**404** | Resource Not Found | - | -**0** | Internal Server Error | - | - diff --git a/clients/java/docs/RepositoriesApi.md b/clients/java/docs/RepositoriesApi.md index 34bb4a2e32a..a067e93588a 100644 --- a/clients/java/docs/RepositoriesApi.md +++ b/clients/java/docs/RepositoriesApi.md @@ -5,7 +5,6 @@ All URIs are relative to *http://localhost/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**createBranchProtectionRule**](RepositoriesApi.md#createBranchProtectionRule) | **POST** /repositories/{repository}/branch_protection | -[**createBranchProtectionRulePreflight**](RepositoriesApi.md#createBranchProtectionRulePreflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | [**createRepository**](RepositoriesApi.md#createRepository) | **POST** /repositories | create repository [**deleteBranchProtectionRule**](RepositoriesApi.md#deleteBranchProtectionRule) | **DELETE** /repositories/{repository}/branch_protection | [**deleteRepository**](RepositoriesApi.md#deleteRepository) | **DELETE** /repositories/{repository} | delete repository @@ -107,97 +106,6 @@ null (empty response body) **404** | Resource Not Found | - | **0** | Internal Server Error | - | - -# **createBranchProtectionRulePreflight** -> createBranchProtectionRulePreflight(repository) - - - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.auth.*; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.RepositoriesApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - // Configure HTTP basic authorization: basic_auth - HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); - basic_auth.setUsername("YOUR USERNAME"); - basic_auth.setPassword("YOUR PASSWORD"); - - // Configure API key authorization: cookie_auth - ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); - cookie_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //cookie_auth.setApiKeyPrefix("Token"); - - // Configure HTTP bearer authorization: jwt_token - HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); - jwt_token.setBearerToken("BEARER TOKEN"); - - // Configure API key authorization: oidc_auth - ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); - oidc_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //oidc_auth.setApiKeyPrefix("Token"); - - // Configure API key authorization: saml_auth - ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); - saml_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //saml_auth.setApiKeyPrefix("Token"); - - RepositoriesApi apiInstance = new RepositoriesApi(defaultClient); - String repository = "repository_example"; // String | - try { - apiInstance.createBranchProtectionRulePreflight(repository); - } catch (ApiException e) { - System.err.println("Exception when calling RepositoriesApi#createBranchProtectionRulePreflight"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **String**| | - -### Return type - -null (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User has permissions to create a branch protection rule in this repository | - | -**401** | Unauthorized | - | -**404** | Resource Not Found | - | -**409** | Resource Conflicts With Target | - | -**0** | Internal Server Error | - | - # **createRepository** > Repository createRepository(repositoryCreation, bare) diff --git a/clients/java/docs/RetentionApi.md b/clients/java/docs/RetentionApi.md index 3d28709b124..8dcd92eaaf0 100644 --- a/clients/java/docs/RetentionApi.md +++ b/clients/java/docs/RetentionApi.md @@ -9,7 +9,6 @@ Method | HTTP request | Description [**prepareGarbageCollectionCommits**](RetentionApi.md#prepareGarbageCollectionCommits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active and expired commits for garbage collection [**prepareGarbageCollectionUncommitted**](RetentionApi.md#prepareGarbageCollectionUncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection [**setGarbageCollectionRules**](RetentionApi.md#setGarbageCollectionRules) | **POST** /repositories/{repository}/gc/rules | -[**setGarbageCollectionRulesPreflight**](RetentionApi.md#setGarbageCollectionRulesPreflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | @@ -472,93 +471,3 @@ null (empty response body) **404** | Resource Not Found | - | **0** | Internal Server Error | - | - -# **setGarbageCollectionRulesPreflight** -> setGarbageCollectionRulesPreflight(repository) - - - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.auth.*; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.RetentionApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - // Configure HTTP basic authorization: basic_auth - HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); - basic_auth.setUsername("YOUR USERNAME"); - basic_auth.setPassword("YOUR PASSWORD"); - - // Configure API key authorization: cookie_auth - ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); - cookie_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //cookie_auth.setApiKeyPrefix("Token"); - - // Configure HTTP bearer authorization: jwt_token - HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); - jwt_token.setBearerToken("BEARER TOKEN"); - - // Configure API key authorization: oidc_auth - ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); - oidc_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //oidc_auth.setApiKeyPrefix("Token"); - - // Configure API key authorization: saml_auth - ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); - saml_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //saml_auth.setApiKeyPrefix("Token"); - - RetentionApi apiInstance = new RetentionApi(defaultClient); - String repository = "repository_example"; // String | - try { - apiInstance.setGarbageCollectionRulesPreflight(repository); - } catch (ApiException e) { - System.err.println("Exception when calling RetentionApi#setGarbageCollectionRulesPreflight"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **String**| | - -### Return type - -null (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User has permissions to set garbage collection rules on this repository | - | -**401** | Unauthorized | - | -**404** | Resource Not Found | - | -**0** | Internal Server Error | - | - diff --git a/clients/java/docs/StagingApi.md b/clients/java/docs/StagingApi.md index 313f208f2c0..7ffb19e38b8 100644 --- a/clients/java/docs/StagingApi.md +++ b/clients/java/docs/StagingApi.md @@ -6,7 +6,6 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**getPhysicalAddress**](StagingApi.md#getPhysicalAddress) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | get a physical address and a return token to write object to underlying storage [**linkPhysicalAddress**](StagingApi.md#linkPhysicalAddress) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path -[**updateBranchToken**](StagingApi.md#updateBranchToken) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token @@ -207,99 +206,3 @@ Name | Type | Description | Notes **409** | conflict with a commit, try here | - | **0** | Internal Server Error | - | - -# **updateBranchToken** -> updateBranchToken(repository, branch, updateToken) - -modify branch staging token - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.auth.*; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.StagingApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - // Configure HTTP basic authorization: basic_auth - HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); - basic_auth.setUsername("YOUR USERNAME"); - basic_auth.setPassword("YOUR PASSWORD"); - - // Configure API key authorization: cookie_auth - ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); - cookie_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //cookie_auth.setApiKeyPrefix("Token"); - - // Configure HTTP bearer authorization: jwt_token - HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); - jwt_token.setBearerToken("BEARER TOKEN"); - - // Configure API key authorization: oidc_auth - ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); - oidc_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //oidc_auth.setApiKeyPrefix("Token"); - - // Configure API key authorization: saml_auth - ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); - saml_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //saml_auth.setApiKeyPrefix("Token"); - - StagingApi apiInstance = new StagingApi(defaultClient); - String repository = "repository_example"; // String | - String branch = "branch_example"; // String | - UpdateToken updateToken = new UpdateToken(); // UpdateToken | - try { - apiInstance.updateBranchToken(repository, branch, updateToken); - } catch (ApiException e) { - System.err.println("Exception when calling StagingApi#updateBranchToken"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **String**| | - **branch** | **String**| | - **updateToken** | [**UpdateToken**](UpdateToken.md)| | - -### Return type - -null (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | branch updated successfully | - | -**400** | Validation Error | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**404** | Resource Not Found | - | -**0** | Internal Server Error | - | - diff --git a/clients/java/docs/StatisticsApi.md b/clients/java/docs/StatisticsApi.md deleted file mode 100644 index ca84b79404e..00000000000 --- a/clients/java/docs/StatisticsApi.md +++ /dev/null @@ -1,99 +0,0 @@ -# StatisticsApi - -All URIs are relative to *http://localhost/api/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**postStatsEvents**](StatisticsApi.md#postStatsEvents) | **POST** /statistics | post stats events, this endpoint is meant for internal use only - - - -# **postStatsEvents** -> postStatsEvents(statsEventsList) - -post stats events, this endpoint is meant for internal use only - -### Example -```java -// Import classes: -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.auth.*; -import io.lakefs.clients.api.models.*; -import io.lakefs.clients.api.StatisticsApi; - -public class Example { - public static void main(String[] args) { - ApiClient defaultClient = Configuration.getDefaultApiClient(); - defaultClient.setBasePath("http://localhost/api/v1"); - - // Configure HTTP basic authorization: basic_auth - HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); - basic_auth.setUsername("YOUR USERNAME"); - basic_auth.setPassword("YOUR PASSWORD"); - - // Configure API key authorization: cookie_auth - ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); - cookie_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //cookie_auth.setApiKeyPrefix("Token"); - - // Configure HTTP bearer authorization: jwt_token - HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); - jwt_token.setBearerToken("BEARER TOKEN"); - - // Configure API key authorization: oidc_auth - ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); - oidc_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //oidc_auth.setApiKeyPrefix("Token"); - - // Configure API key authorization: saml_auth - ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); - saml_auth.setApiKey("YOUR API KEY"); - // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) - //saml_auth.setApiKeyPrefix("Token"); - - StatisticsApi apiInstance = new StatisticsApi(defaultClient); - StatsEventsList statsEventsList = new StatsEventsList(); // StatsEventsList | - try { - apiInstance.postStatsEvents(statsEventsList); - } catch (ApiException e) { - System.err.println("Exception when calling StatisticsApi#postStatsEvents"); - System.err.println("Status code: " + e.getCode()); - System.err.println("Reason: " + e.getResponseBody()); - System.err.println("Response headers: " + e.getResponseHeaders()); - e.printStackTrace(); - } - } -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **statsEventsList** | [**StatsEventsList**](StatsEventsList.md)| | - -### Return type - -null (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | reported successfully | - | -**400** | Bad Request | - | -**401** | Unauthorized | - | -**0** | Internal Server Error | - | - diff --git a/clients/java/src/main/java/io/lakefs/clients/api/AuthApi.java b/clients/java/src/main/java/io/lakefs/clients/api/AuthApi.java index f79aba29967..520cb2bab47 100644 --- a/clients/java/src/main/java/io/lakefs/clients/api/AuthApi.java +++ b/clients/java/src/main/java/io/lakefs/clients/api/AuthApi.java @@ -28,7 +28,6 @@ import io.lakefs.clients.api.model.ACL; -import io.lakefs.clients.api.model.AuthCapabilities; import io.lakefs.clients.api.model.AuthenticationToken; import io.lakefs.clients.api.model.Credentials; import io.lakefs.clients.api.model.CredentialsList; @@ -1949,112 +1948,6 @@ public okhttp3.Call forgotPasswordAsync(ForgotPasswordRequest forgotPasswordRequ localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } - /** - * Build call for getAuthCapabilities - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - -
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
- */ - public okhttp3.Call getAuthCapabilitiesCall(final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/auth/capabilities"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call getAuthCapabilitiesValidateBeforeCall(final ApiCallback _callback) throws ApiException { - - - okhttp3.Call localVarCall = getAuthCapabilitiesCall(_callback); - return localVarCall; - - } - - /** - * list authentication capabilities supported - * - * @return AuthCapabilities - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - -
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
- */ - public AuthCapabilities getAuthCapabilities() throws ApiException { - ApiResponse localVarResp = getAuthCapabilitiesWithHttpInfo(); - return localVarResp.getData(); - } - - /** - * list authentication capabilities supported - * - * @return ApiResponse<AuthCapabilities> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - -
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
- */ - public ApiResponse getAuthCapabilitiesWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = getAuthCapabilitiesValidateBeforeCall(null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * list authentication capabilities supported (asynchronously) - * - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - -
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
- */ - public okhttp3.Call getAuthCapabilitiesAsync(final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = getAuthCapabilitiesValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } /** * Build call for getCredentials * @param userId (required) diff --git a/clients/java/src/main/java/io/lakefs/clients/api/ConfigApi.java b/clients/java/src/main/java/io/lakefs/clients/api/ConfigApi.java index dd6de98a26d..01425b8eaa9 100644 --- a/clients/java/src/main/java/io/lakefs/clients/api/ConfigApi.java +++ b/clients/java/src/main/java/io/lakefs/clients/api/ConfigApi.java @@ -27,12 +27,8 @@ import java.io.IOException; -import io.lakefs.clients.api.model.CommPrefsInput; -import io.lakefs.clients.api.model.CredentialsWithSecret; import io.lakefs.clients.api.model.Error; import io.lakefs.clients.api.model.GarbageCollectionConfig; -import io.lakefs.clients.api.model.Setup; -import io.lakefs.clients.api.model.SetupState; import io.lakefs.clients.api.model.StorageConfig; import io.lakefs.clients.api.model.VersionConfig; @@ -273,112 +269,6 @@ public okhttp3.Call getLakeFSVersionAsync(final ApiCallback _call localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - /** - * Build call for getSetupState - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - -
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
- */ - public okhttp3.Call getSetupStateCall(final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/setup_lakefs"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call getSetupStateValidateBeforeCall(final ApiCallback _callback) throws ApiException { - - - okhttp3.Call localVarCall = getSetupStateCall(_callback); - return localVarCall; - - } - - /** - * check if the lakeFS installation is already set up - * - * @return SetupState - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - -
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
- */ - public SetupState getSetupState() throws ApiException { - ApiResponse localVarResp = getSetupStateWithHttpInfo(); - return localVarResp.getData(); - } - - /** - * check if the lakeFS installation is already set up - * - * @return ApiResponse<SetupState> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - -
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
- */ - public ApiResponse getSetupStateWithHttpInfo() throws ApiException { - okhttp3.Call localVarCall = getSetupStateValidateBeforeCall(null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * check if the lakeFS installation is already set up (asynchronously) - * - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - -
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
- */ - public okhttp3.Call getSetupStateAsync(final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = getSetupStateValidateBeforeCall(_callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } /** * Build call for getStorageConfig * @param _callback Callback for upload/download progress @@ -485,246 +375,4 @@ public okhttp3.Call getStorageConfigAsync(final ApiCallback _call localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - /** - * Build call for setup - * @param setup (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
- */ - public okhttp3.Call setupCall(Setup setup, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = setup; - - // create path and map variables - String localVarPath = "/setup_lakefs"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call setupValidateBeforeCall(Setup setup, final ApiCallback _callback) throws ApiException { - - // verify the required parameter 'setup' is set - if (setup == null) { - throw new ApiException("Missing the required parameter 'setup' when calling setup(Async)"); - } - - - okhttp3.Call localVarCall = setupCall(setup, _callback); - return localVarCall; - - } - - /** - * setup lakeFS and create a first user - * - * @param setup (required) - * @return CredentialsWithSecret - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
- */ - public CredentialsWithSecret setup(Setup setup) throws ApiException { - ApiResponse localVarResp = setupWithHttpInfo(setup); - return localVarResp.getData(); - } - - /** - * setup lakeFS and create a first user - * - * @param setup (required) - * @return ApiResponse<CredentialsWithSecret> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
- */ - public ApiResponse setupWithHttpInfo(Setup setup) throws ApiException { - okhttp3.Call localVarCall = setupValidateBeforeCall(setup, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return localVarApiClient.execute(localVarCall, localVarReturnType); - } - - /** - * setup lakeFS and create a first user (asynchronously) - * - * @param setup (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
- */ - public okhttp3.Call setupAsync(Setup setup, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = setupValidateBeforeCall(setup, _callback); - Type localVarReturnType = new TypeToken(){}.getType(); - localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); - return localVarCall; - } - /** - * Build call for setupCommPrefs - * @param commPrefsInput (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
- */ - public okhttp3.Call setupCommPrefsCall(CommPrefsInput commPrefsInput, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = commPrefsInput; - - // create path and map variables - String localVarPath = "/setup_comm_prefs"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call setupCommPrefsValidateBeforeCall(CommPrefsInput commPrefsInput, final ApiCallback _callback) throws ApiException { - - // verify the required parameter 'commPrefsInput' is set - if (commPrefsInput == null) { - throw new ApiException("Missing the required parameter 'commPrefsInput' when calling setupCommPrefs(Async)"); - } - - - okhttp3.Call localVarCall = setupCommPrefsCall(commPrefsInput, _callback); - return localVarCall; - - } - - /** - * setup communications preferences - * - * @param commPrefsInput (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
- */ - public void setupCommPrefs(CommPrefsInput commPrefsInput) throws ApiException { - setupCommPrefsWithHttpInfo(commPrefsInput); - } - - /** - * setup communications preferences - * - * @param commPrefsInput (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
- */ - public ApiResponse setupCommPrefsWithHttpInfo(CommPrefsInput commPrefsInput) throws ApiException { - okhttp3.Call localVarCall = setupCommPrefsValidateBeforeCall(commPrefsInput, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * setup communications preferences (asynchronously) - * - * @param commPrefsInput (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
- */ - public okhttp3.Call setupCommPrefsAsync(CommPrefsInput commPrefsInput, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = setupCommPrefsValidateBeforeCall(commPrefsInput, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } } diff --git a/clients/java/src/main/java/io/lakefs/clients/api/InternalApi.java b/clients/java/src/main/java/io/lakefs/clients/api/InternalApi.java new file mode 100644 index 00000000000..1c0fc48eb98 --- /dev/null +++ b/clients/java/src/main/java/io/lakefs/clients/api/InternalApi.java @@ -0,0 +1,1175 @@ +/* + * lakeFS API + * lakeFS HTTP API + * + * The version of the OpenAPI document: 0.1.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.lakefs.clients.api; + +import io.lakefs.clients.api.ApiCallback; +import io.lakefs.clients.api.ApiClient; +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.ApiResponse; +import io.lakefs.clients.api.Configuration; +import io.lakefs.clients.api.Pair; +import io.lakefs.clients.api.ProgressRequestBody; +import io.lakefs.clients.api.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import io.lakefs.clients.api.model.AuthCapabilities; +import io.lakefs.clients.api.model.CommPrefsInput; +import io.lakefs.clients.api.model.CredentialsWithSecret; +import io.lakefs.clients.api.model.Error; +import io.lakefs.clients.api.model.Setup; +import io.lakefs.clients.api.model.SetupState; +import io.lakefs.clients.api.model.StatsEventsList; +import io.lakefs.clients.api.model.UpdateToken; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class InternalApi { + private ApiClient localVarApiClient; + + public InternalApi() { + this(Configuration.getDefaultApiClient()); + } + + public InternalApi(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + public ApiClient getApiClient() { + return localVarApiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.localVarApiClient = apiClient; + } + + /** + * Build call for createBranchProtectionRulePreflight + * @param repository (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
+ */ + public okhttp3.Call createBranchProtectionRulePreflightCall(String repository, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/repositories/{repository}/branch_protection/set_allowed" + .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call createBranchProtectionRulePreflightValidateBeforeCall(String repository, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'repository' is set + if (repository == null) { + throw new ApiException("Missing the required parameter 'repository' when calling createBranchProtectionRulePreflight(Async)"); + } + + + okhttp3.Call localVarCall = createBranchProtectionRulePreflightCall(repository, _callback); + return localVarCall; + + } + + /** + * + * + * @param repository (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
+ */ + public void createBranchProtectionRulePreflight(String repository) throws ApiException { + createBranchProtectionRulePreflightWithHttpInfo(repository); + } + + /** + * + * + * @param repository (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
+ */ + public ApiResponse createBranchProtectionRulePreflightWithHttpInfo(String repository) throws ApiException { + okhttp3.Call localVarCall = createBranchProtectionRulePreflightValidateBeforeCall(repository, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * (asynchronously) + * + * @param repository (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
+ */ + public okhttp3.Call createBranchProtectionRulePreflightAsync(String repository, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = createBranchProtectionRulePreflightValidateBeforeCall(repository, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for getAuthCapabilities + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + +
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
+ */ + public okhttp3.Call getAuthCapabilitiesCall(final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/auth/capabilities"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getAuthCapabilitiesValidateBeforeCall(final ApiCallback _callback) throws ApiException { + + + okhttp3.Call localVarCall = getAuthCapabilitiesCall(_callback); + return localVarCall; + + } + + /** + * list authentication capabilities supported + * + * @return AuthCapabilities + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + +
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
+ */ + public AuthCapabilities getAuthCapabilities() throws ApiException { + ApiResponse localVarResp = getAuthCapabilitiesWithHttpInfo(); + return localVarResp.getData(); + } + + /** + * list authentication capabilities supported + * + * @return ApiResponse<AuthCapabilities> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + +
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
+ */ + public ApiResponse getAuthCapabilitiesWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = getAuthCapabilitiesValidateBeforeCall(null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * list authentication capabilities supported (asynchronously) + * + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + +
Status Code Description Response Headers
200 auth capabilities -
0 Internal Server Error -
+ */ + public okhttp3.Call getAuthCapabilitiesAsync(final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getAuthCapabilitiesValidateBeforeCall(_callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for getSetupState + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + +
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
+ */ + public okhttp3.Call getSetupStateCall(final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/setup_lakefs"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call getSetupStateValidateBeforeCall(final ApiCallback _callback) throws ApiException { + + + okhttp3.Call localVarCall = getSetupStateCall(_callback); + return localVarCall; + + } + + /** + * check if the lakeFS installation is already set up + * + * @return SetupState + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + +
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
+ */ + public SetupState getSetupState() throws ApiException { + ApiResponse localVarResp = getSetupStateWithHttpInfo(); + return localVarResp.getData(); + } + + /** + * check if the lakeFS installation is already set up + * + * @return ApiResponse<SetupState> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + +
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
+ */ + public ApiResponse getSetupStateWithHttpInfo() throws ApiException { + okhttp3.Call localVarCall = getSetupStateValidateBeforeCall(null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * check if the lakeFS installation is already set up (asynchronously) + * + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + +
Status Code Description Response Headers
200 lakeFS setup state -
0 Internal Server Error -
+ */ + public okhttp3.Call getSetupStateAsync(final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = getSetupStateValidateBeforeCall(_callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for postStatsEvents + * @param statsEventsList (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
+ */ + public okhttp3.Call postStatsEventsCall(StatsEventsList statsEventsList, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = statsEventsList; + + // create path and map variables + String localVarPath = "/statistics"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call postStatsEventsValidateBeforeCall(StatsEventsList statsEventsList, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'statsEventsList' is set + if (statsEventsList == null) { + throw new ApiException("Missing the required parameter 'statsEventsList' when calling postStatsEvents(Async)"); + } + + + okhttp3.Call localVarCall = postStatsEventsCall(statsEventsList, _callback); + return localVarCall; + + } + + /** + * post stats events, this endpoint is meant for internal use only + * + * @param statsEventsList (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
+ */ + public void postStatsEvents(StatsEventsList statsEventsList) throws ApiException { + postStatsEventsWithHttpInfo(statsEventsList); + } + + /** + * post stats events, this endpoint is meant for internal use only + * + * @param statsEventsList (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
+ */ + public ApiResponse postStatsEventsWithHttpInfo(StatsEventsList statsEventsList) throws ApiException { + okhttp3.Call localVarCall = postStatsEventsValidateBeforeCall(statsEventsList, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * post stats events, this endpoint is meant for internal use only (asynchronously) + * + * @param statsEventsList (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
+ */ + public okhttp3.Call postStatsEventsAsync(StatsEventsList statsEventsList, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = postStatsEventsValidateBeforeCall(statsEventsList, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for setGarbageCollectionRulesPreflight + * @param repository (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public okhttp3.Call setGarbageCollectionRulesPreflightCall(String repository, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/repositories/{repository}/gc/rules/set_allowed" + .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call setGarbageCollectionRulesPreflightValidateBeforeCall(String repository, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'repository' is set + if (repository == null) { + throw new ApiException("Missing the required parameter 'repository' when calling setGarbageCollectionRulesPreflight(Async)"); + } + + + okhttp3.Call localVarCall = setGarbageCollectionRulesPreflightCall(repository, _callback); + return localVarCall; + + } + + /** + * + * + * @param repository (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public void setGarbageCollectionRulesPreflight(String repository) throws ApiException { + setGarbageCollectionRulesPreflightWithHttpInfo(repository); + } + + /** + * + * + * @param repository (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public ApiResponse setGarbageCollectionRulesPreflightWithHttpInfo(String repository) throws ApiException { + okhttp3.Call localVarCall = setGarbageCollectionRulesPreflightValidateBeforeCall(repository, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * (asynchronously) + * + * @param repository (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public okhttp3.Call setGarbageCollectionRulesPreflightAsync(String repository, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = setGarbageCollectionRulesPreflightValidateBeforeCall(repository, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for setup + * @param setup (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
+ */ + public okhttp3.Call setupCall(Setup setup, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = setup; + + // create path and map variables + String localVarPath = "/setup_lakefs"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call setupValidateBeforeCall(Setup setup, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'setup' is set + if (setup == null) { + throw new ApiException("Missing the required parameter 'setup' when calling setup(Async)"); + } + + + okhttp3.Call localVarCall = setupCall(setup, _callback); + return localVarCall; + + } + + /** + * setup lakeFS and create a first user + * + * @param setup (required) + * @return CredentialsWithSecret + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
+ */ + public CredentialsWithSecret setup(Setup setup) throws ApiException { + ApiResponse localVarResp = setupWithHttpInfo(setup); + return localVarResp.getData(); + } + + /** + * setup lakeFS and create a first user + * + * @param setup (required) + * @return ApiResponse<CredentialsWithSecret> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
+ */ + public ApiResponse setupWithHttpInfo(Setup setup) throws ApiException { + okhttp3.Call localVarCall = setupValidateBeforeCall(setup, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return localVarApiClient.execute(localVarCall, localVarReturnType); + } + + /** + * setup lakeFS and create a first user (asynchronously) + * + * @param setup (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 user created successfully -
400 Bad Request -
409 setup was already called -
0 Internal Server Error -
+ */ + public okhttp3.Call setupAsync(Setup setup, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = setupValidateBeforeCall(setup, _callback); + Type localVarReturnType = new TypeToken(){}.getType(); + localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); + return localVarCall; + } + /** + * Build call for setupCommPrefs + * @param commPrefsInput (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
+ */ + public okhttp3.Call setupCommPrefsCall(CommPrefsInput commPrefsInput, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = commPrefsInput; + + // create path and map variables + String localVarPath = "/setup_comm_prefs"; + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { }; + return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call setupCommPrefsValidateBeforeCall(CommPrefsInput commPrefsInput, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'commPrefsInput' is set + if (commPrefsInput == null) { + throw new ApiException("Missing the required parameter 'commPrefsInput' when calling setupCommPrefs(Async)"); + } + + + okhttp3.Call localVarCall = setupCommPrefsCall(commPrefsInput, _callback); + return localVarCall; + + } + + /** + * setup communications preferences + * + * @param commPrefsInput (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
+ */ + public void setupCommPrefs(CommPrefsInput commPrefsInput) throws ApiException { + setupCommPrefsWithHttpInfo(commPrefsInput); + } + + /** + * setup communications preferences + * + * @param commPrefsInput (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
+ */ + public ApiResponse setupCommPrefsWithHttpInfo(CommPrefsInput commPrefsInput) throws ApiException { + okhttp3.Call localVarCall = setupCommPrefsValidateBeforeCall(commPrefsInput, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * setup communications preferences (asynchronously) + * + * @param commPrefsInput (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + +
Status Code Description Response Headers
200 communication preferences saved successfully -
409 setup was already completed -
412 wrong setup state for this operation -
0 Internal Server Error -
+ */ + public okhttp3.Call setupCommPrefsAsync(CommPrefsInput commPrefsInput, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = setupCommPrefsValidateBeforeCall(commPrefsInput, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for updateBranchToken + * @param repository (required) + * @param branch (required) + * @param updateToken (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + + +
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public okhttp3.Call updateBranchTokenCall(String repository, String branch, UpdateToken updateToken, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = updateToken; + + // create path and map variables + String localVarPath = "/repositories/{repository}/branches/{branch}/update_token" + .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())) + .replaceAll("\\{" + "branch" + "\\}", localVarApiClient.escapeString(branch.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + "application/json" + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; + return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call updateBranchTokenValidateBeforeCall(String repository, String branch, UpdateToken updateToken, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'repository' is set + if (repository == null) { + throw new ApiException("Missing the required parameter 'repository' when calling updateBranchToken(Async)"); + } + + // verify the required parameter 'branch' is set + if (branch == null) { + throw new ApiException("Missing the required parameter 'branch' when calling updateBranchToken(Async)"); + } + + // verify the required parameter 'updateToken' is set + if (updateToken == null) { + throw new ApiException("Missing the required parameter 'updateToken' when calling updateBranchToken(Async)"); + } + + + okhttp3.Call localVarCall = updateBranchTokenCall(repository, branch, updateToken, _callback); + return localVarCall; + + } + + /** + * modify branch staging token + * + * @param repository (required) + * @param branch (required) + * @param updateToken (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public void updateBranchToken(String repository, String branch, UpdateToken updateToken) throws ApiException { + updateBranchTokenWithHttpInfo(repository, branch, updateToken); + } + + /** + * modify branch staging token + * + * @param repository (required) + * @param branch (required) + * @param updateToken (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + + +
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public ApiResponse updateBranchTokenWithHttpInfo(String repository, String branch, UpdateToken updateToken) throws ApiException { + okhttp3.Call localVarCall = updateBranchTokenValidateBeforeCall(repository, branch, updateToken, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * modify branch staging token (asynchronously) + * + * @param repository (required) + * @param branch (required) + * @param updateToken (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + + +
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public okhttp3.Call updateBranchTokenAsync(String repository, String branch, UpdateToken updateToken, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = updateBranchTokenValidateBeforeCall(repository, branch, updateToken, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } + /** + * Build call for uploadObjectPreflight + * @param repository (required) + * @param branch (required) + * @param path relative to the branch (required) + * @param _callback Callback for upload/download progress + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public okhttp3.Call uploadObjectPreflightCall(String repository, String branch, String path, final ApiCallback _callback) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/repositories/{repository}/branches/{branch}/objects/stage_allowed" + .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())) + .replaceAll("\\{" + "branch" + "\\}", localVarApiClient.escapeString(branch.toString())); + + List localVarQueryParams = new ArrayList(); + List localVarCollectionQueryParams = new ArrayList(); + Map localVarHeaderParams = new HashMap(); + Map localVarCookieParams = new HashMap(); + Map localVarFormParams = new HashMap(); + + if (path != null) { + localVarQueryParams.addAll(localVarApiClient.parameterToPair("path", path)); + } + + final String[] localVarAccepts = { + "application/json" + }; + final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) { + localVarHeaderParams.put("Accept", localVarAccept); + } + + final String[] localVarContentTypes = { + + }; + final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; + return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); + } + + @SuppressWarnings("rawtypes") + private okhttp3.Call uploadObjectPreflightValidateBeforeCall(String repository, String branch, String path, final ApiCallback _callback) throws ApiException { + + // verify the required parameter 'repository' is set + if (repository == null) { + throw new ApiException("Missing the required parameter 'repository' when calling uploadObjectPreflight(Async)"); + } + + // verify the required parameter 'branch' is set + if (branch == null) { + throw new ApiException("Missing the required parameter 'branch' when calling uploadObjectPreflight(Async)"); + } + + // verify the required parameter 'path' is set + if (path == null) { + throw new ApiException("Missing the required parameter 'path' when calling uploadObjectPreflight(Async)"); + } + + + okhttp3.Call localVarCall = uploadObjectPreflightCall(repository, branch, path, _callback); + return localVarCall; + + } + + /** + * + * + * @param repository (required) + * @param branch (required) + * @param path relative to the branch (required) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public void uploadObjectPreflight(String repository, String branch, String path) throws ApiException { + uploadObjectPreflightWithHttpInfo(repository, branch, path); + } + + /** + * + * + * @param repository (required) + * @param branch (required) + * @param path relative to the branch (required) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public ApiResponse uploadObjectPreflightWithHttpInfo(String repository, String branch, String path) throws ApiException { + okhttp3.Call localVarCall = uploadObjectPreflightValidateBeforeCall(repository, branch, path, null); + return localVarApiClient.execute(localVarCall); + } + + /** + * (asynchronously) + * + * @param repository (required) + * @param branch (required) + * @param path relative to the branch (required) + * @param _callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + * @http.response.details + + + + + + + +
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
+ */ + public okhttp3.Call uploadObjectPreflightAsync(String repository, String branch, String path, final ApiCallback _callback) throws ApiException { + + okhttp3.Call localVarCall = uploadObjectPreflightValidateBeforeCall(repository, branch, path, _callback); + localVarApiClient.executeAsync(localVarCall, _callback); + return localVarCall; + } +} diff --git a/clients/java/src/main/java/io/lakefs/clients/api/ObjectsApi.java b/clients/java/src/main/java/io/lakefs/clients/api/ObjectsApi.java index ca8b814a70e..6bed67b4af7 100644 --- a/clients/java/src/main/java/io/lakefs/clients/api/ObjectsApi.java +++ b/clients/java/src/main/java/io/lakefs/clients/api/ObjectsApi.java @@ -1705,151 +1705,4 @@ public okhttp3.Call uploadObjectAsync(String repository, String branch, String p localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - /** - * Build call for uploadObjectPreflight - * @param repository (required) - * @param branch (required) - * @param path relative to the branch (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public okhttp3.Call uploadObjectPreflightCall(String repository, String branch, String path, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/repositories/{repository}/branches/{branch}/objects/stage_allowed" - .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())) - .replaceAll("\\{" + "branch" + "\\}", localVarApiClient.escapeString(branch.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - if (path != null) { - localVarQueryParams.addAll(localVarApiClient.parameterToPair("path", path)); - } - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call uploadObjectPreflightValidateBeforeCall(String repository, String branch, String path, final ApiCallback _callback) throws ApiException { - - // verify the required parameter 'repository' is set - if (repository == null) { - throw new ApiException("Missing the required parameter 'repository' when calling uploadObjectPreflight(Async)"); - } - - // verify the required parameter 'branch' is set - if (branch == null) { - throw new ApiException("Missing the required parameter 'branch' when calling uploadObjectPreflight(Async)"); - } - - // verify the required parameter 'path' is set - if (path == null) { - throw new ApiException("Missing the required parameter 'path' when calling uploadObjectPreflight(Async)"); - } - - - okhttp3.Call localVarCall = uploadObjectPreflightCall(repository, branch, path, _callback); - return localVarCall; - - } - - /** - * - * - * @param repository (required) - * @param branch (required) - * @param path relative to the branch (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public void uploadObjectPreflight(String repository, String branch, String path) throws ApiException { - uploadObjectPreflightWithHttpInfo(repository, branch, path); - } - - /** - * - * - * @param repository (required) - * @param branch (required) - * @param path relative to the branch (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public ApiResponse uploadObjectPreflightWithHttpInfo(String repository, String branch, String path) throws ApiException { - okhttp3.Call localVarCall = uploadObjectPreflightValidateBeforeCall(repository, branch, path, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * (asynchronously) - * - * @param repository (required) - * @param branch (required) - * @param path relative to the branch (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public okhttp3.Call uploadObjectPreflightAsync(String repository, String branch, String path, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = uploadObjectPreflightValidateBeforeCall(repository, branch, path, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } } diff --git a/clients/java/src/main/java/io/lakefs/clients/api/RepositoriesApi.java b/clients/java/src/main/java/io/lakefs/clients/api/RepositoriesApi.java index a4d213450af..8e96ed2703b 100644 --- a/clients/java/src/main/java/io/lakefs/clients/api/RepositoriesApi.java +++ b/clients/java/src/main/java/io/lakefs/clients/api/RepositoriesApi.java @@ -188,130 +188,6 @@ public okhttp3.Call createBranchProtectionRuleAsync(String repository, BranchPro localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } - /** - * Build call for createBranchProtectionRulePreflight - * @param repository (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
- */ - public okhttp3.Call createBranchProtectionRulePreflightCall(String repository, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/repositories/{repository}/branch_protection/set_allowed" - .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call createBranchProtectionRulePreflightValidateBeforeCall(String repository, final ApiCallback _callback) throws ApiException { - - // verify the required parameter 'repository' is set - if (repository == null) { - throw new ApiException("Missing the required parameter 'repository' when calling createBranchProtectionRulePreflight(Async)"); - } - - - okhttp3.Call localVarCall = createBranchProtectionRulePreflightCall(repository, _callback); - return localVarCall; - - } - - /** - * - * - * @param repository (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
- */ - public void createBranchProtectionRulePreflight(String repository) throws ApiException { - createBranchProtectionRulePreflightWithHttpInfo(repository); - } - - /** - * - * - * @param repository (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
- */ - public ApiResponse createBranchProtectionRulePreflightWithHttpInfo(String repository) throws ApiException { - okhttp3.Call localVarCall = createBranchProtectionRulePreflightValidateBeforeCall(repository, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * (asynchronously) - * - * @param repository (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - - -
Status Code Description Response Headers
204 User has permissions to create a branch protection rule in this repository -
401 Unauthorized -
404 Resource Not Found -
409 Resource Conflicts With Target -
0 Internal Server Error -
- */ - public okhttp3.Call createBranchProtectionRulePreflightAsync(String repository, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = createBranchProtectionRulePreflightValidateBeforeCall(repository, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } /** * Build call for createRepository * @param repositoryCreation (required) diff --git a/clients/java/src/main/java/io/lakefs/clients/api/RetentionApi.java b/clients/java/src/main/java/io/lakefs/clients/api/RetentionApi.java index 733ef7eed18..0eeab6924cc 100644 --- a/clients/java/src/main/java/io/lakefs/clients/api/RetentionApi.java +++ b/clients/java/src/main/java/io/lakefs/clients/api/RetentionApi.java @@ -692,124 +692,4 @@ public okhttp3.Call setGarbageCollectionRulesAsync(String repository, GarbageCol localVarApiClient.executeAsync(localVarCall, _callback); return localVarCall; } - /** - * Build call for setGarbageCollectionRulesPreflight - * @param repository (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
- */ - public okhttp3.Call setGarbageCollectionRulesPreflightCall(String repository, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/repositories/{repository}/gc/rules/set_allowed" - .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; - return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call setGarbageCollectionRulesPreflightValidateBeforeCall(String repository, final ApiCallback _callback) throws ApiException { - - // verify the required parameter 'repository' is set - if (repository == null) { - throw new ApiException("Missing the required parameter 'repository' when calling setGarbageCollectionRulesPreflight(Async)"); - } - - - okhttp3.Call localVarCall = setGarbageCollectionRulesPreflightCall(repository, _callback); - return localVarCall; - - } - - /** - * - * - * @param repository (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
- */ - public void setGarbageCollectionRulesPreflight(String repository) throws ApiException { - setGarbageCollectionRulesPreflightWithHttpInfo(repository); - } - - /** - * - * - * @param repository (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
- */ - public ApiResponse setGarbageCollectionRulesPreflightWithHttpInfo(String repository) throws ApiException { - okhttp3.Call localVarCall = setGarbageCollectionRulesPreflightValidateBeforeCall(repository, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * (asynchronously) - * - * @param repository (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 User has permissions to set garbage collection rules on this repository -
401 Unauthorized -
404 Resource Not Found -
0 Internal Server Error -
- */ - public okhttp3.Call setGarbageCollectionRulesPreflightAsync(String repository, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = setGarbageCollectionRulesPreflightValidateBeforeCall(repository, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } } diff --git a/clients/java/src/main/java/io/lakefs/clients/api/StagingApi.java b/clients/java/src/main/java/io/lakefs/clients/api/StagingApi.java index e8a6d17a98f..62de78544d9 100644 --- a/clients/java/src/main/java/io/lakefs/clients/api/StagingApi.java +++ b/clients/java/src/main/java/io/lakefs/clients/api/StagingApi.java @@ -31,7 +31,6 @@ import io.lakefs.clients.api.model.ObjectStats; import io.lakefs.clients.api.model.StagingLocation; import io.lakefs.clients.api.model.StagingMetadata; -import io.lakefs.clients.api.model.UpdateToken; import java.lang.reflect.Type; import java.util.ArrayList; @@ -377,151 +376,4 @@ public okhttp3.Call linkPhysicalAddressAsync(String repository, String branch, S localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback); return localVarCall; } - /** - * Build call for updateBranchToken - * @param repository (required) - * @param branch (required) - * @param updateToken (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - - - -
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public okhttp3.Call updateBranchTokenCall(String repository, String branch, UpdateToken updateToken, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = updateToken; - - // create path and map variables - String localVarPath = "/repositories/{repository}/branches/{branch}/update_token" - .replaceAll("\\{" + "repository" + "\\}", localVarApiClient.escapeString(repository.toString())) - .replaceAll("\\{" + "branch" + "\\}", localVarApiClient.escapeString(branch.toString())); - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; - return localVarApiClient.buildCall(localVarPath, "PUT", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call updateBranchTokenValidateBeforeCall(String repository, String branch, UpdateToken updateToken, final ApiCallback _callback) throws ApiException { - - // verify the required parameter 'repository' is set - if (repository == null) { - throw new ApiException("Missing the required parameter 'repository' when calling updateBranchToken(Async)"); - } - - // verify the required parameter 'branch' is set - if (branch == null) { - throw new ApiException("Missing the required parameter 'branch' when calling updateBranchToken(Async)"); - } - - // verify the required parameter 'updateToken' is set - if (updateToken == null) { - throw new ApiException("Missing the required parameter 'updateToken' when calling updateBranchToken(Async)"); - } - - - okhttp3.Call localVarCall = updateBranchTokenCall(repository, branch, updateToken, _callback); - return localVarCall; - - } - - /** - * modify branch staging token - * - * @param repository (required) - * @param branch (required) - * @param updateToken (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - - -
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public void updateBranchToken(String repository, String branch, UpdateToken updateToken) throws ApiException { - updateBranchTokenWithHttpInfo(repository, branch, updateToken); - } - - /** - * modify branch staging token - * - * @param repository (required) - * @param branch (required) - * @param updateToken (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - - - -
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public ApiResponse updateBranchTokenWithHttpInfo(String repository, String branch, UpdateToken updateToken) throws ApiException { - okhttp3.Call localVarCall = updateBranchTokenValidateBeforeCall(repository, branch, updateToken, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * modify branch staging token (asynchronously) - * - * @param repository (required) - * @param branch (required) - * @param updateToken (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - - - -
Status Code Description Response Headers
204 branch updated successfully -
400 Validation Error -
401 Unauthorized -
403 Forbidden -
404 Resource Not Found -
0 Internal Server Error -
- */ - public okhttp3.Call updateBranchTokenAsync(String repository, String branch, UpdateToken updateToken, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = updateBranchTokenValidateBeforeCall(repository, branch, updateToken, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } } diff --git a/clients/java/src/main/java/io/lakefs/clients/api/StatisticsApi.java b/clients/java/src/main/java/io/lakefs/clients/api/StatisticsApi.java deleted file mode 100644 index 2bffd83a83f..00000000000 --- a/clients/java/src/main/java/io/lakefs/clients/api/StatisticsApi.java +++ /dev/null @@ -1,177 +0,0 @@ -/* - * lakeFS API - * lakeFS HTTP API - * - * The version of the OpenAPI document: 0.1.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.lakefs.clients.api; - -import io.lakefs.clients.api.ApiCallback; -import io.lakefs.clients.api.ApiClient; -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.ApiResponse; -import io.lakefs.clients.api.Configuration; -import io.lakefs.clients.api.Pair; -import io.lakefs.clients.api.ProgressRequestBody; -import io.lakefs.clients.api.ProgressResponseBody; - -import com.google.gson.reflect.TypeToken; - -import java.io.IOException; - - -import io.lakefs.clients.api.model.Error; -import io.lakefs.clients.api.model.StatsEventsList; - -import java.lang.reflect.Type; -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -public class StatisticsApi { - private ApiClient localVarApiClient; - - public StatisticsApi() { - this(Configuration.getDefaultApiClient()); - } - - public StatisticsApi(ApiClient apiClient) { - this.localVarApiClient = apiClient; - } - - public ApiClient getApiClient() { - return localVarApiClient; - } - - public void setApiClient(ApiClient apiClient) { - this.localVarApiClient = apiClient; - } - - /** - * Build call for postStatsEvents - * @param statsEventsList (required) - * @param _callback Callback for upload/download progress - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
- */ - public okhttp3.Call postStatsEventsCall(StatsEventsList statsEventsList, final ApiCallback _callback) throws ApiException { - Object localVarPostBody = statsEventsList; - - // create path and map variables - String localVarPath = "/statistics"; - - List localVarQueryParams = new ArrayList(); - List localVarCollectionQueryParams = new ArrayList(); - Map localVarHeaderParams = new HashMap(); - Map localVarCookieParams = new HashMap(); - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json" - }; - final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) { - localVarHeaderParams.put("Accept", localVarAccept); - } - - final String[] localVarContentTypes = { - "application/json" - }; - final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - String[] localVarAuthNames = new String[] { "basic_auth", "cookie_auth", "jwt_token", "oidc_auth", "saml_auth" }; - return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); - } - - @SuppressWarnings("rawtypes") - private okhttp3.Call postStatsEventsValidateBeforeCall(StatsEventsList statsEventsList, final ApiCallback _callback) throws ApiException { - - // verify the required parameter 'statsEventsList' is set - if (statsEventsList == null) { - throw new ApiException("Missing the required parameter 'statsEventsList' when calling postStatsEvents(Async)"); - } - - - okhttp3.Call localVarCall = postStatsEventsCall(statsEventsList, _callback); - return localVarCall; - - } - - /** - * post stats events, this endpoint is meant for internal use only - * - * @param statsEventsList (required) - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
- */ - public void postStatsEvents(StatsEventsList statsEventsList) throws ApiException { - postStatsEventsWithHttpInfo(statsEventsList); - } - - /** - * post stats events, this endpoint is meant for internal use only - * - * @param statsEventsList (required) - * @return ApiResponse<Void> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
- */ - public ApiResponse postStatsEventsWithHttpInfo(StatsEventsList statsEventsList) throws ApiException { - okhttp3.Call localVarCall = postStatsEventsValidateBeforeCall(statsEventsList, null); - return localVarApiClient.execute(localVarCall); - } - - /** - * post stats events, this endpoint is meant for internal use only (asynchronously) - * - * @param statsEventsList (required) - * @param _callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - * @http.response.details - - - - - - -
Status Code Description Response Headers
204 reported successfully -
400 Bad Request -
401 Unauthorized -
0 Internal Server Error -
- */ - public okhttp3.Call postStatsEventsAsync(StatsEventsList statsEventsList, final ApiCallback _callback) throws ApiException { - - okhttp3.Call localVarCall = postStatsEventsValidateBeforeCall(statsEventsList, _callback); - localVarApiClient.executeAsync(localVarCall, _callback); - return localVarCall; - } -} diff --git a/clients/java/src/test/java/io/lakefs/clients/api/AuthApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/AuthApiTest.java index 1d1effddc7a..83ba7f1aff3 100644 --- a/clients/java/src/test/java/io/lakefs/clients/api/AuthApiTest.java +++ b/clients/java/src/test/java/io/lakefs/clients/api/AuthApiTest.java @@ -15,7 +15,6 @@ import io.lakefs.clients.api.ApiException; import io.lakefs.clients.api.model.ACL; -import io.lakefs.clients.api.model.AuthCapabilities; import io.lakefs.clients.api.model.AuthenticationToken; import io.lakefs.clients.api.model.Credentials; import io.lakefs.clients.api.model.CredentialsList; @@ -283,20 +282,6 @@ public void forgotPasswordTest() throws ApiException { // TODO: test validations } - /** - * list authentication capabilities supported - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getAuthCapabilitiesTest() throws ApiException { - AuthCapabilities response = api.getAuthCapabilities(); - // TODO: test validations - } - /** * get credentials * diff --git a/clients/java/src/test/java/io/lakefs/clients/api/ConfigApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/ConfigApiTest.java index aac4fa4c920..2700dd5bdc3 100644 --- a/clients/java/src/test/java/io/lakefs/clients/api/ConfigApiTest.java +++ b/clients/java/src/test/java/io/lakefs/clients/api/ConfigApiTest.java @@ -14,12 +14,8 @@ package io.lakefs.clients.api; import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.model.CommPrefsInput; -import io.lakefs.clients.api.model.CredentialsWithSecret; import io.lakefs.clients.api.model.Error; import io.lakefs.clients.api.model.GarbageCollectionConfig; -import io.lakefs.clients.api.model.Setup; -import io.lakefs.clients.api.model.SetupState; import io.lakefs.clients.api.model.StorageConfig; import io.lakefs.clients.api.model.VersionConfig; import org.junit.Test; @@ -67,20 +63,6 @@ public void getLakeFSVersionTest() throws ApiException { // TODO: test validations } - /** - * check if the lakeFS installation is already set up - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void getSetupStateTest() throws ApiException { - SetupState response = api.getSetupState(); - // TODO: test validations - } - /** * * @@ -95,34 +77,4 @@ public void getStorageConfigTest() throws ApiException { // TODO: test validations } - /** - * setup lakeFS and create a first user - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void setupTest() throws ApiException { - Setup setup = null; - CredentialsWithSecret response = api.setup(setup); - // TODO: test validations - } - - /** - * setup communications preferences - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void setupCommPrefsTest() throws ApiException { - CommPrefsInput commPrefsInput = null; - api.setupCommPrefs(commPrefsInput); - // TODO: test validations - } - } diff --git a/clients/java/src/test/java/io/lakefs/clients/api/InternalApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/InternalApiTest.java new file mode 100644 index 00000000000..d27a16781ec --- /dev/null +++ b/clients/java/src/test/java/io/lakefs/clients/api/InternalApiTest.java @@ -0,0 +1,179 @@ +/* + * lakeFS API + * lakeFS HTTP API + * + * The version of the OpenAPI document: 0.1.0 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package io.lakefs.clients.api; + +import io.lakefs.clients.api.ApiException; +import io.lakefs.clients.api.model.AuthCapabilities; +import io.lakefs.clients.api.model.CommPrefsInput; +import io.lakefs.clients.api.model.CredentialsWithSecret; +import io.lakefs.clients.api.model.Error; +import io.lakefs.clients.api.model.Setup; +import io.lakefs.clients.api.model.SetupState; +import io.lakefs.clients.api.model.StatsEventsList; +import io.lakefs.clients.api.model.UpdateToken; +import org.junit.Test; +import org.junit.Ignore; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for InternalApi + */ +@Ignore +public class InternalApiTest { + + private final InternalApi api = new InternalApi(); + + + /** + * + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createBranchProtectionRulePreflightTest() throws ApiException { + String repository = null; + api.createBranchProtectionRulePreflight(repository); + // TODO: test validations + } + + /** + * list authentication capabilities supported + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getAuthCapabilitiesTest() throws ApiException { + AuthCapabilities response = api.getAuthCapabilities(); + // TODO: test validations + } + + /** + * check if the lakeFS installation is already set up + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getSetupStateTest() throws ApiException { + SetupState response = api.getSetupState(); + // TODO: test validations + } + + /** + * post stats events, this endpoint is meant for internal use only + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void postStatsEventsTest() throws ApiException { + StatsEventsList statsEventsList = null; + api.postStatsEvents(statsEventsList); + // TODO: test validations + } + + /** + * + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void setGarbageCollectionRulesPreflightTest() throws ApiException { + String repository = null; + api.setGarbageCollectionRulesPreflight(repository); + // TODO: test validations + } + + /** + * setup lakeFS and create a first user + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void setupTest() throws ApiException { + Setup setup = null; + CredentialsWithSecret response = api.setup(setup); + // TODO: test validations + } + + /** + * setup communications preferences + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void setupCommPrefsTest() throws ApiException { + CommPrefsInput commPrefsInput = null; + api.setupCommPrefs(commPrefsInput); + // TODO: test validations + } + + /** + * modify branch staging token + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updateBranchTokenTest() throws ApiException { + String repository = null; + String branch = null; + UpdateToken updateToken = null; + api.updateBranchToken(repository, branch, updateToken); + // TODO: test validations + } + + /** + * + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void uploadObjectPreflightTest() throws ApiException { + String repository = null; + String branch = null; + String path = null; + api.uploadObjectPreflight(repository, branch, path); + // TODO: test validations + } + +} diff --git a/clients/java/src/test/java/io/lakefs/clients/api/ObjectsApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/ObjectsApiTest.java index 15ce6212b85..cc2d51325ff 100644 --- a/clients/java/src/test/java/io/lakefs/clients/api/ObjectsApiTest.java +++ b/clients/java/src/test/java/io/lakefs/clients/api/ObjectsApiTest.java @@ -225,21 +225,4 @@ public void uploadObjectTest() throws ApiException { // TODO: test validations } - /** - * - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void uploadObjectPreflightTest() throws ApiException { - String repository = null; - String branch = null; - String path = null; - api.uploadObjectPreflight(repository, branch, path); - // TODO: test validations - } - } diff --git a/clients/java/src/test/java/io/lakefs/clients/api/RepositoriesApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/RepositoriesApiTest.java index a2a8882b885..a80a69febbb 100644 --- a/clients/java/src/test/java/io/lakefs/clients/api/RepositoriesApiTest.java +++ b/clients/java/src/test/java/io/lakefs/clients/api/RepositoriesApiTest.java @@ -53,21 +53,6 @@ public void createBranchProtectionRuleTest() throws ApiException { // TODO: test validations } - /** - * - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void createBranchProtectionRulePreflightTest() throws ApiException { - String repository = null; - api.createBranchProtectionRulePreflight(repository); - // TODO: test validations - } - /** * create repository * diff --git a/clients/java/src/test/java/io/lakefs/clients/api/RetentionApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/RetentionApiTest.java index 1db69f3f66e..f9e0d39b8b9 100644 --- a/clients/java/src/test/java/io/lakefs/clients/api/RetentionApiTest.java +++ b/clients/java/src/test/java/io/lakefs/clients/api/RetentionApiTest.java @@ -115,19 +115,4 @@ public void setGarbageCollectionRulesTest() throws ApiException { // TODO: test validations } - /** - * - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void setGarbageCollectionRulesPreflightTest() throws ApiException { - String repository = null; - api.setGarbageCollectionRulesPreflight(repository); - // TODO: test validations - } - } diff --git a/clients/java/src/test/java/io/lakefs/clients/api/StagingApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/StagingApiTest.java index 4a98f142922..15ae8f85bbe 100644 --- a/clients/java/src/test/java/io/lakefs/clients/api/StagingApiTest.java +++ b/clients/java/src/test/java/io/lakefs/clients/api/StagingApiTest.java @@ -18,7 +18,6 @@ import io.lakefs.clients.api.model.ObjectStats; import io.lakefs.clients.api.model.StagingLocation; import io.lakefs.clients.api.model.StagingMetadata; -import io.lakefs.clients.api.model.UpdateToken; import org.junit.Test; import org.junit.Ignore; @@ -72,21 +71,4 @@ public void linkPhysicalAddressTest() throws ApiException { // TODO: test validations } - /** - * modify branch staging token - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void updateBranchTokenTest() throws ApiException { - String repository = null; - String branch = null; - UpdateToken updateToken = null; - api.updateBranchToken(repository, branch, updateToken); - // TODO: test validations - } - } diff --git a/clients/java/src/test/java/io/lakefs/clients/api/StatisticsApiTest.java b/clients/java/src/test/java/io/lakefs/clients/api/StatisticsApiTest.java deleted file mode 100644 index d5628a0b809..00000000000 --- a/clients/java/src/test/java/io/lakefs/clients/api/StatisticsApiTest.java +++ /dev/null @@ -1,51 +0,0 @@ -/* - * lakeFS API - * lakeFS HTTP API - * - * The version of the OpenAPI document: 0.1.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -package io.lakefs.clients.api; - -import io.lakefs.clients.api.ApiException; -import io.lakefs.clients.api.model.Error; -import io.lakefs.clients.api.model.StatsEventsList; -import org.junit.Test; -import org.junit.Ignore; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for StatisticsApi - */ -@Ignore -public class StatisticsApiTest { - - private final StatisticsApi api = new StatisticsApi(); - - - /** - * post stats events, this endpoint is meant for internal use only - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void postStatsEventsTest() throws ApiException { - StatsEventsList statsEventsList = null; - api.postStatsEvents(statsEventsList); - // TODO: test validations - } - -} diff --git a/clients/python/.openapi-generator/FILES b/clients/python/.openapi-generator/FILES index fb241b460cd..47aa8964a5d 100644 --- a/clients/python/.openapi-generator/FILES +++ b/clients/python/.openapi-generator/FILES @@ -50,6 +50,7 @@ docs/ImportPagination.md docs/ImportStatusResp.md docs/IngestRangeCreationResponse.md docs/InlineObject1.md +docs/InternalApi.md docs/LoginConfig.md docs/LoginInformation.md docs/Merge.md @@ -94,7 +95,6 @@ docs/StagingApi.md docs/StagingLocation.md docs/StagingMetadata.md docs/Statement.md -docs/StatisticsApi.md docs/StatsEvent.md docs/StatsEventsList.md docs/StorageConfig.md @@ -119,13 +119,13 @@ lakefs_client/api/config_api.py lakefs_client/api/experimental_api.py lakefs_client/api/health_check_api.py lakefs_client/api/import_api.py +lakefs_client/api/internal_api.py lakefs_client/api/metadata_api.py lakefs_client/api/objects_api.py lakefs_client/api/refs_api.py lakefs_client/api/repositories_api.py lakefs_client/api/retention_api.py lakefs_client/api/staging_api.py -lakefs_client/api/statistics_api.py lakefs_client/api/tags_api.py lakefs_client/api/templates_api.py lakefs_client/api_client.py @@ -282,6 +282,7 @@ test/test_import_pagination.py test/test_import_status_resp.py test/test_ingest_range_creation_response.py test/test_inline_object1.py +test/test_internal_api.py test/test_login_config.py test/test_login_information.py test/test_merge.py @@ -326,7 +327,6 @@ test/test_staging_api.py test/test_staging_location.py test/test_staging_metadata.py test/test_statement.py -test/test_statistics_api.py test/test_stats_event.py test/test_stats_events_list.py test/test_storage_config.py diff --git a/clients/python/README.md b/clients/python/README.md index 8d378b85028..c3f8eac40c2 100644 --- a/clients/python/README.md +++ b/clients/python/README.md @@ -135,7 +135,6 @@ Class | Method | HTTP request | Description *AuthApi* | [**detach_policy_from_group**](docs/AuthApi.md#detach_policy_from_group) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group *AuthApi* | [**detach_policy_from_user**](docs/AuthApi.md#detach_policy_from_user) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user *AuthApi* | [**forgot_password**](docs/AuthApi.md#forgot_password) | **POST** /auth/password/forgot | forgot password request initiates the password reset process -*AuthApi* | [**get_auth_capabilities**](docs/AuthApi.md#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported *AuthApi* | [**get_credentials**](docs/AuthApi.md#get_credentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials *AuthApi* | [**get_current_user**](docs/AuthApi.md#get_current_user) | **GET** /user | get current user *AuthApi* | [**get_group**](docs/AuthApi.md#get_group) | **GET** /auth/groups/{groupId} | get group @@ -166,10 +165,7 @@ Class | Method | HTTP request | Description *CommitsApi* | [**get_commit**](docs/CommitsApi.md#get_commit) | **GET** /repositories/{repository}/commits/{commitId} | get commit *ConfigApi* | [**get_garbage_collection_config**](docs/ConfigApi.md#get_garbage_collection_config) | **GET** /config/garbage-collection | *ConfigApi* | [**get_lake_fs_version**](docs/ConfigApi.md#get_lake_fs_version) | **GET** /config/version | -*ConfigApi* | [**get_setup_state**](docs/ConfigApi.md#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up *ConfigApi* | [**get_storage_config**](docs/ConfigApi.md#get_storage_config) | **GET** /config/storage | -*ConfigApi* | [**setup**](docs/ConfigApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user -*ConfigApi* | [**setup_comm_prefs**](docs/ConfigApi.md#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences *ExperimentalApi* | [**get_otf_diffs**](docs/ExperimentalApi.md#get_otf_diffs) | **GET** /otf/diffs | get the available Open Table Format diffs *ExperimentalApi* | [**otf_diff**](docs/ExperimentalApi.md#otf_diff) | **GET** /repositories/{repository}/otf/refs/{left_ref}/diff/{right_ref} | perform otf diff *HealthCheckApi* | [**health_check**](docs/HealthCheckApi.md#health_check) | **GET** /healthcheck | @@ -178,6 +174,15 @@ Class | Method | HTTP request | Description *ImportApi* | [**import_start**](docs/ImportApi.md#import_start) | **POST** /repositories/{repository}/branches/{branch}/import | import data from object store *ImportApi* | [**import_status**](docs/ImportApi.md#import_status) | **GET** /repositories/{repository}/branches/{branch}/import | get import status *ImportApi* | [**ingest_range**](docs/ImportApi.md#ingest_range) | **POST** /repositories/{repository}/branches/ranges | create a lakeFS range file from the source uri +*InternalApi* | [**create_branch_protection_rule_preflight**](docs/InternalApi.md#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | +*InternalApi* | [**get_auth_capabilities**](docs/InternalApi.md#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported +*InternalApi* | [**get_setup_state**](docs/InternalApi.md#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up +*InternalApi* | [**post_stats_events**](docs/InternalApi.md#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only +*InternalApi* | [**set_garbage_collection_rules_preflight**](docs/InternalApi.md#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | +*InternalApi* | [**setup**](docs/InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user +*InternalApi* | [**setup_comm_prefs**](docs/InternalApi.md#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences +*InternalApi* | [**update_branch_token**](docs/InternalApi.md#update_branch_token) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token +*InternalApi* | [**upload_object_preflight**](docs/InternalApi.md#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | *MetadataApi* | [**create_symlink_file**](docs/MetadataApi.md#create_symlink_file) | **POST** /repositories/{repository}/refs/{branch}/symlink | creates symlink files corresponding to the given directory *MetadataApi* | [**get_meta_range**](docs/MetadataApi.md#get_meta_range) | **GET** /repositories/{repository}/metadata/meta_range/{meta_range} | return URI to a meta-range file *MetadataApi* | [**get_range**](docs/MetadataApi.md#get_range) | **GET** /repositories/{repository}/metadata/range/{range} | return URI to a range file @@ -191,7 +196,6 @@ Class | Method | HTTP request | Description *ObjectsApi* | [**stage_object**](docs/ObjectsApi.md#stage_object) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch *ObjectsApi* | [**stat_object**](docs/ObjectsApi.md#stat_object) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata *ObjectsApi* | [**upload_object**](docs/ObjectsApi.md#upload_object) | **POST** /repositories/{repository}/branches/{branch}/objects | -*ObjectsApi* | [**upload_object_preflight**](docs/ObjectsApi.md#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | *RefsApi* | [**diff_refs**](docs/RefsApi.md#diff_refs) | **GET** /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references *RefsApi* | [**dump_refs**](docs/RefsApi.md#dump_refs) | **PUT** /repositories/{repository}/refs/dump | Dump repository refs (tags, commits, branches) to object store *RefsApi* | [**find_merge_base**](docs/RefsApi.md#find_merge_base) | **GET** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | find the merge base for 2 references @@ -199,7 +203,6 @@ Class | Method | HTTP request | Description *RefsApi* | [**merge_into_branch**](docs/RefsApi.md#merge_into_branch) | **POST** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | merge references *RefsApi* | [**restore_refs**](docs/RefsApi.md#restore_refs) | **PUT** /repositories/{repository}/refs/restore | Restore repository refs (tags, commits, branches) from object store *RepositoriesApi* | [**create_branch_protection_rule**](docs/RepositoriesApi.md#create_branch_protection_rule) | **POST** /repositories/{repository}/branch_protection | -*RepositoriesApi* | [**create_branch_protection_rule_preflight**](docs/RepositoriesApi.md#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | *RepositoriesApi* | [**create_repository**](docs/RepositoriesApi.md#create_repository) | **POST** /repositories | create repository *RepositoriesApi* | [**delete_branch_protection_rule**](docs/RepositoriesApi.md#delete_branch_protection_rule) | **DELETE** /repositories/{repository}/branch_protection | *RepositoriesApi* | [**delete_repository**](docs/RepositoriesApi.md#delete_repository) | **DELETE** /repositories/{repository} | delete repository @@ -212,11 +215,8 @@ Class | Method | HTTP request | Description *RetentionApi* | [**prepare_garbage_collection_commits**](docs/RetentionApi.md#prepare_garbage_collection_commits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active and expired commits for garbage collection *RetentionApi* | [**prepare_garbage_collection_uncommitted**](docs/RetentionApi.md#prepare_garbage_collection_uncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection *RetentionApi* | [**set_garbage_collection_rules**](docs/RetentionApi.md#set_garbage_collection_rules) | **POST** /repositories/{repository}/gc/rules | -*RetentionApi* | [**set_garbage_collection_rules_preflight**](docs/RetentionApi.md#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | *StagingApi* | [**get_physical_address**](docs/StagingApi.md#get_physical_address) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | get a physical address and a return token to write object to underlying storage *StagingApi* | [**link_physical_address**](docs/StagingApi.md#link_physical_address) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path -*StagingApi* | [**update_branch_token**](docs/StagingApi.md#update_branch_token) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token -*StatisticsApi* | [**post_stats_events**](docs/StatisticsApi.md#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only *TagsApi* | [**create_tag**](docs/TagsApi.md#create_tag) | **POST** /repositories/{repository}/tags | create tag *TagsApi* | [**delete_tag**](docs/TagsApi.md#delete_tag) | **DELETE** /repositories/{repository}/tags/{tag} | delete tag *TagsApi* | [**get_tag**](docs/TagsApi.md#get_tag) | **GET** /repositories/{repository}/tags/{tag} | get tag diff --git a/clients/python/docs/AuthApi.md b/clients/python/docs/AuthApi.md index 36a6e08fca2..4f83baa0045 100644 --- a/clients/python/docs/AuthApi.md +++ b/clients/python/docs/AuthApi.md @@ -19,7 +19,6 @@ Method | HTTP request | Description [**detach_policy_from_group**](AuthApi.md#detach_policy_from_group) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group [**detach_policy_from_user**](AuthApi.md#detach_policy_from_user) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user [**forgot_password**](AuthApi.md#forgot_password) | **POST** /auth/password/forgot | forgot password request initiates the password reset process -[**get_auth_capabilities**](AuthApi.md#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported [**get_credentials**](AuthApi.md#get_credentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials [**get_current_user**](AuthApi.md#get_current_user) | **GET** /user | get current user [**get_group**](AuthApi.md#get_group) | **GET** /auth/groups/{groupId} | get group @@ -1624,69 +1623,6 @@ No authorization required [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_auth_capabilities** -> AuthCapabilities get_auth_capabilities() - -list authentication capabilities supported - -### Example - - -```python -import time -import lakefs_client -from lakefs_client.api import auth_api -from lakefs_client.model.error import Error -from lakefs_client.model.auth_capabilities import AuthCapabilities -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = auth_api.AuthApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # list authentication capabilities supported - api_response = api_instance.get_auth_capabilities() - pprint(api_response) - except lakefs_client.ApiException as e: - print("Exception when calling AuthApi->get_auth_capabilities: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**AuthCapabilities**](AuthCapabilities.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | auth capabilities | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_credentials** > Credentials get_credentials(user_id, access_key_id) diff --git a/clients/python/docs/ConfigApi.md b/clients/python/docs/ConfigApi.md index e805ce97576..77ccd7d2f58 100644 --- a/clients/python/docs/ConfigApi.md +++ b/clients/python/docs/ConfigApi.md @@ -6,10 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_garbage_collection_config**](ConfigApi.md#get_garbage_collection_config) | **GET** /config/garbage-collection | [**get_lake_fs_version**](ConfigApi.md#get_lake_fs_version) | **GET** /config/version | -[**get_setup_state**](ConfigApi.md#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up [**get_storage_config**](ConfigApi.md#get_storage_config) | **GET** /config/storage | -[**setup**](ConfigApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user -[**setup_comm_prefs**](ConfigApi.md#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences # **get_garbage_collection_config** @@ -216,69 +213,6 @@ This endpoint does not need any parameter. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **get_setup_state** -> SetupState get_setup_state() - -check if the lakeFS installation is already set up - -### Example - - -```python -import time -import lakefs_client -from lakefs_client.api import config_api -from lakefs_client.model.error import Error -from lakefs_client.model.setup_state import SetupState -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = config_api.ConfigApi(api_client) - - # example, this endpoint has no required or optional parameters - try: - # check if the lakeFS installation is already set up - api_response = api_instance.get_setup_state() - pprint(api_response) - except lakefs_client.ApiException as e: - print("Exception when calling ConfigApi->get_setup_state: %s\n" % e) -``` - - -### Parameters -This endpoint does not need any parameter. - -### Return type - -[**SetupState**](SetupState.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | lakeFS setup state | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **get_storage_config** > StorageConfig get_storage_config() @@ -381,151 +315,3 @@ This endpoint does not need any parameter. [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **setup** -> CredentialsWithSecret setup(setup) - -setup lakeFS and create a first user - -### Example - - -```python -import time -import lakefs_client -from lakefs_client.api import config_api -from lakefs_client.model.credentials_with_secret import CredentialsWithSecret -from lakefs_client.model.setup import Setup -from lakefs_client.model.error import Error -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = config_api.ConfigApi(api_client) - setup = Setup( - username="username_example", - key=AccessKeyCredentials( - access_key_id="AKIAIOSFODNN7EXAMPLE", - secret_access_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", - ), - ) # Setup | - - # example passing only required values which don't have defaults set - try: - # setup lakeFS and create a first user - api_response = api_instance.setup(setup) - pprint(api_response) - except lakefs_client.ApiException as e: - print("Exception when calling ConfigApi->setup: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **setup** | [**Setup**](Setup.md)| | - -### Return type - -[**CredentialsWithSecret**](CredentialsWithSecret.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | user created successfully | - | -**400** | Bad Request | - | -**409** | setup was already called | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - -# **setup_comm_prefs** -> setup_comm_prefs(comm_prefs_input) - -setup communications preferences - -### Example - - -```python -import time -import lakefs_client -from lakefs_client.api import config_api -from lakefs_client.model.comm_prefs_input import CommPrefsInput -from lakefs_client.model.error import Error -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient() as api_client: - # Create an instance of the API class - api_instance = config_api.ConfigApi(api_client) - comm_prefs_input = CommPrefsInput( - email="email_example", - feature_updates=True, - security_updates=True, - ) # CommPrefsInput | - - # example passing only required values which don't have defaults set - try: - # setup communications preferences - api_instance.setup_comm_prefs(comm_prefs_input) - except lakefs_client.ApiException as e: - print("Exception when calling ConfigApi->setup_comm_prefs: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **comm_prefs_input** | [**CommPrefsInput**](CommPrefsInput.md)| | - -### Return type - -void (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | communication preferences saved successfully | - | -**409** | setup was already completed | - | -**412** | wrong setup state for this operation | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/clients/python/docs/InternalApi.md b/clients/python/docs/InternalApi.md new file mode 100644 index 00000000000..42fe236887a --- /dev/null +++ b/clients/python/docs/InternalApi.md @@ -0,0 +1,837 @@ +# lakefs_client.InternalApi + +All URIs are relative to *http://localhost/api/v1* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_branch_protection_rule_preflight**](InternalApi.md#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | +[**get_auth_capabilities**](InternalApi.md#get_auth_capabilities) | **GET** /auth/capabilities | list authentication capabilities supported +[**get_setup_state**](InternalApi.md#get_setup_state) | **GET** /setup_lakefs | check if the lakeFS installation is already set up +[**post_stats_events**](InternalApi.md#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only +[**set_garbage_collection_rules_preflight**](InternalApi.md#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | +[**setup**](InternalApi.md#setup) | **POST** /setup_lakefs | setup lakeFS and create a first user +[**setup_comm_prefs**](InternalApi.md#setup_comm_prefs) | **POST** /setup_comm_prefs | setup communications preferences +[**update_branch_token**](InternalApi.md#update_branch_token) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token +[**upload_object_preflight**](InternalApi.md#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | + + +# **create_branch_protection_rule_preflight** +> create_branch_protection_rule_preflight(repository) + + + +### Example + +* Basic Authentication (basic_auth): +* Api Key Authentication (cookie_auth): +* Bearer (JWT) Authentication (jwt_token): +* Api Key Authentication (oidc_auth): +* Api Key Authentication (saml_auth): + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.error import Error +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basic_auth +configuration = lakefs_client.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure API key authorization: cookie_auth +configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['cookie_auth'] = 'Bearer' + +# Configure Bearer authorization (JWT): jwt_token +configuration = lakefs_client.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: oidc_auth +configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['oidc_auth'] = 'Bearer' + +# Configure API key authorization: saml_auth +configuration.api_key['saml_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['saml_auth'] = 'Bearer' + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + repository = "repository_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.create_branch_protection_rule_preflight(repository) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->create_branch_protection_rule_preflight: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | User has permissions to create a branch protection rule in this repository | - | +**401** | Unauthorized | - | +**404** | Resource Not Found | - | +**409** | Resource Conflicts With Target | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_auth_capabilities** +> AuthCapabilities get_auth_capabilities() + +list authentication capabilities supported + +### Example + + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.error import Error +from lakefs_client.model.auth_capabilities import AuthCapabilities +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # list authentication capabilities supported + api_response = api_instance.get_auth_capabilities() + pprint(api_response) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->get_auth_capabilities: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**AuthCapabilities**](AuthCapabilities.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | auth capabilities | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **get_setup_state** +> SetupState get_setup_state() + +check if the lakeFS installation is already set up + +### Example + + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.error import Error +from lakefs_client.model.setup_state import SetupState +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + + # example, this endpoint has no required or optional parameters + try: + # check if the lakeFS installation is already set up + api_response = api_instance.get_setup_state() + pprint(api_response) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->get_setup_state: %s\n" % e) +``` + + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**SetupState**](SetupState.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | lakeFS setup state | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **post_stats_events** +> post_stats_events(stats_events_list) + +post stats events, this endpoint is meant for internal use only + +### Example + +* Basic Authentication (basic_auth): +* Api Key Authentication (cookie_auth): +* Bearer (JWT) Authentication (jwt_token): +* Api Key Authentication (oidc_auth): +* Api Key Authentication (saml_auth): + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.error import Error +from lakefs_client.model.stats_events_list import StatsEventsList +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basic_auth +configuration = lakefs_client.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure API key authorization: cookie_auth +configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['cookie_auth'] = 'Bearer' + +# Configure Bearer authorization (JWT): jwt_token +configuration = lakefs_client.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: oidc_auth +configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['oidc_auth'] = 'Bearer' + +# Configure API key authorization: saml_auth +configuration.api_key['saml_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['saml_auth'] = 'Bearer' + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + stats_events_list = StatsEventsList( + events=[ + StatsEvent( + _class="_class_example", + name="name_example", + count=1, + ), + ], + ) # StatsEventsList | + + # example passing only required values which don't have defaults set + try: + # post stats events, this endpoint is meant for internal use only + api_instance.post_stats_events(stats_events_list) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->post_stats_events: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **stats_events_list** | [**StatsEventsList**](StatsEventsList.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | reported successfully | - | +**400** | Bad Request | - | +**401** | Unauthorized | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **set_garbage_collection_rules_preflight** +> set_garbage_collection_rules_preflight(repository) + + + +### Example + +* Basic Authentication (basic_auth): +* Api Key Authentication (cookie_auth): +* Bearer (JWT) Authentication (jwt_token): +* Api Key Authentication (oidc_auth): +* Api Key Authentication (saml_auth): + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.error import Error +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basic_auth +configuration = lakefs_client.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure API key authorization: cookie_auth +configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['cookie_auth'] = 'Bearer' + +# Configure Bearer authorization (JWT): jwt_token +configuration = lakefs_client.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: oidc_auth +configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['oidc_auth'] = 'Bearer' + +# Configure API key authorization: saml_auth +configuration.api_key['saml_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['saml_auth'] = 'Bearer' + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + repository = "repository_example" # str | + + # example passing only required values which don't have defaults set + try: + api_instance.set_garbage_collection_rules_preflight(repository) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->set_garbage_collection_rules_preflight: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | User has permissions to set garbage collection rules on this repository | - | +**401** | Unauthorized | - | +**404** | Resource Not Found | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setup** +> CredentialsWithSecret setup(setup) + +setup lakeFS and create a first user + +### Example + + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.credentials_with_secret import CredentialsWithSecret +from lakefs_client.model.setup import Setup +from lakefs_client.model.error import Error +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + setup = Setup( + username="username_example", + key=AccessKeyCredentials( + access_key_id="AKIAIOSFODNN7EXAMPLE", + secret_access_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", + ), + ) # Setup | + + # example passing only required values which don't have defaults set + try: + # setup lakeFS and create a first user + api_response = api_instance.setup(setup) + pprint(api_response) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->setup: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **setup** | [**Setup**](Setup.md)| | + +### Return type + +[**CredentialsWithSecret**](CredentialsWithSecret.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | user created successfully | - | +**400** | Bad Request | - | +**409** | setup was already called | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **setup_comm_prefs** +> setup_comm_prefs(comm_prefs_input) + +setup communications preferences + +### Example + + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.comm_prefs_input import CommPrefsInput +from lakefs_client.model.error import Error +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient() as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + comm_prefs_input = CommPrefsInput( + email="email_example", + feature_updates=True, + security_updates=True, + ) # CommPrefsInput | + + # example passing only required values which don't have defaults set + try: + # setup communications preferences + api_instance.setup_comm_prefs(comm_prefs_input) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->setup_comm_prefs: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **comm_prefs_input** | [**CommPrefsInput**](CommPrefsInput.md)| | + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | communication preferences saved successfully | - | +**409** | setup was already completed | - | +**412** | wrong setup state for this operation | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **update_branch_token** +> update_branch_token(repository, branch, update_token) + +modify branch staging token + +### Example + +* Basic Authentication (basic_auth): +* Api Key Authentication (cookie_auth): +* Bearer (JWT) Authentication (jwt_token): +* Api Key Authentication (oidc_auth): +* Api Key Authentication (saml_auth): + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.update_token import UpdateToken +from lakefs_client.model.error import Error +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basic_auth +configuration = lakefs_client.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure API key authorization: cookie_auth +configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['cookie_auth'] = 'Bearer' + +# Configure Bearer authorization (JWT): jwt_token +configuration = lakefs_client.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: oidc_auth +configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['oidc_auth'] = 'Bearer' + +# Configure API key authorization: saml_auth +configuration.api_key['saml_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['saml_auth'] = 'Bearer' + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + repository = "repository_example" # str | + branch = "branch_example" # str | + update_token = UpdateToken( + staging_token="staging_token_example", + ) # UpdateToken | + + # example passing only required values which don't have defaults set + try: + # modify branch staging token + api_instance.update_branch_token(repository, branch, update_token) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->update_branch_token: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **str**| | + **branch** | **str**| | + **update_token** | [**UpdateToken**](UpdateToken.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | branch updated successfully | - | +**400** | Validation Error | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Resource Not Found | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **upload_object_preflight** +> upload_object_preflight(repository, branch, path) + + + +### Example + +* Basic Authentication (basic_auth): +* Api Key Authentication (cookie_auth): +* Bearer (JWT) Authentication (jwt_token): +* Api Key Authentication (oidc_auth): +* Api Key Authentication (saml_auth): + +```python +import time +import lakefs_client +from lakefs_client.api import internal_api +from lakefs_client.model.error import Error +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = lakefs_client.Configuration( + host = "http://localhost/api/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure HTTP basic authorization: basic_auth +configuration = lakefs_client.Configuration( + username = 'YOUR_USERNAME', + password = 'YOUR_PASSWORD' +) + +# Configure API key authorization: cookie_auth +configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['cookie_auth'] = 'Bearer' + +# Configure Bearer authorization (JWT): jwt_token +configuration = lakefs_client.Configuration( + access_token = 'YOUR_BEARER_TOKEN' +) + +# Configure API key authorization: oidc_auth +configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['oidc_auth'] = 'Bearer' + +# Configure API key authorization: saml_auth +configuration.api_key['saml_auth'] = 'YOUR_API_KEY' + +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['saml_auth'] = 'Bearer' + +# Enter a context with an instance of the API client +with lakefs_client.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = internal_api.InternalApi(api_client) + repository = "repository_example" # str | + branch = "branch_example" # str | + path = "path_example" # str | relative to the branch + + # example passing only required values which don't have defaults set + try: + api_instance.upload_object_preflight(repository, branch, path) + except lakefs_client.ApiException as e: + print("Exception when calling InternalApi->upload_object_preflight: %s\n" % e) +``` + + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **repository** | **str**| | + **branch** | **str**| | + **path** | **str**| relative to the branch | + +### Return type + +void (empty response body) + +### Authorization + +[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details + +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**204** | User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint | - | +**401** | Unauthorized | - | +**403** | Forbidden | - | +**404** | Resource Not Found | - | +**0** | Internal Server Error | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/clients/python/docs/ObjectsApi.md b/clients/python/docs/ObjectsApi.md index 5d8ead56b7f..3c24e464c1a 100644 --- a/clients/python/docs/ObjectsApi.md +++ b/clients/python/docs/ObjectsApi.md @@ -14,7 +14,6 @@ Method | HTTP request | Description [**stage_object**](ObjectsApi.md#stage_object) | **PUT** /repositories/{repository}/branches/{branch}/objects | stage an object's metadata for the given branch [**stat_object**](ObjectsApi.md#stat_object) | **GET** /repositories/{repository}/refs/{ref}/objects/stat | get object metadata [**upload_object**](ObjectsApi.md#upload_object) | **POST** /repositories/{repository}/branches/{branch}/objects | -[**upload_object_preflight**](ObjectsApi.md#upload_object_preflight) | **GET** /repositories/{repository}/branches/{branch}/objects/stage_allowed | # **copy_object** @@ -1229,112 +1228,3 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **upload_object_preflight** -> upload_object_preflight(repository, branch, path) - - - -### Example - -* Basic Authentication (basic_auth): -* Api Key Authentication (cookie_auth): -* Bearer (JWT) Authentication (jwt_token): -* Api Key Authentication (oidc_auth): -* Api Key Authentication (saml_auth): - -```python -import time -import lakefs_client -from lakefs_client.api import objects_api -from lakefs_client.model.error import Error -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basic_auth -configuration = lakefs_client.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure API key authorization: cookie_auth -configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['cookie_auth'] = 'Bearer' - -# Configure Bearer authorization (JWT): jwt_token -configuration = lakefs_client.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Configure API key authorization: oidc_auth -configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['oidc_auth'] = 'Bearer' - -# Configure API key authorization: saml_auth -configuration.api_key['saml_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['saml_auth'] = 'Bearer' - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = objects_api.ObjectsApi(api_client) - repository = "repository_example" # str | - branch = "branch_example" # str | - path = "path_example" # str | relative to the branch - - # example passing only required values which don't have defaults set - try: - api_instance.upload_object_preflight(repository, branch, path) - except lakefs_client.ApiException as e: - print("Exception when calling ObjectsApi->upload_object_preflight: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **str**| | - **branch** | **str**| | - **path** | **str**| relative to the branch | - -### Return type - -void (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User has permissions to upload this object. This does not guarantee that the upload will be successful or even possible. It indicates only the permission at the time of calling this endpoint | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**404** | Resource Not Found | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/clients/python/docs/RepositoriesApi.md b/clients/python/docs/RepositoriesApi.md index 2803f685abe..03d88bd7e9e 100644 --- a/clients/python/docs/RepositoriesApi.md +++ b/clients/python/docs/RepositoriesApi.md @@ -5,7 +5,6 @@ All URIs are relative to *http://localhost/api/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**create_branch_protection_rule**](RepositoriesApi.md#create_branch_protection_rule) | **POST** /repositories/{repository}/branch_protection | -[**create_branch_protection_rule_preflight**](RepositoriesApi.md#create_branch_protection_rule_preflight) | **GET** /repositories/{repository}/branch_protection/set_allowed | [**create_repository**](RepositoriesApi.md#create_repository) | **POST** /repositories | create repository [**delete_branch_protection_rule**](RepositoriesApi.md#delete_branch_protection_rule) | **DELETE** /repositories/{repository}/branch_protection | [**delete_repository**](RepositoriesApi.md#delete_repository) | **DELETE** /repositories/{repository} | delete repository @@ -124,111 +123,6 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **create_branch_protection_rule_preflight** -> create_branch_protection_rule_preflight(repository) - - - -### Example - -* Basic Authentication (basic_auth): -* Api Key Authentication (cookie_auth): -* Bearer (JWT) Authentication (jwt_token): -* Api Key Authentication (oidc_auth): -* Api Key Authentication (saml_auth): - -```python -import time -import lakefs_client -from lakefs_client.api import repositories_api -from lakefs_client.model.error import Error -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basic_auth -configuration = lakefs_client.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure API key authorization: cookie_auth -configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['cookie_auth'] = 'Bearer' - -# Configure Bearer authorization (JWT): jwt_token -configuration = lakefs_client.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Configure API key authorization: oidc_auth -configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['oidc_auth'] = 'Bearer' - -# Configure API key authorization: saml_auth -configuration.api_key['saml_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['saml_auth'] = 'Bearer' - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = repositories_api.RepositoriesApi(api_client) - repository = "repository_example" # str | - - # example passing only required values which don't have defaults set - try: - api_instance.create_branch_protection_rule_preflight(repository) - except lakefs_client.ApiException as e: - print("Exception when calling RepositoriesApi->create_branch_protection_rule_preflight: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User has permissions to create a branch protection rule in this repository | - | -**401** | Unauthorized | - | -**404** | Resource Not Found | - | -**409** | Resource Conflicts With Target | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - # **create_repository** > Repository create_repository(repository_creation) diff --git a/clients/python/docs/RetentionApi.md b/clients/python/docs/RetentionApi.md index 2ba47db3fff..70bfb16f04e 100644 --- a/clients/python/docs/RetentionApi.md +++ b/clients/python/docs/RetentionApi.md @@ -9,7 +9,6 @@ Method | HTTP request | Description [**prepare_garbage_collection_commits**](RetentionApi.md#prepare_garbage_collection_commits) | **POST** /repositories/{repository}/gc/prepare_commits | save lists of active and expired commits for garbage collection [**prepare_garbage_collection_uncommitted**](RetentionApi.md#prepare_garbage_collection_uncommitted) | **POST** /repositories/{repository}/gc/prepare_uncommited | save repository uncommitted metadata for garbage collection [**set_garbage_collection_rules**](RetentionApi.md#set_garbage_collection_rules) | **POST** /repositories/{repository}/gc/rules | -[**set_garbage_collection_rules_preflight**](RetentionApi.md#set_garbage_collection_rules_preflight) | **GET** /repositories/{repository}/gc/rules/set_allowed | # **delete_garbage_collection_rules** @@ -580,107 +579,3 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **set_garbage_collection_rules_preflight** -> set_garbage_collection_rules_preflight(repository) - - - -### Example - -* Basic Authentication (basic_auth): -* Api Key Authentication (cookie_auth): -* Bearer (JWT) Authentication (jwt_token): -* Api Key Authentication (oidc_auth): -* Api Key Authentication (saml_auth): - -```python -import time -import lakefs_client -from lakefs_client.api import retention_api -from lakefs_client.model.error import Error -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basic_auth -configuration = lakefs_client.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure API key authorization: cookie_auth -configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['cookie_auth'] = 'Bearer' - -# Configure Bearer authorization (JWT): jwt_token -configuration = lakefs_client.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Configure API key authorization: oidc_auth -configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['oidc_auth'] = 'Bearer' - -# Configure API key authorization: saml_auth -configuration.api_key['saml_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['saml_auth'] = 'Bearer' - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = retention_api.RetentionApi(api_client) - repository = "repository_example" # str | - - # example passing only required values which don't have defaults set - try: - api_instance.set_garbage_collection_rules_preflight(repository) - except lakefs_client.ApiException as e: - print("Exception when calling RetentionApi->set_garbage_collection_rules_preflight: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **str**| | - -### Return type - -void (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | User has permissions to set garbage collection rules on this repository | - | -**401** | Unauthorized | - | -**404** | Resource Not Found | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/clients/python/docs/StagingApi.md b/clients/python/docs/StagingApi.md index 4777be6f165..a4c39d2e6a1 100644 --- a/clients/python/docs/StagingApi.md +++ b/clients/python/docs/StagingApi.md @@ -6,7 +6,6 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**get_physical_address**](StagingApi.md#get_physical_address) | **GET** /repositories/{repository}/branches/{branch}/staging/backing | get a physical address and a return token to write object to underlying storage [**link_physical_address**](StagingApi.md#link_physical_address) | **PUT** /repositories/{repository}/branches/{branch}/staging/backing | associate staging on this physical address with a path -[**update_branch_token**](StagingApi.md#update_branch_token) | **PUT** /repositories/{repository}/branches/{branch}/update_token | modify branch staging token # **get_physical_address** @@ -263,117 +262,3 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **update_branch_token** -> update_branch_token(repository, branch, update_token) - -modify branch staging token - -### Example - -* Basic Authentication (basic_auth): -* Api Key Authentication (cookie_auth): -* Bearer (JWT) Authentication (jwt_token): -* Api Key Authentication (oidc_auth): -* Api Key Authentication (saml_auth): - -```python -import time -import lakefs_client -from lakefs_client.api import staging_api -from lakefs_client.model.update_token import UpdateToken -from lakefs_client.model.error import Error -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basic_auth -configuration = lakefs_client.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure API key authorization: cookie_auth -configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['cookie_auth'] = 'Bearer' - -# Configure Bearer authorization (JWT): jwt_token -configuration = lakefs_client.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Configure API key authorization: oidc_auth -configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['oidc_auth'] = 'Bearer' - -# Configure API key authorization: saml_auth -configuration.api_key['saml_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['saml_auth'] = 'Bearer' - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = staging_api.StagingApi(api_client) - repository = "repository_example" # str | - branch = "branch_example" # str | - update_token = UpdateToken( - staging_token="staging_token_example", - ) # UpdateToken | - - # example passing only required values which don't have defaults set - try: - # modify branch staging token - api_instance.update_branch_token(repository, branch, update_token) - except lakefs_client.ApiException as e: - print("Exception when calling StagingApi->update_branch_token: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **repository** | **str**| | - **branch** | **str**| | - **update_token** | [**UpdateToken**](UpdateToken.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | branch updated successfully | - | -**400** | Validation Error | - | -**401** | Unauthorized | - | -**403** | Forbidden | - | -**404** | Resource Not Found | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/clients/python/docs/StatisticsApi.md b/clients/python/docs/StatisticsApi.md deleted file mode 100644 index 19bbf669444..00000000000 --- a/clients/python/docs/StatisticsApi.md +++ /dev/null @@ -1,123 +0,0 @@ -# lakefs_client.StatisticsApi - -All URIs are relative to *http://localhost/api/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**post_stats_events**](StatisticsApi.md#post_stats_events) | **POST** /statistics | post stats events, this endpoint is meant for internal use only - - -# **post_stats_events** -> post_stats_events(stats_events_list) - -post stats events, this endpoint is meant for internal use only - -### Example - -* Basic Authentication (basic_auth): -* Api Key Authentication (cookie_auth): -* Bearer (JWT) Authentication (jwt_token): -* Api Key Authentication (oidc_auth): -* Api Key Authentication (saml_auth): - -```python -import time -import lakefs_client -from lakefs_client.api import statistics_api -from lakefs_client.model.error import Error -from lakefs_client.model.stats_events_list import StatsEventsList -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = lakefs_client.Configuration( - host = "http://localhost/api/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure HTTP basic authorization: basic_auth -configuration = lakefs_client.Configuration( - username = 'YOUR_USERNAME', - password = 'YOUR_PASSWORD' -) - -# Configure API key authorization: cookie_auth -configuration.api_key['cookie_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['cookie_auth'] = 'Bearer' - -# Configure Bearer authorization (JWT): jwt_token -configuration = lakefs_client.Configuration( - access_token = 'YOUR_BEARER_TOKEN' -) - -# Configure API key authorization: oidc_auth -configuration.api_key['oidc_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['oidc_auth'] = 'Bearer' - -# Configure API key authorization: saml_auth -configuration.api_key['saml_auth'] = 'YOUR_API_KEY' - -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['saml_auth'] = 'Bearer' - -# Enter a context with an instance of the API client -with lakefs_client.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = statistics_api.StatisticsApi(api_client) - stats_events_list = StatsEventsList( - events=[ - StatsEvent( - _class="_class_example", - name="name_example", - count=1, - ), - ], - ) # StatsEventsList | - - # example passing only required values which don't have defaults set - try: - # post stats events, this endpoint is meant for internal use only - api_instance.post_stats_events(stats_events_list) - except lakefs_client.ApiException as e: - print("Exception when calling StatisticsApi->post_stats_events: %s\n" % e) -``` - - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **stats_events_list** | [**StatsEventsList**](StatsEventsList.md)| | - -### Return type - -void (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [jwt_token](../README.md#jwt_token), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details - -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**204** | reported successfully | - | -**400** | Bad Request | - | -**401** | Unauthorized | - | -**0** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/clients/python/lakefs_client/api/auth_api.py b/clients/python/lakefs_client/api/auth_api.py index ad099610ed3..e69508ba528 100644 --- a/clients/python/lakefs_client/api/auth_api.py +++ b/clients/python/lakefs_client/api/auth_api.py @@ -23,7 +23,6 @@ validate_and_convert_types ) from lakefs_client.model.acl import ACL -from lakefs_client.model.auth_capabilities import AuthCapabilities from lakefs_client.model.authentication_token import AuthenticationToken from lakefs_client.model.credentials import Credentials from lakefs_client.model.credentials_list import CredentialsList @@ -916,48 +915,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_auth_capabilities_endpoint = _Endpoint( - settings={ - 'response_type': (AuthCapabilities,), - 'auth': [], - 'endpoint_path': '/auth/capabilities', - 'operation_id': 'get_auth_capabilities', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.get_credentials_endpoint = _Endpoint( settings={ 'response_type': (Credentials,), @@ -3099,66 +3056,6 @@ def forgot_password( forgot_password_request return self.forgot_password_endpoint.call_with_http_info(**kwargs) - def get_auth_capabilities( - self, - **kwargs - ): - """list authentication capabilities supported # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_auth_capabilities(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - AuthCapabilities - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.get_auth_capabilities_endpoint.call_with_http_info(**kwargs) - def get_credentials( self, user_id, diff --git a/clients/python/lakefs_client/api/config_api.py b/clients/python/lakefs_client/api/config_api.py index aabd4f1b90a..61317431a92 100644 --- a/clients/python/lakefs_client/api/config_api.py +++ b/clients/python/lakefs_client/api/config_api.py @@ -22,12 +22,8 @@ none_type, validate_and_convert_types ) -from lakefs_client.model.comm_prefs_input import CommPrefsInput -from lakefs_client.model.credentials_with_secret import CredentialsWithSecret from lakefs_client.model.error import Error from lakefs_client.model.garbage_collection_config import GarbageCollectionConfig -from lakefs_client.model.setup import Setup -from lakefs_client.model.setup_state import SetupState from lakefs_client.model.storage_config import StorageConfig from lakefs_client.model.version_config import VersionConfig @@ -139,48 +135,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.get_setup_state_endpoint = _Endpoint( - settings={ - 'response_type': (SetupState,), - 'auth': [], - 'endpoint_path': '/setup_lakefs', - 'operation_id': 'get_setup_state', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - ], - 'required': [], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - }, - 'attribute_map': { - }, - 'location_map': { - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.get_storage_config_endpoint = _Endpoint( settings={ 'response_type': (StorageConfig,), @@ -229,106 +183,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.setup_endpoint = _Endpoint( - settings={ - 'response_type': (CredentialsWithSecret,), - 'auth': [], - 'endpoint_path': '/setup_lakefs', - 'operation_id': 'setup', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'setup', - ], - 'required': [ - 'setup', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'setup': - (Setup,), - }, - 'attribute_map': { - }, - 'location_map': { - 'setup': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - self.setup_comm_prefs_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [], - 'endpoint_path': '/setup_comm_prefs', - 'operation_id': 'setup_comm_prefs', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'comm_prefs_input', - ], - 'required': [ - 'comm_prefs_input', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'comm_prefs_input': - (CommPrefsInput,), - }, - 'attribute_map': { - }, - 'location_map': { - 'comm_prefs_input': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) def get_garbage_collection_config( self, @@ -452,66 +306,6 @@ def get_lake_fs_version( kwargs['_host_index'] = kwargs.get('_host_index') return self.get_lake_fs_version_endpoint.call_with_http_info(**kwargs) - def get_setup_state( - self, - **kwargs - ): - """check if the lakeFS installation is already set up # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.get_setup_state(async_req=True) - >>> result = thread.get() - - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - SetupState - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - return self.get_setup_state_endpoint.call_with_http_info(**kwargs) - def get_storage_config( self, **kwargs @@ -573,133 +367,3 @@ def get_storage_config( kwargs['_host_index'] = kwargs.get('_host_index') return self.get_storage_config_endpoint.call_with_http_info(**kwargs) - def setup( - self, - setup, - **kwargs - ): - """setup lakeFS and create a first user # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.setup(setup, async_req=True) - >>> result = thread.get() - - Args: - setup (Setup): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - CredentialsWithSecret - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['setup'] = \ - setup - return self.setup_endpoint.call_with_http_info(**kwargs) - - def setup_comm_prefs( - self, - comm_prefs_input, - **kwargs - ): - """setup communications preferences # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.setup_comm_prefs(comm_prefs_input, async_req=True) - >>> result = thread.get() - - Args: - comm_prefs_input (CommPrefsInput): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['comm_prefs_input'] = \ - comm_prefs_input - return self.setup_comm_prefs_endpoint.call_with_http_info(**kwargs) - diff --git a/clients/python/lakefs_client/api/internal_api.py b/clients/python/lakefs_client/api/internal_api.py new file mode 100644 index 00000000000..68b1538ae9b --- /dev/null +++ b/clients/python/lakefs_client/api/internal_api.py @@ -0,0 +1,1122 @@ +""" + lakeFS API + + lakeFS HTTP API # noqa: E501 + + The version of the OpenAPI document: 0.1.0 + Contact: services@treeverse.io + Generated by: https://openapi-generator.tech +""" + + +import re # noqa: F401 +import sys # noqa: F401 + +from lakefs_client.api_client import ApiClient, Endpoint as _Endpoint +from lakefs_client.model_utils import ( # noqa: F401 + check_allowed_values, + check_validations, + date, + datetime, + file_type, + none_type, + validate_and_convert_types +) +from lakefs_client.model.auth_capabilities import AuthCapabilities +from lakefs_client.model.comm_prefs_input import CommPrefsInput +from lakefs_client.model.credentials_with_secret import CredentialsWithSecret +from lakefs_client.model.error import Error +from lakefs_client.model.setup import Setup +from lakefs_client.model.setup_state import SetupState +from lakefs_client.model.stats_events_list import StatsEventsList +from lakefs_client.model.update_token import UpdateToken + + +class InternalApi(object): + """NOTE: This class is auto generated by OpenAPI Generator + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + def __init__(self, api_client=None): + if api_client is None: + api_client = ApiClient() + self.api_client = api_client + self.create_branch_protection_rule_preflight_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'basic_auth', + 'cookie_auth', + 'jwt_token', + 'oidc_auth', + 'saml_auth' + ], + 'endpoint_path': '/repositories/{repository}/branch_protection/set_allowed', + 'operation_id': 'create_branch_protection_rule_preflight', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'repository', + ], + 'required': [ + 'repository', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'repository': + (str,), + }, + 'attribute_map': { + 'repository': 'repository', + }, + 'location_map': { + 'repository': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_auth_capabilities_endpoint = _Endpoint( + settings={ + 'response_type': (AuthCapabilities,), + 'auth': [], + 'endpoint_path': '/auth/capabilities', + 'operation_id': 'get_auth_capabilities', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.get_setup_state_endpoint = _Endpoint( + settings={ + 'response_type': (SetupState,), + 'auth': [], + 'endpoint_path': '/setup_lakefs', + 'operation_id': 'get_setup_state', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + ], + 'required': [], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + }, + 'attribute_map': { + }, + 'location_map': { + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.post_stats_events_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'basic_auth', + 'cookie_auth', + 'jwt_token', + 'oidc_auth', + 'saml_auth' + ], + 'endpoint_path': '/statistics', + 'operation_id': 'post_stats_events', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'stats_events_list', + ], + 'required': [ + 'stats_events_list', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'stats_events_list': + (StatsEventsList,), + }, + 'attribute_map': { + }, + 'location_map': { + 'stats_events_list': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.set_garbage_collection_rules_preflight_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'basic_auth', + 'cookie_auth', + 'jwt_token', + 'oidc_auth', + 'saml_auth' + ], + 'endpoint_path': '/repositories/{repository}/gc/rules/set_allowed', + 'operation_id': 'set_garbage_collection_rules_preflight', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'repository', + ], + 'required': [ + 'repository', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'repository': + (str,), + }, + 'attribute_map': { + 'repository': 'repository', + }, + 'location_map': { + 'repository': 'path', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + self.setup_endpoint = _Endpoint( + settings={ + 'response_type': (CredentialsWithSecret,), + 'auth': [], + 'endpoint_path': '/setup_lakefs', + 'operation_id': 'setup', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'setup', + ], + 'required': [ + 'setup', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'setup': + (Setup,), + }, + 'attribute_map': { + }, + 'location_map': { + 'setup': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.setup_comm_prefs_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [], + 'endpoint_path': '/setup_comm_prefs', + 'operation_id': 'setup_comm_prefs', + 'http_method': 'POST', + 'servers': None, + }, + params_map={ + 'all': [ + 'comm_prefs_input', + ], + 'required': [ + 'comm_prefs_input', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'comm_prefs_input': + (CommPrefsInput,), + }, + 'attribute_map': { + }, + 'location_map': { + 'comm_prefs_input': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.update_branch_token_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'basic_auth', + 'cookie_auth', + 'jwt_token', + 'oidc_auth', + 'saml_auth' + ], + 'endpoint_path': '/repositories/{repository}/branches/{branch}/update_token', + 'operation_id': 'update_branch_token', + 'http_method': 'PUT', + 'servers': None, + }, + params_map={ + 'all': [ + 'repository', + 'branch', + 'update_token', + ], + 'required': [ + 'repository', + 'branch', + 'update_token', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'repository': + (str,), + 'branch': + (str,), + 'update_token': + (UpdateToken,), + }, + 'attribute_map': { + 'repository': 'repository', + 'branch': 'branch', + }, + 'location_map': { + 'repository': 'path', + 'branch': 'path', + 'update_token': 'body', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [ + 'application/json' + ] + }, + api_client=api_client + ) + self.upload_object_preflight_endpoint = _Endpoint( + settings={ + 'response_type': None, + 'auth': [ + 'basic_auth', + 'cookie_auth', + 'jwt_token', + 'oidc_auth', + 'saml_auth' + ], + 'endpoint_path': '/repositories/{repository}/branches/{branch}/objects/stage_allowed', + 'operation_id': 'upload_object_preflight', + 'http_method': 'GET', + 'servers': None, + }, + params_map={ + 'all': [ + 'repository', + 'branch', + 'path', + ], + 'required': [ + 'repository', + 'branch', + 'path', + ], + 'nullable': [ + ], + 'enum': [ + ], + 'validation': [ + ] + }, + root_map={ + 'validations': { + }, + 'allowed_values': { + }, + 'openapi_types': { + 'repository': + (str,), + 'branch': + (str,), + 'path': + (str,), + }, + 'attribute_map': { + 'repository': 'repository', + 'branch': 'branch', + 'path': 'path', + }, + 'location_map': { + 'repository': 'path', + 'branch': 'path', + 'path': 'query', + }, + 'collection_format_map': { + } + }, + headers_map={ + 'accept': [ + 'application/json' + ], + 'content_type': [], + }, + api_client=api_client + ) + + def create_branch_protection_rule_preflight( + self, + repository, + **kwargs + ): + """create_branch_protection_rule_preflight # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.create_branch_protection_rule_preflight(repository, async_req=True) + >>> result = thread.get() + + Args: + repository (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['repository'] = \ + repository + return self.create_branch_protection_rule_preflight_endpoint.call_with_http_info(**kwargs) + + def get_auth_capabilities( + self, + **kwargs + ): + """list authentication capabilities supported # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_auth_capabilities(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + AuthCapabilities + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.get_auth_capabilities_endpoint.call_with_http_info(**kwargs) + + def get_setup_state( + self, + **kwargs + ): + """check if the lakeFS installation is already set up # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.get_setup_state(async_req=True) + >>> result = thread.get() + + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + SetupState + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + return self.get_setup_state_endpoint.call_with_http_info(**kwargs) + + def post_stats_events( + self, + stats_events_list, + **kwargs + ): + """post stats events, this endpoint is meant for internal use only # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.post_stats_events(stats_events_list, async_req=True) + >>> result = thread.get() + + Args: + stats_events_list (StatsEventsList): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['stats_events_list'] = \ + stats_events_list + return self.post_stats_events_endpoint.call_with_http_info(**kwargs) + + def set_garbage_collection_rules_preflight( + self, + repository, + **kwargs + ): + """set_garbage_collection_rules_preflight # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.set_garbage_collection_rules_preflight(repository, async_req=True) + >>> result = thread.get() + + Args: + repository (str): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['repository'] = \ + repository + return self.set_garbage_collection_rules_preflight_endpoint.call_with_http_info(**kwargs) + + def setup( + self, + setup, + **kwargs + ): + """setup lakeFS and create a first user # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.setup(setup, async_req=True) + >>> result = thread.get() + + Args: + setup (Setup): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + CredentialsWithSecret + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['setup'] = \ + setup + return self.setup_endpoint.call_with_http_info(**kwargs) + + def setup_comm_prefs( + self, + comm_prefs_input, + **kwargs + ): + """setup communications preferences # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.setup_comm_prefs(comm_prefs_input, async_req=True) + >>> result = thread.get() + + Args: + comm_prefs_input (CommPrefsInput): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['comm_prefs_input'] = \ + comm_prefs_input + return self.setup_comm_prefs_endpoint.call_with_http_info(**kwargs) + + def update_branch_token( + self, + repository, + branch, + update_token, + **kwargs + ): + """modify branch staging token # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.update_branch_token(repository, branch, update_token, async_req=True) + >>> result = thread.get() + + Args: + repository (str): + branch (str): + update_token (UpdateToken): + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['repository'] = \ + repository + kwargs['branch'] = \ + branch + kwargs['update_token'] = \ + update_token + return self.update_branch_token_endpoint.call_with_http_info(**kwargs) + + def upload_object_preflight( + self, + repository, + branch, + path, + **kwargs + ): + """upload_object_preflight # noqa: E501 + + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + + >>> thread = api.upload_object_preflight(repository, branch, path, async_req=True) + >>> result = thread.get() + + Args: + repository (str): + branch (str): + path (str): relative to the branch + + Keyword Args: + _return_http_data_only (bool): response data without head status + code and headers. Default is True. + _preload_content (bool): if False, the urllib3.HTTPResponse object + will be returned without reading/decoding response data. + Default is True. + _request_timeout (int/float/tuple): timeout setting for this request. If + one number provided, it will be total request timeout. It can also + be a pair (tuple) of (connection, read) timeouts. + Default is None. + _check_input_type (bool): specifies if type checking + should be done one the data sent to the server. + Default is True. + _check_return_type (bool): specifies if type checking + should be done one the data received from the server. + Default is True. + _host_index (int/None): specifies the index of the server + that we want to use. + Default is read from the configuration. + async_req (bool): execute request asynchronously + + Returns: + None + If the method is called asynchronously, returns the request + thread. + """ + kwargs['async_req'] = kwargs.get( + 'async_req', False + ) + kwargs['_return_http_data_only'] = kwargs.get( + '_return_http_data_only', True + ) + kwargs['_preload_content'] = kwargs.get( + '_preload_content', True + ) + kwargs['_request_timeout'] = kwargs.get( + '_request_timeout', None + ) + kwargs['_check_input_type'] = kwargs.get( + '_check_input_type', True + ) + kwargs['_check_return_type'] = kwargs.get( + '_check_return_type', True + ) + kwargs['_host_index'] = kwargs.get('_host_index') + kwargs['repository'] = \ + repository + kwargs['branch'] = \ + branch + kwargs['path'] = \ + path + return self.upload_object_preflight_endpoint.call_with_http_info(**kwargs) + diff --git a/clients/python/lakefs_client/api/objects_api.py b/clients/python/lakefs_client/api/objects_api.py index 803dd86d9b0..48c73124c65 100644 --- a/clients/python/lakefs_client/api/objects_api.py +++ b/clients/python/lakefs_client/api/objects_api.py @@ -820,73 +820,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.upload_object_preflight_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'basic_auth', - 'cookie_auth', - 'jwt_token', - 'oidc_auth', - 'saml_auth' - ], - 'endpoint_path': '/repositories/{repository}/branches/{branch}/objects/stage_allowed', - 'operation_id': 'upload_object_preflight', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'repository', - 'branch', - 'path', - ], - 'required': [ - 'repository', - 'branch', - 'path', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'repository': - (str,), - 'branch': - (str,), - 'path': - (str,), - }, - 'attribute_map': { - 'repository': 'repository', - 'branch': 'branch', - 'path': 'path', - }, - 'location_map': { - 'repository': 'path', - 'branch': 'path', - 'path': 'query', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) def copy_object( self, @@ -1636,76 +1569,3 @@ def upload_object( path return self.upload_object_endpoint.call_with_http_info(**kwargs) - def upload_object_preflight( - self, - repository, - branch, - path, - **kwargs - ): - """upload_object_preflight # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.upload_object_preflight(repository, branch, path, async_req=True) - >>> result = thread.get() - - Args: - repository (str): - branch (str): - path (str): relative to the branch - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['repository'] = \ - repository - kwargs['branch'] = \ - branch - kwargs['path'] = \ - path - return self.upload_object_preflight_endpoint.call_with_http_info(**kwargs) - diff --git a/clients/python/lakefs_client/api/repositories_api.py b/clients/python/lakefs_client/api/repositories_api.py index 50a85e440bd..50d1edfc0f6 100644 --- a/clients/python/lakefs_client/api/repositories_api.py +++ b/clients/python/lakefs_client/api/repositories_api.py @@ -104,61 +104,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.create_branch_protection_rule_preflight_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'basic_auth', - 'cookie_auth', - 'jwt_token', - 'oidc_auth', - 'saml_auth' - ], - 'endpoint_path': '/repositories/{repository}/branch_protection/set_allowed', - 'operation_id': 'create_branch_protection_rule_preflight', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'repository', - ], - 'required': [ - 'repository', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'repository': - (str,), - }, - 'attribute_map': { - 'repository': 'repository', - }, - 'location_map': { - 'repository': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) self.create_repository_endpoint = _Endpoint( settings={ 'response_type': (Repository,), @@ -641,71 +586,6 @@ def create_branch_protection_rule( branch_protection_rule return self.create_branch_protection_rule_endpoint.call_with_http_info(**kwargs) - def create_branch_protection_rule_preflight( - self, - repository, - **kwargs - ): - """create_branch_protection_rule_preflight # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.create_branch_protection_rule_preflight(repository, async_req=True) - >>> result = thread.get() - - Args: - repository (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['repository'] = \ - repository - return self.create_branch_protection_rule_preflight_endpoint.call_with_http_info(**kwargs) - def create_repository( self, repository_creation, diff --git a/clients/python/lakefs_client/api/retention_api.py b/clients/python/lakefs_client/api/retention_api.py index d5fd2fc3fed..71015c79c61 100644 --- a/clients/python/lakefs_client/api/retention_api.py +++ b/clients/python/lakefs_client/api/retention_api.py @@ -335,61 +335,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.set_garbage_collection_rules_preflight_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'basic_auth', - 'cookie_auth', - 'jwt_token', - 'oidc_auth', - 'saml_auth' - ], - 'endpoint_path': '/repositories/{repository}/gc/rules/set_allowed', - 'operation_id': 'set_garbage_collection_rules_preflight', - 'http_method': 'GET', - 'servers': None, - }, - params_map={ - 'all': [ - 'repository', - ], - 'required': [ - 'repository', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'repository': - (str,), - }, - 'attribute_map': { - 'repository': 'repository', - }, - 'location_map': { - 'repository': 'path', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [], - }, - api_client=api_client - ) def delete_garbage_collection_rules( self, @@ -722,68 +667,3 @@ def set_garbage_collection_rules( garbage_collection_rules return self.set_garbage_collection_rules_endpoint.call_with_http_info(**kwargs) - def set_garbage_collection_rules_preflight( - self, - repository, - **kwargs - ): - """set_garbage_collection_rules_preflight # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.set_garbage_collection_rules_preflight(repository, async_req=True) - >>> result = thread.get() - - Args: - repository (str): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['repository'] = \ - repository - return self.set_garbage_collection_rules_preflight_endpoint.call_with_http_info(**kwargs) - diff --git a/clients/python/lakefs_client/api/staging_api.py b/clients/python/lakefs_client/api/staging_api.py index 9cb5399d73d..7f2cf181aff 100644 --- a/clients/python/lakefs_client/api/staging_api.py +++ b/clients/python/lakefs_client/api/staging_api.py @@ -26,7 +26,6 @@ from lakefs_client.model.object_stats import ObjectStats from lakefs_client.model.staging_location import StagingLocation from lakefs_client.model.staging_metadata import StagingMetadata -from lakefs_client.model.update_token import UpdateToken class StagingApi(object): @@ -186,74 +185,6 @@ def __init__(self, api_client=None): }, api_client=api_client ) - self.update_branch_token_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'basic_auth', - 'cookie_auth', - 'jwt_token', - 'oidc_auth', - 'saml_auth' - ], - 'endpoint_path': '/repositories/{repository}/branches/{branch}/update_token', - 'operation_id': 'update_branch_token', - 'http_method': 'PUT', - 'servers': None, - }, - params_map={ - 'all': [ - 'repository', - 'branch', - 'update_token', - ], - 'required': [ - 'repository', - 'branch', - 'update_token', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'repository': - (str,), - 'branch': - (str,), - 'update_token': - (UpdateToken,), - }, - 'attribute_map': { - 'repository': 'repository', - 'branch': 'branch', - }, - 'location_map': { - 'repository': 'path', - 'branch': 'path', - 'update_token': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) def get_physical_address( self, @@ -407,76 +338,3 @@ def link_physical_address( staging_metadata return self.link_physical_address_endpoint.call_with_http_info(**kwargs) - def update_branch_token( - self, - repository, - branch, - update_token, - **kwargs - ): - """modify branch staging token # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.update_branch_token(repository, branch, update_token, async_req=True) - >>> result = thread.get() - - Args: - repository (str): - branch (str): - update_token (UpdateToken): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['repository'] = \ - repository - kwargs['branch'] = \ - branch - kwargs['update_token'] = \ - update_token - return self.update_branch_token_endpoint.call_with_http_info(**kwargs) - diff --git a/clients/python/lakefs_client/api/statistics_api.py b/clients/python/lakefs_client/api/statistics_api.py deleted file mode 100644 index 37cf3faf448..00000000000 --- a/clients/python/lakefs_client/api/statistics_api.py +++ /dev/null @@ -1,161 +0,0 @@ -""" - lakeFS API - - lakeFS HTTP API # noqa: E501 - - The version of the OpenAPI document: 0.1.0 - Contact: services@treeverse.io - Generated by: https://openapi-generator.tech -""" - - -import re # noqa: F401 -import sys # noqa: F401 - -from lakefs_client.api_client import ApiClient, Endpoint as _Endpoint -from lakefs_client.model_utils import ( # noqa: F401 - check_allowed_values, - check_validations, - date, - datetime, - file_type, - none_type, - validate_and_convert_types -) -from lakefs_client.model.error import Error -from lakefs_client.model.stats_events_list import StatsEventsList - - -class StatisticsApi(object): - """NOTE: This class is auto generated by OpenAPI Generator - Ref: https://openapi-generator.tech - - Do not edit the class manually. - """ - - def __init__(self, api_client=None): - if api_client is None: - api_client = ApiClient() - self.api_client = api_client - self.post_stats_events_endpoint = _Endpoint( - settings={ - 'response_type': None, - 'auth': [ - 'basic_auth', - 'cookie_auth', - 'jwt_token', - 'oidc_auth', - 'saml_auth' - ], - 'endpoint_path': '/statistics', - 'operation_id': 'post_stats_events', - 'http_method': 'POST', - 'servers': None, - }, - params_map={ - 'all': [ - 'stats_events_list', - ], - 'required': [ - 'stats_events_list', - ], - 'nullable': [ - ], - 'enum': [ - ], - 'validation': [ - ] - }, - root_map={ - 'validations': { - }, - 'allowed_values': { - }, - 'openapi_types': { - 'stats_events_list': - (StatsEventsList,), - }, - 'attribute_map': { - }, - 'location_map': { - 'stats_events_list': 'body', - }, - 'collection_format_map': { - } - }, - headers_map={ - 'accept': [ - 'application/json' - ], - 'content_type': [ - 'application/json' - ] - }, - api_client=api_client - ) - - def post_stats_events( - self, - stats_events_list, - **kwargs - ): - """post stats events, this endpoint is meant for internal use only # noqa: E501 - - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - - >>> thread = api.post_stats_events(stats_events_list, async_req=True) - >>> result = thread.get() - - Args: - stats_events_list (StatsEventsList): - - Keyword Args: - _return_http_data_only (bool): response data without head status - code and headers. Default is True. - _preload_content (bool): if False, the urllib3.HTTPResponse object - will be returned without reading/decoding response data. - Default is True. - _request_timeout (int/float/tuple): timeout setting for this request. If - one number provided, it will be total request timeout. It can also - be a pair (tuple) of (connection, read) timeouts. - Default is None. - _check_input_type (bool): specifies if type checking - should be done one the data sent to the server. - Default is True. - _check_return_type (bool): specifies if type checking - should be done one the data received from the server. - Default is True. - _host_index (int/None): specifies the index of the server - that we want to use. - Default is read from the configuration. - async_req (bool): execute request asynchronously - - Returns: - None - If the method is called asynchronously, returns the request - thread. - """ - kwargs['async_req'] = kwargs.get( - 'async_req', False - ) - kwargs['_return_http_data_only'] = kwargs.get( - '_return_http_data_only', True - ) - kwargs['_preload_content'] = kwargs.get( - '_preload_content', True - ) - kwargs['_request_timeout'] = kwargs.get( - '_request_timeout', None - ) - kwargs['_check_input_type'] = kwargs.get( - '_check_input_type', True - ) - kwargs['_check_return_type'] = kwargs.get( - '_check_return_type', True - ) - kwargs['_host_index'] = kwargs.get('_host_index') - kwargs['stats_events_list'] = \ - stats_events_list - return self.post_stats_events_endpoint.call_with_http_info(**kwargs) - diff --git a/clients/python/lakefs_client/apis/__init__.py b/clients/python/lakefs_client/apis/__init__.py index 5c4ce75cdf5..0d92819de42 100644 --- a/clients/python/lakefs_client/apis/__init__.py +++ b/clients/python/lakefs_client/apis/__init__.py @@ -22,12 +22,12 @@ from lakefs_client.api.experimental_api import ExperimentalApi from lakefs_client.api.health_check_api import HealthCheckApi from lakefs_client.api.import_api import ImportApi +from lakefs_client.api.internal_api import InternalApi from lakefs_client.api.metadata_api import MetadataApi from lakefs_client.api.objects_api import ObjectsApi from lakefs_client.api.refs_api import RefsApi from lakefs_client.api.repositories_api import RepositoriesApi from lakefs_client.api.retention_api import RetentionApi from lakefs_client.api.staging_api import StagingApi -from lakefs_client.api.statistics_api import StatisticsApi from lakefs_client.api.tags_api import TagsApi from lakefs_client.api.templates_api import TemplatesApi diff --git a/clients/python/lakefs_client/client.py b/clients/python/lakefs_client/client.py index 49310a4c73f..1a941ff7e7f 100644 --- a/clients/python/lakefs_client/client.py +++ b/clients/python/lakefs_client/client.py @@ -11,13 +11,13 @@ from lakefs_client.api import experimental_api from lakefs_client.api import health_check_api from lakefs_client.api import import_api +from lakefs_client.api import internal_api from lakefs_client.api import metadata_api from lakefs_client.api import objects_api from lakefs_client.api import refs_api from lakefs_client.api import repositories_api from lakefs_client.api import retention_api from lakefs_client.api import staging_api -from lakefs_client.api import statistics_api from lakefs_client.api import tags_api from lakefs_client.api import templates_api @@ -53,13 +53,13 @@ def __init__(self, configuration=None, header_name=None, header_value=None, cook self.experimental_api = experimental_api.ExperimentalApi(self._api) self.health_check_api = health_check_api.HealthCheckApi(self._api) self.import_api = import_api.ImportApi(self._api) + self.internal_api = internal_api.InternalApi(self._api) self.metadata_api = metadata_api.MetadataApi(self._api) self.objects_api = objects_api.ObjectsApi(self._api) self.refs_api = refs_api.RefsApi(self._api) self.repositories_api = repositories_api.RepositoriesApi(self._api) self.retention_api = retention_api.RetentionApi(self._api) self.staging_api = staging_api.StagingApi(self._api) - self.statistics_api = statistics_api.StatisticsApi(self._api) self.tags_api = tags_api.TagsApi(self._api) self.templates_api = templates_api.TemplatesApi(self._api) diff --git a/clients/python/test/test_auth_api.py b/clients/python/test/test_auth_api.py index f4e0217fe04..364f31b6b0e 100644 --- a/clients/python/test/test_auth_api.py +++ b/clients/python/test/test_auth_api.py @@ -129,13 +129,6 @@ def test_forgot_password(self): """ pass - def test_get_auth_capabilities(self): - """Test case for get_auth_capabilities - - list authentication capabilities supported # noqa: E501 - """ - pass - def test_get_credentials(self): """Test case for get_credentials diff --git a/clients/python/test/test_config_api.py b/clients/python/test/test_config_api.py index 785af74460c..2d7e1c50aac 100644 --- a/clients/python/test/test_config_api.py +++ b/clients/python/test/test_config_api.py @@ -36,33 +36,12 @@ def test_get_lake_fs_version(self): """ pass - def test_get_setup_state(self): - """Test case for get_setup_state - - check if the lakeFS installation is already set up # noqa: E501 - """ - pass - def test_get_storage_config(self): """Test case for get_storage_config """ pass - def test_setup(self): - """Test case for setup - - setup lakeFS and create a first user # noqa: E501 - """ - pass - - def test_setup_comm_prefs(self): - """Test case for setup_comm_prefs - - setup communications preferences # noqa: E501 - """ - pass - if __name__ == '__main__': unittest.main() diff --git a/clients/python/test/test_internal_api.py b/clients/python/test/test_internal_api.py new file mode 100644 index 00000000000..5ccb8f17450 --- /dev/null +++ b/clients/python/test/test_internal_api.py @@ -0,0 +1,89 @@ +""" + lakeFS API + + lakeFS HTTP API # noqa: E501 + + The version of the OpenAPI document: 0.1.0 + Contact: services@treeverse.io + Generated by: https://openapi-generator.tech +""" + + +import unittest + +import lakefs_client +from lakefs_client.api.internal_api import InternalApi # noqa: E501 + + +class TestInternalApi(unittest.TestCase): + """InternalApi unit test stubs""" + + def setUp(self): + self.api = InternalApi() # noqa: E501 + + def tearDown(self): + pass + + def test_create_branch_protection_rule_preflight(self): + """Test case for create_branch_protection_rule_preflight + + """ + pass + + def test_get_auth_capabilities(self): + """Test case for get_auth_capabilities + + list authentication capabilities supported # noqa: E501 + """ + pass + + def test_get_setup_state(self): + """Test case for get_setup_state + + check if the lakeFS installation is already set up # noqa: E501 + """ + pass + + def test_post_stats_events(self): + """Test case for post_stats_events + + post stats events, this endpoint is meant for internal use only # noqa: E501 + """ + pass + + def test_set_garbage_collection_rules_preflight(self): + """Test case for set_garbage_collection_rules_preflight + + """ + pass + + def test_setup(self): + """Test case for setup + + setup lakeFS and create a first user # noqa: E501 + """ + pass + + def test_setup_comm_prefs(self): + """Test case for setup_comm_prefs + + setup communications preferences # noqa: E501 + """ + pass + + def test_update_branch_token(self): + """Test case for update_branch_token + + modify branch staging token # noqa: E501 + """ + pass + + def test_upload_object_preflight(self): + """Test case for upload_object_preflight + + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/clients/python/test/test_objects_api.py b/clients/python/test/test_objects_api.py index d7c4572df7e..5b5bdba88ea 100644 --- a/clients/python/test/test_objects_api.py +++ b/clients/python/test/test_objects_api.py @@ -93,12 +93,6 @@ def test_upload_object(self): """ pass - def test_upload_object_preflight(self): - """Test case for upload_object_preflight - - """ - pass - if __name__ == '__main__': unittest.main() diff --git a/clients/python/test/test_repositories_api.py b/clients/python/test/test_repositories_api.py index c3945710e36..39ee3935b29 100644 --- a/clients/python/test/test_repositories_api.py +++ b/clients/python/test/test_repositories_api.py @@ -30,12 +30,6 @@ def test_create_branch_protection_rule(self): """ pass - def test_create_branch_protection_rule_preflight(self): - """Test case for create_branch_protection_rule_preflight - - """ - pass - def test_create_repository(self): """Test case for create_repository diff --git a/clients/python/test/test_retention_api.py b/clients/python/test/test_retention_api.py index 6749c53a2e1..36c5ed80ba9 100644 --- a/clients/python/test/test_retention_api.py +++ b/clients/python/test/test_retention_api.py @@ -56,12 +56,6 @@ def test_set_garbage_collection_rules(self): """ pass - def test_set_garbage_collection_rules_preflight(self): - """Test case for set_garbage_collection_rules_preflight - - """ - pass - if __name__ == '__main__': unittest.main() diff --git a/clients/python/test/test_staging_api.py b/clients/python/test/test_staging_api.py index 60f03764eed..94fb0c69dd7 100644 --- a/clients/python/test/test_staging_api.py +++ b/clients/python/test/test_staging_api.py @@ -38,13 +38,6 @@ def test_link_physical_address(self): """ pass - def test_update_branch_token(self): - """Test case for update_branch_token - - modify branch staging token # noqa: E501 - """ - pass - if __name__ == '__main__': unittest.main() diff --git a/clients/python/test/test_statistics_api.py b/clients/python/test/test_statistics_api.py deleted file mode 100644 index d77a05ccf61..00000000000 --- a/clients/python/test/test_statistics_api.py +++ /dev/null @@ -1,36 +0,0 @@ -""" - lakeFS API - - lakeFS HTTP API # noqa: E501 - - The version of the OpenAPI document: 0.1.0 - Contact: services@treeverse.io - Generated by: https://openapi-generator.tech -""" - - -import unittest - -import lakefs_client -from lakefs_client.api.statistics_api import StatisticsApi # noqa: E501 - - -class TestStatisticsApi(unittest.TestCase): - """StatisticsApi unit test stubs""" - - def setUp(self): - self.api = StatisticsApi() # noqa: E501 - - def tearDown(self): - pass - - def test_post_stats_events(self): - """Test case for post_stats_events - - post stats events, this endpoint is meant for internal use only # noqa: E501 - """ - pass - - -if __name__ == '__main__': - unittest.main() diff --git a/docs/assets/js/swagger.yml b/docs/assets/js/swagger.yml index 06c5368bef9..0093fa7e250 100644 --- a/docs/assets/js/swagger.yml +++ b/docs/assets/js/swagger.yml @@ -1470,7 +1470,7 @@ paths: /setup_comm_prefs: post: tags: - - config + - internal operationId: setupCommPrefs summary: setup communications preferences security: [] @@ -1501,7 +1501,7 @@ paths: /setup_lakefs: get: tags: - - config + - internal operationId: getSetupState summary: check if the lakeFS installation is already set up security: [] @@ -1516,7 +1516,7 @@ paths: $ref: "#/components/responses/ServerError" post: tags: - - config + - internal operationId: setup summary: setup lakeFS and create a first user security: [] @@ -1633,7 +1633,7 @@ paths: /auth/capabilities: get: tags: - - auth + - internal operationId: getAuthCapabilities summary: list authentication capabilities supported security: [] @@ -3620,7 +3620,7 @@ paths: type: string put: tags: - - staging + - internal operationId: updateBranchToken summary: modify branch staging token requestBody: @@ -3663,7 +3663,7 @@ paths: type: string get: tags: - - objects + - internal operationId: uploadObjectPreflight responses: 204: @@ -4269,7 +4269,7 @@ paths: type: string get: tags: - - retention + - internal operationId: setGarbageCollectionRulesPreflight responses: 204: @@ -4412,7 +4412,7 @@ paths: type: string get: tags: - - repositories + - internal operationId: createBranchProtectionRulePreflight responses: 204: @@ -4593,7 +4593,7 @@ paths: /statistics: post: tags: - - statistics + - internal operationId: postStatsEvents summary: post stats events, this endpoint is meant for internal use only requestBody: