From e8c8f4aadf06626ed5cf3bde265e67a08c121cf7 Mon Sep 17 00:00:00 2001 From: Barak Amar Date: Thu, 2 Nov 2023 09:19:02 +0200 Subject: [PATCH] docs: fix pydocs-sdk generated docs (#6920) * docs: fix pydocs-sdk generated docs * Update python sdk FILES --- Makefile | 2 +- clients/python/docs/ACL.md | 1 + clients/python/docs/AccessKeyCredentials.md | 1 + clients/python/docs/ActionRun.md | 1 + clients/python/docs/ActionRunList.md | 1 + clients/python/docs/ActionsApi.md | 12 +++ clients/python/docs/AuthApi.md | 93 +++++++++++++++++++ clients/python/docs/AuthCapabilities.md | 1 + clients/python/docs/AuthenticationToken.md | 1 + clients/python/docs/BranchCreation.md | 1 + clients/python/docs/BranchProtectionRule.md | 1 + clients/python/docs/BranchesApi.md | 24 +++++ clients/python/docs/CherryPickCreation.md | 1 + clients/python/docs/CommPrefsInput.md | 1 + clients/python/docs/Commit.md | 1 + clients/python/docs/CommitCreation.md | 1 + clients/python/docs/CommitList.md | 1 + clients/python/docs/CommitsApi.md | 6 ++ clients/python/docs/Config.md | 1 + clients/python/docs/ConfigApi.md | 3 + clients/python/docs/Credentials.md | 1 + clients/python/docs/CredentialsList.md | 1 + clients/python/docs/CredentialsWithSecret.md | 1 + clients/python/docs/CurrentUser.md | 1 + clients/python/docs/Diff.md | 1 + clients/python/docs/DiffList.md | 1 + clients/python/docs/DiffProperties.md | 1 + clients/python/docs/Error.md | 1 + clients/python/docs/ErrorNoACL.md | 1 + clients/python/docs/ExperimentalApi.md | 6 ++ clients/python/docs/FindMergeBaseResult.md | 1 + .../python/docs/GarbageCollectionConfig.md | 1 + .../docs/GarbageCollectionPrepareResponse.md | 1 + clients/python/docs/GarbageCollectionRule.md | 1 + clients/python/docs/GarbageCollectionRules.md | 1 + clients/python/docs/Group.md | 1 + clients/python/docs/GroupCreation.md | 1 + clients/python/docs/GroupList.md | 1 + clients/python/docs/HealthCheckApi.md | 3 + clients/python/docs/HookRun.md | 1 + clients/python/docs/HookRunList.md | 1 + clients/python/docs/ImportApi.md | 9 ++ clients/python/docs/ImportCreation.md | 1 + clients/python/docs/ImportCreationResponse.md | 1 + clients/python/docs/ImportLocation.md | 1 + clients/python/docs/ImportStatus.md | 1 + clients/python/docs/InternalApi.md | 69 ++++++++++++++ ...ternalDeleteBranchProtectionRuleRequest.md | 1 + clients/python/docs/LoginConfig.md | 1 + clients/python/docs/LoginInformation.md | 1 + clients/python/docs/Merge.md | 1 + clients/python/docs/MergeResult.md | 1 + clients/python/docs/MetaRangeCreation.md | 1 + .../python/docs/MetaRangeCreationResponse.md | 1 + clients/python/docs/MetadataApi.md | 6 ++ clients/python/docs/OTFDiffs.md | 1 + clients/python/docs/ObjectCopyCreation.md | 1 + clients/python/docs/ObjectError.md | 1 + clients/python/docs/ObjectErrorList.md | 1 + clients/python/docs/ObjectStageCreation.md | 1 + clients/python/docs/ObjectStats.md | 1 + clients/python/docs/ObjectStatsList.md | 1 + clients/python/docs/ObjectsApi.md | 27 ++++++ clients/python/docs/OtfDiffEntry.md | 1 + clients/python/docs/OtfDiffList.md | 1 + clients/python/docs/Pagination.md | 1 + clients/python/docs/PathList.md | 1 + clients/python/docs/Policy.md | 1 + clients/python/docs/PolicyList.md | 1 + .../docs/PrepareGCUncommittedRequest.md | 1 + .../docs/PrepareGCUncommittedResponse.md | 1 + clients/python/docs/RangeMetadata.md | 1 + clients/python/docs/Ref.md | 1 + clients/python/docs/RefList.md | 1 + clients/python/docs/RefsApi.md | 12 +++ clients/python/docs/RefsDump.md | 1 + clients/python/docs/RepositoriesApi.md | 30 ++++++ clients/python/docs/Repository.md | 1 + clients/python/docs/RepositoryCreation.md | 1 + clients/python/docs/RepositoryList.md | 1 + clients/python/docs/ResetCreation.md | 1 + clients/python/docs/RevertCreation.md | 1 + clients/python/docs/Setup.md | 1 + clients/python/docs/SetupState.md | 1 + clients/python/docs/StagingApi.md | 6 ++ clients/python/docs/StagingLocation.md | 1 + clients/python/docs/StagingMetadata.md | 1 + clients/python/docs/Statement.md | 1 + clients/python/docs/StatsEvent.md | 1 + clients/python/docs/StatsEventsList.md | 1 + clients/python/docs/StorageConfig.md | 1 + clients/python/docs/StorageURI.md | 1 + clients/python/docs/TagCreation.md | 1 + clients/python/docs/TagsApi.md | 12 +++ .../python/docs/UnderlyingObjectProperties.md | 1 + clients/python/docs/UpdateToken.md | 1 + clients/python/docs/User.md | 1 + clients/python/docs/UserCreation.md | 1 + clients/python/docs/UserList.md | 1 + clients/python/docs/VersionConfig.md | 1 + 100 files changed, 403 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 4e0c2fb4b73..244a3b7cd37 100644 --- a/Makefile +++ b/Makefile @@ -10,7 +10,7 @@ CLIENT_JARS_BUCKET="s3://treeverse-clients-us-east/" # https://openapi-generator.tech OPENAPI_LEGACY_GENERATOR_IMAGE=openapitools/openapi-generator-cli:v5.3.0 OPENAPI_LEGACY_GENERATOR=$(DOCKER) run --user $(UID_GID) --rm -v $(shell pwd):/mnt $(OPENAPI_LEGACY_GENERATOR_IMAGE) -OPENAPI_GENERATOR_IMAGE=openapitools/openapi-generator-cli:v7.0.0 +OPENAPI_GENERATOR_IMAGE=treeverse/openapi-generator-cli:v7.0.0.1 OPENAPI_GENERATOR=$(DOCKER) run --user $(UID_GID) --rm -v $(shell pwd):/mnt $(OPENAPI_GENERATOR_IMAGE) GOLANGCI_LINT_VERSION=v1.53.3 diff --git a/clients/python/docs/ACL.md b/clients/python/docs/ACL.md index 35ea61bf908..1671ce8c8d6 100644 --- a/clients/python/docs/ACL.md +++ b/clients/python/docs/ACL.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **permission** | **str** | Permission level to give this ACL. \"Read\", \"Write\", \"Super\" and \"Admin\" are all supported. | diff --git a/clients/python/docs/AccessKeyCredentials.md b/clients/python/docs/AccessKeyCredentials.md index 733a586bdcf..94564e9397d 100644 --- a/clients/python/docs/AccessKeyCredentials.md +++ b/clients/python/docs/AccessKeyCredentials.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **access_key_id** | **str** | access key ID to set for user for use in integration testing. | diff --git a/clients/python/docs/ActionRun.md b/clients/python/docs/ActionRun.md index 4f41466b492..d7cee7f5397 100644 --- a/clients/python/docs/ActionRun.md +++ b/clients/python/docs/ActionRun.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **run_id** | **str** | | diff --git a/clients/python/docs/ActionRunList.md b/clients/python/docs/ActionRunList.md index b158a3bb984..af87f91cd45 100644 --- a/clients/python/docs/ActionRunList.md +++ b/clients/python/docs/ActionRunList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/ActionsApi.md b/clients/python/docs/ActionsApi.md index fb55d05cf82..a35752995f8 100644 --- a/clients/python/docs/ActionsApi.md +++ b/clients/python/docs/ActionsApi.md @@ -22,6 +22,7 @@ get a run * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -90,6 +91,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -109,6 +111,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | action run result | - | @@ -131,6 +134,7 @@ get run hook output * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -199,6 +203,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -219,6 +224,7 @@ Name | Type | Description | Notes - **Accept**: application/octet-stream, application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | run hook output | - | @@ -241,6 +247,7 @@ list runs * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -312,6 +319,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -334,6 +342,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | list action runs | - | @@ -356,6 +365,7 @@ list run hooks * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -426,6 +436,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -447,6 +458,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | list specific run hooks | - | diff --git a/clients/python/docs/AuthApi.md b/clients/python/docs/AuthApi.md index a40c5edad79..5af07c004da 100644 --- a/clients/python/docs/AuthApi.md +++ b/clients/python/docs/AuthApi.md @@ -49,6 +49,7 @@ add group membership * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -114,6 +115,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -133,6 +135,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | membership added successfully | - | @@ -155,6 +158,7 @@ attach policy to group * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -220,6 +224,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -239,6 +244,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | policy attached successfully | - | @@ -261,6 +267,7 @@ attach policy to user * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -326,6 +333,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -345,6 +353,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | policy attached successfully | - | @@ -367,6 +376,7 @@ create credentials * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -434,6 +444,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -452,6 +463,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | credentials | - | @@ -474,6 +486,7 @@ create group * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -542,6 +555,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_creation** | [**GroupCreation**](GroupCreation.md)| | [optional] @@ -560,6 +574,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | group | - | @@ -582,6 +597,7 @@ create policy * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -649,6 +665,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **policy** | [**Policy**](Policy.md)| | @@ -667,6 +684,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | policy | - | @@ -690,6 +708,7 @@ create user * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -758,6 +777,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_creation** | [**UserCreation**](UserCreation.md)| | [optional] @@ -776,6 +796,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | user | - | @@ -799,6 +820,7 @@ delete credentials * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -864,6 +886,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -883,6 +906,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | credentials deleted successfully | - | @@ -905,6 +929,7 @@ delete group * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -969,6 +994,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -987,6 +1013,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | group deleted successfully | - | @@ -1009,6 +1036,7 @@ delete group membership * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1074,6 +1102,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -1093,6 +1122,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | membership deleted successfully | - | @@ -1115,6 +1145,7 @@ delete policy * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1179,6 +1210,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **policy_id** | **str**| | @@ -1197,6 +1229,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | policy deleted successfully | - | @@ -1219,6 +1252,7 @@ delete user * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1283,6 +1317,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -1301,6 +1336,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | user deleted successfully | - | @@ -1323,6 +1359,7 @@ detach policy from group * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1388,6 +1425,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -1407,6 +1445,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | policy detached successfully | - | @@ -1429,6 +1468,7 @@ detach policy from user * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1494,6 +1534,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -1513,6 +1554,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | policy detached successfully | - | @@ -1535,6 +1577,7 @@ get credentials * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1603,6 +1646,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -1622,6 +1666,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | credentials | - | @@ -1644,6 +1689,7 @@ get current user * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1709,6 +1755,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -1725,6 +1772,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | user | - | @@ -1743,6 +1791,7 @@ get group * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1810,6 +1859,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -1828,6 +1878,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | group | - | @@ -1850,6 +1901,7 @@ get ACL of group * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1917,6 +1969,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -1935,6 +1988,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | ACL of group | - | @@ -1957,6 +2011,7 @@ get policy * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2024,6 +2079,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **policy_id** | **str**| | @@ -2042,6 +2098,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | policy | - | @@ -2064,6 +2121,7 @@ get user * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2131,6 +2189,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -2149,6 +2208,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | user | - | @@ -2171,6 +2231,7 @@ list group members * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2241,6 +2302,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -2262,6 +2324,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | group member list | - | @@ -2283,6 +2346,7 @@ list group policies * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2353,6 +2417,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -2374,6 +2439,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | policy list | - | @@ -2396,6 +2462,7 @@ list groups * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2465,6 +2532,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **prefix** | **str**| return items prefixed with this value | [optional] @@ -2485,6 +2553,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | group list | - | @@ -2506,6 +2575,7 @@ list policies * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2575,6 +2645,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **prefix** | **str**| return items prefixed with this value | [optional] @@ -2595,6 +2666,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | policy list | - | @@ -2616,6 +2688,7 @@ list user credentials * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2686,6 +2759,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -2707,6 +2781,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | credential list | - | @@ -2729,6 +2804,7 @@ list user groups * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2799,6 +2875,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -2820,6 +2897,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | group list | - | @@ -2842,6 +2920,7 @@ list user policies * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2913,6 +2992,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user_id** | **str**| | @@ -2935,6 +3015,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | policy list | - | @@ -2957,6 +3038,7 @@ list users * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -3026,6 +3108,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **prefix** | **str**| return items prefixed with this value | [optional] @@ -3046,6 +3129,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | user list | - | @@ -3062,6 +3146,7 @@ perform a login ### Example + ```python import time import os @@ -3097,6 +3182,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **login_information** | [**LoginInformation**](LoginInformation.md)| | [optional] @@ -3115,6 +3201,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | successful login | * Set-Cookie -
| @@ -3136,6 +3223,7 @@ set ACL of group * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -3202,6 +3290,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **group_id** | **str**| | @@ -3221,6 +3310,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | ACL successfully changed | - | @@ -3243,6 +3333,7 @@ update policy * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -3311,6 +3402,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **policy_id** | **str**| | @@ -3330,6 +3422,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | policy | - | diff --git a/clients/python/docs/AuthCapabilities.md b/clients/python/docs/AuthCapabilities.md index b39268e543e..83891c271e3 100644 --- a/clients/python/docs/AuthCapabilities.md +++ b/clients/python/docs/AuthCapabilities.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **invite_user** | **bool** | | [optional] diff --git a/clients/python/docs/AuthenticationToken.md b/clients/python/docs/AuthenticationToken.md index 65a46f6a66d..4cf4feb8869 100644 --- a/clients/python/docs/AuthenticationToken.md +++ b/clients/python/docs/AuthenticationToken.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **token** | **str** | a JWT token that could be used to authenticate requests | diff --git a/clients/python/docs/BranchCreation.md b/clients/python/docs/BranchCreation.md index 4adf76072c9..c8a732a2c3c 100644 --- a/clients/python/docs/BranchCreation.md +++ b/clients/python/docs/BranchCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | | diff --git a/clients/python/docs/BranchProtectionRule.md b/clients/python/docs/BranchProtectionRule.md index e48d28370e8..b3bcf60667c 100644 --- a/clients/python/docs/BranchProtectionRule.md +++ b/clients/python/docs/BranchProtectionRule.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pattern** | **str** | fnmatch pattern for the branch name, supporting * and ? wildcards | diff --git a/clients/python/docs/BranchesApi.md b/clients/python/docs/BranchesApi.md index d23581256a9..bbb8a7dcde2 100644 --- a/clients/python/docs/BranchesApi.md +++ b/clients/python/docs/BranchesApi.md @@ -26,6 +26,7 @@ Replay the changes from the given commit on the branch * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -96,6 +97,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -116,6 +118,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | the cherry-pick commit | - | @@ -140,6 +143,7 @@ create branch * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -208,6 +212,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -227,6 +232,7 @@ Name | Type | Description | Notes - **Accept**: text/html, application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | reference | - | @@ -251,6 +257,7 @@ delete branch * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -316,6 +323,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -335,6 +343,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | branch deleted successfully | - | @@ -358,6 +367,7 @@ diff branch * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -430,6 +440,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -453,6 +464,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | diff of branch uncommitted changes | - | @@ -475,6 +487,7 @@ get branch * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -543,6 +556,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -562,6 +576,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | branch | - | @@ -584,6 +599,7 @@ list branches * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -654,6 +670,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -675,6 +692,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | branch list | - | @@ -697,6 +715,7 @@ reset branch * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -764,6 +783,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -784,6 +804,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | reset successful | - | @@ -806,6 +827,7 @@ revert * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -873,6 +895,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -893,6 +916,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | revert successful | - | diff --git a/clients/python/docs/CherryPickCreation.md b/clients/python/docs/CherryPickCreation.md index 62090df3024..7d9526affb4 100644 --- a/clients/python/docs/CherryPickCreation.md +++ b/clients/python/docs/CherryPickCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ref** | **str** | the commit to cherry-pick, given by a ref | diff --git a/clients/python/docs/CommPrefsInput.md b/clients/python/docs/CommPrefsInput.md index 4453614a5fa..d38c30b04e2 100644 --- a/clients/python/docs/CommPrefsInput.md +++ b/clients/python/docs/CommPrefsInput.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **str** | the provided email | [optional] diff --git a/clients/python/docs/Commit.md b/clients/python/docs/Commit.md index e50f0db8fc0..0840314dd4b 100644 --- a/clients/python/docs/Commit.md +++ b/clients/python/docs/Commit.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/CommitCreation.md b/clients/python/docs/CommitCreation.md index ae89ef41752..96f848ae7e1 100644 --- a/clients/python/docs/CommitCreation.md +++ b/clients/python/docs/CommitCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | | diff --git a/clients/python/docs/CommitList.md b/clients/python/docs/CommitList.md index 4cdfcd21454..65f04ad2b9a 100644 --- a/clients/python/docs/CommitList.md +++ b/clients/python/docs/CommitList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/CommitsApi.md b/clients/python/docs/CommitsApi.md index 3711300c778..36ece53fe8b 100644 --- a/clients/python/docs/CommitsApi.md +++ b/clients/python/docs/CommitsApi.md @@ -20,6 +20,7 @@ create commit * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -91,6 +92,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -112,6 +114,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | commit | - | @@ -137,6 +140,7 @@ get commit * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -205,6 +209,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -224,6 +229,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | commit | - | diff --git a/clients/python/docs/Config.md b/clients/python/docs/Config.md index 4ff9945af58..a082349a18b 100644 --- a/clients/python/docs/Config.md +++ b/clients/python/docs/Config.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **version_config** | [**VersionConfig**](VersionConfig.md) | | [optional] diff --git a/clients/python/docs/ConfigApi.md b/clients/python/docs/ConfigApi.md index 34517403e64..bb153b51290 100644 --- a/clients/python/docs/ConfigApi.md +++ b/clients/python/docs/ConfigApi.md @@ -21,6 +21,7 @@ retrieve lakeFS configuration * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -85,6 +86,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -101,6 +103,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | lakeFS configuration | - | diff --git a/clients/python/docs/Credentials.md b/clients/python/docs/Credentials.md index 8cab845bd7e..28c7dde97ae 100644 --- a/clients/python/docs/Credentials.md +++ b/clients/python/docs/Credentials.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **access_key_id** | **str** | | diff --git a/clients/python/docs/CredentialsList.md b/clients/python/docs/CredentialsList.md index 50abb3b1efd..f0b8eb7e035 100644 --- a/clients/python/docs/CredentialsList.md +++ b/clients/python/docs/CredentialsList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/CredentialsWithSecret.md b/clients/python/docs/CredentialsWithSecret.md index f438c250b2a..045757b7993 100644 --- a/clients/python/docs/CredentialsWithSecret.md +++ b/clients/python/docs/CredentialsWithSecret.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **access_key_id** | **str** | | diff --git a/clients/python/docs/CurrentUser.md b/clients/python/docs/CurrentUser.md index 6e01d540a4c..b64cd254335 100644 --- a/clients/python/docs/CurrentUser.md +++ b/clients/python/docs/CurrentUser.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **user** | [**User**](User.md) | | diff --git a/clients/python/docs/Diff.md b/clients/python/docs/Diff.md index 6559e7d1150..17ac92c081c 100644 --- a/clients/python/docs/Diff.md +++ b/clients/python/docs/Diff.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | | diff --git a/clients/python/docs/DiffList.md b/clients/python/docs/DiffList.md index d48e128b84c..a7856117662 100644 --- a/clients/python/docs/DiffList.md +++ b/clients/python/docs/DiffList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/DiffProperties.md b/clients/python/docs/DiffProperties.md index 494643129a8..38965b3d0c0 100644 --- a/clients/python/docs/DiffProperties.md +++ b/clients/python/docs/DiffProperties.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | | diff --git a/clients/python/docs/Error.md b/clients/python/docs/Error.md index 240a6251e78..b0e5ae57a7b 100644 --- a/clients/python/docs/Error.md +++ b/clients/python/docs/Error.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | short message explaining the error | diff --git a/clients/python/docs/ErrorNoACL.md b/clients/python/docs/ErrorNoACL.md index 4f9101e987e..98afa2642db 100644 --- a/clients/python/docs/ErrorNoACL.md +++ b/clients/python/docs/ErrorNoACL.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | short message explaining the error | diff --git a/clients/python/docs/ExperimentalApi.md b/clients/python/docs/ExperimentalApi.md index 29d35a8491d..a639221226a 100644 --- a/clients/python/docs/ExperimentalApi.md +++ b/clients/python/docs/ExperimentalApi.md @@ -20,6 +20,7 @@ get the available Open Table Format diffs * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -85,6 +86,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -101,6 +103,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | available Open Table Format diffs | - | @@ -122,6 +125,7 @@ perform otf diff * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -193,6 +197,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -215,6 +220,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | diff list | - | diff --git a/clients/python/docs/FindMergeBaseResult.md b/clients/python/docs/FindMergeBaseResult.md index 908fc823516..ce1a9121188 100644 --- a/clients/python/docs/FindMergeBaseResult.md +++ b/clients/python/docs/FindMergeBaseResult.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **source_commit_id** | **str** | The commit ID of the merge source | diff --git a/clients/python/docs/GarbageCollectionConfig.md b/clients/python/docs/GarbageCollectionConfig.md index 34f82d36f3b..1288be12d20 100644 --- a/clients/python/docs/GarbageCollectionConfig.md +++ b/clients/python/docs/GarbageCollectionConfig.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **grace_period** | **int** | Duration in seconds. Objects created in the recent grace_period will not be collected. | [optional] diff --git a/clients/python/docs/GarbageCollectionPrepareResponse.md b/clients/python/docs/GarbageCollectionPrepareResponse.md index 0c85fa35620..bd3d767589a 100644 --- a/clients/python/docs/GarbageCollectionPrepareResponse.md +++ b/clients/python/docs/GarbageCollectionPrepareResponse.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **run_id** | **str** | a unique identifier generated for this GC job | diff --git a/clients/python/docs/GarbageCollectionRule.md b/clients/python/docs/GarbageCollectionRule.md index 1c597686662..12aaf92c0b5 100644 --- a/clients/python/docs/GarbageCollectionRule.md +++ b/clients/python/docs/GarbageCollectionRule.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **branch_id** | **str** | | diff --git a/clients/python/docs/GarbageCollectionRules.md b/clients/python/docs/GarbageCollectionRules.md index 5ea800c8647..694ae30daa9 100644 --- a/clients/python/docs/GarbageCollectionRules.md +++ b/clients/python/docs/GarbageCollectionRules.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **default_retention_days** | **int** | | diff --git a/clients/python/docs/Group.md b/clients/python/docs/Group.md index d9ad2689304..1f9d6a0916d 100644 --- a/clients/python/docs/Group.md +++ b/clients/python/docs/Group.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/GroupCreation.md b/clients/python/docs/GroupCreation.md index 0326e502cf3..c2afe03feec 100644 --- a/clients/python/docs/GroupCreation.md +++ b/clients/python/docs/GroupCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/GroupList.md b/clients/python/docs/GroupList.md index 9f1c9f5bd70..577c4580785 100644 --- a/clients/python/docs/GroupList.md +++ b/clients/python/docs/GroupList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/HealthCheckApi.md b/clients/python/docs/HealthCheckApi.md index a162d337f1c..3c3572d0817 100644 --- a/clients/python/docs/HealthCheckApi.md +++ b/clients/python/docs/HealthCheckApi.md @@ -16,6 +16,7 @@ check that the API server is up and running ### Example + ```python import time import os @@ -44,6 +45,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -60,6 +62,7 @@ No authorization required - **Accept**: Not defined ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | NoContent | - | diff --git a/clients/python/docs/HookRun.md b/clients/python/docs/HookRun.md index 88201ca8c68..90f6392bba3 100644 --- a/clients/python/docs/HookRun.md +++ b/clients/python/docs/HookRun.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **hook_run_id** | **str** | | diff --git a/clients/python/docs/HookRunList.md b/clients/python/docs/HookRunList.md index 05e90a7a601..741a0e3d1e6 100644 --- a/clients/python/docs/HookRunList.md +++ b/clients/python/docs/HookRunList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/ImportApi.md b/clients/python/docs/ImportApi.md index d65aec3c31b..6ff5da12ece 100644 --- a/clients/python/docs/ImportApi.md +++ b/clients/python/docs/ImportApi.md @@ -21,6 +21,7 @@ cancel ongoing import * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -87,6 +88,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -107,6 +109,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | import canceled successfully | - | @@ -131,6 +134,7 @@ import data from object store * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -201,6 +205,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -221,6 +226,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **202** | Import started | - | @@ -244,6 +250,7 @@ get import status * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -313,6 +320,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -333,6 +341,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | import status | - | diff --git a/clients/python/docs/ImportCreation.md b/clients/python/docs/ImportCreation.md index 815670ef36e..e1edc385417 100644 --- a/clients/python/docs/ImportCreation.md +++ b/clients/python/docs/ImportCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paths** | [**List[ImportLocation]**](ImportLocation.md) | | diff --git a/clients/python/docs/ImportCreationResponse.md b/clients/python/docs/ImportCreationResponse.md index a070ff90792..d1992ad35d5 100644 --- a/clients/python/docs/ImportCreationResponse.md +++ b/clients/python/docs/ImportCreationResponse.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | The id of the import process | diff --git a/clients/python/docs/ImportLocation.md b/clients/python/docs/ImportLocation.md index 281bf1b1b53..2b3787e4b43 100644 --- a/clients/python/docs/ImportLocation.md +++ b/clients/python/docs/ImportLocation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | Path type, can either be 'common_prefix' or 'object' | diff --git a/clients/python/docs/ImportStatus.md b/clients/python/docs/ImportStatus.md index 3d1945665da..850ddb45046 100644 --- a/clients/python/docs/ImportStatus.md +++ b/clients/python/docs/ImportStatus.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **completed** | **bool** | | diff --git a/clients/python/docs/InternalApi.md b/clients/python/docs/InternalApi.md index cbbf414474c..c42eebd032a 100644 --- a/clients/python/docs/InternalApi.md +++ b/clients/python/docs/InternalApi.md @@ -41,6 +41,7 @@ Method | HTTP request | Description * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -104,6 +105,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -122,6 +124,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | User has permissions to create a branch protection rule in this repository | - | @@ -145,6 +148,7 @@ creates symlink files corresponding to the given directory * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -214,6 +218,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -234,6 +239,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | location created | - | @@ -256,6 +262,7 @@ Dump repository refs (tags, commits, branches) to object store Deprecated: a new * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -323,6 +330,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -341,6 +349,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | refs dump | - | @@ -359,6 +368,7 @@ list authentication capabilities supported ### Example + ```python import time import os @@ -391,6 +401,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -407,6 +418,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | auth capabilities | - | @@ -429,6 +441,7 @@ get information of gc settings * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -493,6 +506,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -509,6 +523,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | lakeFS garbage collection config | - | @@ -530,6 +545,7 @@ get version of lakeFS server * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -594,6 +610,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -610,6 +627,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | lakeFS version | - | @@ -624,6 +642,7 @@ check if the lakeFS installation is already set up ### Example + ```python import time import os @@ -656,6 +675,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -672,6 +692,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | lakeFS setup state | - | @@ -694,6 +715,7 @@ retrieve lakeFS storage configuration * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -758,6 +780,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + This endpoint does not need any parameter. ### Return type @@ -774,6 +797,7 @@ This endpoint does not need any parameter. - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | lakeFS storage configuration | - | @@ -793,6 +817,7 @@ This endpoint does not need any parameter. * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -858,6 +883,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -877,6 +903,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | branch protection rule created successfully | - | @@ -899,6 +926,7 @@ void (empty response body) * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -964,6 +992,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -983,6 +1012,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | branch protection rule deleted successfully | - | @@ -1005,6 +1035,7 @@ void (empty response body) * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1068,6 +1099,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1086,6 +1118,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | deleted garbage collection rules successfully | - | @@ -1108,6 +1141,7 @@ get branch protection rules * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1175,6 +1209,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1193,6 +1228,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | branch protection rules | - | @@ -1215,6 +1251,7 @@ Name | Type | Description | Notes * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1281,6 +1318,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1299,6 +1337,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | gc rule list | - | @@ -1321,6 +1360,7 @@ Name | Type | Description | Notes * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1386,6 +1426,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1405,6 +1446,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | set garbage collection rules successfully | - | @@ -1427,6 +1469,7 @@ post stats events, this endpoint is meant for internal use only * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1492,6 +1535,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **stats_events_list** | [**StatsEventsList**](StatsEventsList.md)| | @@ -1510,6 +1554,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | reported successfully | - | @@ -1532,6 +1577,7 @@ save lists of active commits for garbage collection * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1599,6 +1645,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1617,6 +1664,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | paths to commit dataset | - | @@ -1639,6 +1687,7 @@ save repository uncommitted metadata for garbage collection * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1708,6 +1757,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1727,6 +1777,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | paths to commit dataset | - | @@ -1750,6 +1801,7 @@ Restore repository refs (tags, commits, branches) from object store. Deprecated: * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1816,6 +1868,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1835,6 +1888,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | refs successfully loaded | - | @@ -1858,6 +1912,7 @@ void (empty response body) * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1921,6 +1976,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1939,6 +1995,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | User has permissions to set garbage collection rules on this repository | - | @@ -1956,6 +2013,7 @@ setup lakeFS and create a first user ### Example + ```python import time import os @@ -1991,6 +2049,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **setup** | [**Setup**](Setup.md)| | @@ -2009,6 +2068,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | user created successfully | - | @@ -2026,6 +2086,7 @@ setup communications preferences ### Example + ```python import time import os @@ -2058,6 +2119,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **comm_prefs_input** | [**CommPrefsInput**](CommPrefsInput.md)| | @@ -2076,6 +2138,7 @@ No authorization required - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | communication preferences saved successfully | - | @@ -2098,6 +2161,7 @@ stage an object's metadata for the given branch * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2169,6 +2233,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -2190,6 +2255,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | object metadata | - | @@ -2214,6 +2280,7 @@ Name | Type | Description | Notes * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -2279,6 +2346,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -2299,6 +2367,7 @@ void (empty response body) - **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 | - | diff --git a/clients/python/docs/InternalDeleteBranchProtectionRuleRequest.md b/clients/python/docs/InternalDeleteBranchProtectionRuleRequest.md index 056de73155b..1c072c0adcf 100644 --- a/clients/python/docs/InternalDeleteBranchProtectionRuleRequest.md +++ b/clients/python/docs/InternalDeleteBranchProtectionRuleRequest.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pattern** | **str** | | diff --git a/clients/python/docs/LoginConfig.md b/clients/python/docs/LoginConfig.md index 34500af13af..c154bfd3a7e 100644 --- a/clients/python/docs/LoginConfig.md +++ b/clients/python/docs/LoginConfig.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **rbac** | **str** | RBAC will remain enabled on GUI if \"external\". That only works with an external auth service. | [optional] diff --git a/clients/python/docs/LoginInformation.md b/clients/python/docs/LoginInformation.md index a02b75ee588..8f200b49659 100644 --- a/clients/python/docs/LoginInformation.md +++ b/clients/python/docs/LoginInformation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **access_key_id** | **str** | | diff --git a/clients/python/docs/Merge.md b/clients/python/docs/Merge.md index 4be16ac4d8a..40c09c0000b 100644 --- a/clients/python/docs/Merge.md +++ b/clients/python/docs/Merge.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **message** | **str** | | [optional] diff --git a/clients/python/docs/MergeResult.md b/clients/python/docs/MergeResult.md index 5982fcd07d2..4babd96d5b8 100644 --- a/clients/python/docs/MergeResult.md +++ b/clients/python/docs/MergeResult.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reference** | **str** | | diff --git a/clients/python/docs/MetaRangeCreation.md b/clients/python/docs/MetaRangeCreation.md index ee8c0d8b685..c04cf212f59 100644 --- a/clients/python/docs/MetaRangeCreation.md +++ b/clients/python/docs/MetaRangeCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ranges** | [**List[RangeMetadata]**](RangeMetadata.md) | | diff --git a/clients/python/docs/MetaRangeCreationResponse.md b/clients/python/docs/MetaRangeCreationResponse.md index 2c37abeaff8..827a69e6807 100644 --- a/clients/python/docs/MetaRangeCreationResponse.md +++ b/clients/python/docs/MetaRangeCreationResponse.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | The id of the created metarange | [optional] diff --git a/clients/python/docs/MetadataApi.md b/clients/python/docs/MetadataApi.md index a8e1a865c59..248e02e2629 100644 --- a/clients/python/docs/MetadataApi.md +++ b/clients/python/docs/MetadataApi.md @@ -20,6 +20,7 @@ return URI to a meta-range file * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -88,6 +89,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -107,6 +109,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | meta-range URI | * Location - redirect to S3
| @@ -129,6 +132,7 @@ return URI to a range file * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -197,6 +201,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -216,6 +221,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | range URI | * Location - redirect to S3
| diff --git a/clients/python/docs/OTFDiffs.md b/clients/python/docs/OTFDiffs.md index cf06ca902b5..1b822fce67c 100644 --- a/clients/python/docs/OTFDiffs.md +++ b/clients/python/docs/OTFDiffs.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **diffs** | [**List[DiffProperties]**](DiffProperties.md) | | [optional] diff --git a/clients/python/docs/ObjectCopyCreation.md b/clients/python/docs/ObjectCopyCreation.md index 1b97152c629..565c95d2ec2 100644 --- a/clients/python/docs/ObjectCopyCreation.md +++ b/clients/python/docs/ObjectCopyCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **src_path** | **str** | path of the copied object relative to the ref | diff --git a/clients/python/docs/ObjectError.md b/clients/python/docs/ObjectError.md index e1846f7997a..06ded331214 100644 --- a/clients/python/docs/ObjectError.md +++ b/clients/python/docs/ObjectError.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **status_code** | **int** | HTTP status code associated for operation on path | diff --git a/clients/python/docs/ObjectErrorList.md b/clients/python/docs/ObjectErrorList.md index a8f2ffb4f5e..44d827f29f2 100644 --- a/clients/python/docs/ObjectErrorList.md +++ b/clients/python/docs/ObjectErrorList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**List[ObjectError]**](ObjectError.md) | | diff --git a/clients/python/docs/ObjectStageCreation.md b/clients/python/docs/ObjectStageCreation.md index 7385dc7e27a..565636bbbed 100644 --- a/clients/python/docs/ObjectStageCreation.md +++ b/clients/python/docs/ObjectStageCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **physical_address** | **str** | | diff --git a/clients/python/docs/ObjectStats.md b/clients/python/docs/ObjectStats.md index 5172a6e9770..fd2a7bfd003 100644 --- a/clients/python/docs/ObjectStats.md +++ b/clients/python/docs/ObjectStats.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **path** | **str** | | diff --git a/clients/python/docs/ObjectStatsList.md b/clients/python/docs/ObjectStatsList.md index 49c229f25f0..90676d2c7c0 100644 --- a/clients/python/docs/ObjectStatsList.md +++ b/clients/python/docs/ObjectStatsList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/ObjectsApi.md b/clients/python/docs/ObjectsApi.md index 6daa61be692..0d1bb33d80e 100644 --- a/clients/python/docs/ObjectsApi.md +++ b/clients/python/docs/ObjectsApi.md @@ -27,6 +27,7 @@ create a copy of an object * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -98,6 +99,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -119,6 +121,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | Copy object response | - | @@ -142,6 +145,7 @@ delete object. Missing objects will not return a NotFound error. * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -208,6 +212,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -228,6 +233,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | object deleted successfully | - | @@ -251,6 +257,7 @@ delete objects. Missing objects will not return a NotFound error. * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -321,6 +328,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -341,6 +349,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Delete objects response | - | @@ -364,6 +373,7 @@ get object content * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -434,6 +444,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -456,6 +467,7 @@ Name | Type | Description | Notes - **Accept**: application/octet-stream, application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | object content | * Content-Length -
* Last-Modified -
* ETag -
| @@ -482,6 +494,7 @@ get object properties on underlying storage * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -551,6 +564,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -571,6 +585,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | object metadata on underlying storage | - | @@ -593,6 +608,7 @@ check if object exists * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -660,6 +676,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -681,6 +698,7 @@ void (empty response body) - **Accept**: Not defined ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | object exists | * Content-Length -
* Last-Modified -
* ETag -
| @@ -706,6 +724,7 @@ list objects under a given prefix * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -780,6 +799,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -805,6 +825,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | object listing | - | @@ -827,6 +848,7 @@ get object metadata * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -898,6 +920,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -920,6 +943,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | object metadata | - | @@ -944,6 +968,7 @@ Name | Type | Description | Notes * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1015,6 +1040,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1038,6 +1064,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | object metadata | - | diff --git a/clients/python/docs/OtfDiffEntry.md b/clients/python/docs/OtfDiffEntry.md index 60067310610..30cbc16150b 100644 --- a/clients/python/docs/OtfDiffEntry.md +++ b/clients/python/docs/OtfDiffEntry.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/OtfDiffList.md b/clients/python/docs/OtfDiffList.md index 5d831c67476..0f31814778e 100644 --- a/clients/python/docs/OtfDiffList.md +++ b/clients/python/docs/OtfDiffList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **diff_type** | **str** | | [optional] diff --git a/clients/python/docs/Pagination.md b/clients/python/docs/Pagination.md index f73fe41e03b..bcdfafd1323 100644 --- a/clients/python/docs/Pagination.md +++ b/clients/python/docs/Pagination.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **has_more** | **bool** | Next page is available | diff --git a/clients/python/docs/PathList.md b/clients/python/docs/PathList.md index eddbd5d6fdb..8761b8cc08e 100644 --- a/clients/python/docs/PathList.md +++ b/clients/python/docs/PathList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paths** | **List[str]** | | diff --git a/clients/python/docs/Policy.md b/clients/python/docs/Policy.md index fdeaa39166c..a3882e4193c 100644 --- a/clients/python/docs/Policy.md +++ b/clients/python/docs/Policy.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/PolicyList.md b/clients/python/docs/PolicyList.md index 5d73765ecf6..a0c74f71b47 100644 --- a/clients/python/docs/PolicyList.md +++ b/clients/python/docs/PolicyList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/PrepareGCUncommittedRequest.md b/clients/python/docs/PrepareGCUncommittedRequest.md index ea4e756469a..486b76b2a43 100644 --- a/clients/python/docs/PrepareGCUncommittedRequest.md +++ b/clients/python/docs/PrepareGCUncommittedRequest.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **continuation_token** | **str** | | [optional] diff --git a/clients/python/docs/PrepareGCUncommittedResponse.md b/clients/python/docs/PrepareGCUncommittedResponse.md index ff4c047945b..f8085c2d8b4 100644 --- a/clients/python/docs/PrepareGCUncommittedResponse.md +++ b/clients/python/docs/PrepareGCUncommittedResponse.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **run_id** | **str** | | diff --git a/clients/python/docs/RangeMetadata.md b/clients/python/docs/RangeMetadata.md index c16a24ae720..f4180d9581c 100644 --- a/clients/python/docs/RangeMetadata.md +++ b/clients/python/docs/RangeMetadata.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | ID of the range. | diff --git a/clients/python/docs/Ref.md b/clients/python/docs/Ref.md index 424af82f96a..7cb1124d5d9 100644 --- a/clients/python/docs/Ref.md +++ b/clients/python/docs/Ref.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/RefList.md b/clients/python/docs/RefList.md index 3be2ed4d881..71a0e4a33c0 100644 --- a/clients/python/docs/RefList.md +++ b/clients/python/docs/RefList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/RefsApi.md b/clients/python/docs/RefsApi.md index 0808443df7d..0fbdacaeb4f 100644 --- a/clients/python/docs/RefsApi.md +++ b/clients/python/docs/RefsApi.md @@ -22,6 +22,7 @@ diff references * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -96,6 +97,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -121,6 +123,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | diff between refs | - | @@ -143,6 +146,7 @@ find the merge base for 2 references * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -212,6 +216,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -232,6 +237,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | Found the merge base | - | @@ -255,6 +261,7 @@ get commit log from ref. If both objects and prefixes are empty, return all comm * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -330,6 +337,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -356,6 +364,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | commit log | - | @@ -378,6 +387,7 @@ merge references * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -449,6 +459,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -470,6 +481,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | merge completed | - | diff --git a/clients/python/docs/RefsDump.md b/clients/python/docs/RefsDump.md index ff182133780..b23cae4fc63 100644 --- a/clients/python/docs/RefsDump.md +++ b/clients/python/docs/RefsDump.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **commits_meta_range_id** | **str** | | diff --git a/clients/python/docs/RepositoriesApi.md b/clients/python/docs/RepositoriesApi.md index 2cf761398d2..f57dea02b3f 100644 --- a/clients/python/docs/RepositoriesApi.md +++ b/clients/python/docs/RepositoriesApi.md @@ -28,6 +28,7 @@ create repository * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -97,6 +98,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository_creation** | [**RepositoryCreation**](RepositoryCreation.md)| | @@ -116,6 +118,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | repository | - | @@ -139,6 +142,7 @@ Name | Type | Description | Notes * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -202,6 +206,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -220,6 +225,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | deleted garbage collection rules successfully | - | @@ -242,6 +248,7 @@ delete repository * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -306,6 +313,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -324,6 +332,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | repository deleted successfully | - | @@ -346,6 +355,7 @@ get branch protection rules * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -413,6 +423,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -431,6 +442,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | branch protection rules | * ETag -
| @@ -453,6 +465,7 @@ get repository GC rules * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -520,6 +533,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -538,6 +552,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | repository GC rules | - | @@ -560,6 +575,7 @@ get repository * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -627,6 +643,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -645,6 +662,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | repository | - | @@ -667,6 +685,7 @@ get repository metadata * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -733,6 +752,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -751,6 +771,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | repository metadata | - | @@ -773,6 +794,7 @@ list repositories * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -842,6 +864,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **prefix** | **str**| return items prefixed with this value | [optional] @@ -862,6 +885,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | repository list | - | @@ -883,6 +907,7 @@ Name | Type | Description | Notes * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -949,6 +974,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -969,6 +995,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | branch protection rule created successfully | - | @@ -993,6 +1020,7 @@ void (empty response body) * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -1058,6 +1086,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -1077,6 +1106,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | set garbage collection rules successfully | - | diff --git a/clients/python/docs/Repository.md b/clients/python/docs/Repository.md index 41435b5c8d7..24148c0c556 100644 --- a/clients/python/docs/Repository.md +++ b/clients/python/docs/Repository.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/RepositoryCreation.md b/clients/python/docs/RepositoryCreation.md index d0de898939a..1de39af6d72 100644 --- a/clients/python/docs/RepositoryCreation.md +++ b/clients/python/docs/RepositoryCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **str** | | diff --git a/clients/python/docs/RepositoryList.md b/clients/python/docs/RepositoryList.md index 4e03fb3b21c..78b6a87ff16 100644 --- a/clients/python/docs/RepositoryList.md +++ b/clients/python/docs/RepositoryList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/ResetCreation.md b/clients/python/docs/ResetCreation.md index d19d3e8715c..d6d0ea05f50 100644 --- a/clients/python/docs/ResetCreation.md +++ b/clients/python/docs/ResetCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **str** | | diff --git a/clients/python/docs/RevertCreation.md b/clients/python/docs/RevertCreation.md index 364dbdc9a33..20c2a51d372 100644 --- a/clients/python/docs/RevertCreation.md +++ b/clients/python/docs/RevertCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ref** | **str** | the commit to revert, given by a ref | diff --git a/clients/python/docs/Setup.md b/clients/python/docs/Setup.md index 5db761262a7..0b273adcbd6 100644 --- a/clients/python/docs/Setup.md +++ b/clients/python/docs/Setup.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **username** | **str** | an identifier for the user (e.g. jane.doe) | diff --git a/clients/python/docs/SetupState.md b/clients/python/docs/SetupState.md index 58c0340bafc..fa5af29684a 100644 --- a/clients/python/docs/SetupState.md +++ b/clients/python/docs/SetupState.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **state** | **str** | | [optional] diff --git a/clients/python/docs/StagingApi.md b/clients/python/docs/StagingApi.md index eae96deea49..2b00a41b9c8 100644 --- a/clients/python/docs/StagingApi.md +++ b/clients/python/docs/StagingApi.md @@ -20,6 +20,7 @@ generate an address to which the client can upload an object * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -90,6 +91,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -111,6 +113,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | physical address for staging area | - | @@ -135,6 +138,7 @@ Link the physical address with the path in lakeFS, creating an uncommitted chang * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -206,6 +210,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -227,6 +232,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | object metadata | - | diff --git a/clients/python/docs/StagingLocation.md b/clients/python/docs/StagingLocation.md index 87ccdd0215a..d66e421f8e4 100644 --- a/clients/python/docs/StagingLocation.md +++ b/clients/python/docs/StagingLocation.md @@ -3,6 +3,7 @@ location for placing an object when staging it ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **physical_address** | **str** | | [optional] diff --git a/clients/python/docs/StagingMetadata.md b/clients/python/docs/StagingMetadata.md index 48003d01e06..ac281b20d89 100644 --- a/clients/python/docs/StagingMetadata.md +++ b/clients/python/docs/StagingMetadata.md @@ -3,6 +3,7 @@ information about uploaded object ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **staging** | [**StagingLocation**](StagingLocation.md) | | diff --git a/clients/python/docs/Statement.md b/clients/python/docs/Statement.md index 9586541c5a8..f83bb6514cb 100644 --- a/clients/python/docs/Statement.md +++ b/clients/python/docs/Statement.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **effect** | **str** | | diff --git a/clients/python/docs/StatsEvent.md b/clients/python/docs/StatsEvent.md index e6762f7af5b..7422705dd2e 100644 --- a/clients/python/docs/StatsEvent.md +++ b/clients/python/docs/StatsEvent.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **var_class** | **str** | stats event class (e.g. \"s3_gateway\", \"openapi_request\", \"experimental-feature\", \"ui-event\") | diff --git a/clients/python/docs/StatsEventsList.md b/clients/python/docs/StatsEventsList.md index c0f2bdf6d88..9f28b81b735 100644 --- a/clients/python/docs/StatsEventsList.md +++ b/clients/python/docs/StatsEventsList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **events** | [**List[StatsEvent]**](StatsEvent.md) | | diff --git a/clients/python/docs/StorageConfig.md b/clients/python/docs/StorageConfig.md index 52ac2618a25..e523b2f9307 100644 --- a/clients/python/docs/StorageConfig.md +++ b/clients/python/docs/StorageConfig.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **blockstore_type** | **str** | | diff --git a/clients/python/docs/StorageURI.md b/clients/python/docs/StorageURI.md index 4449c390177..70cfde9f372 100644 --- a/clients/python/docs/StorageURI.md +++ b/clients/python/docs/StorageURI.md @@ -3,6 +3,7 @@ URI to a path in a storage provider (e.g. \"s3://bucket1/path/to/object\") ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **location** | **str** | | diff --git a/clients/python/docs/TagCreation.md b/clients/python/docs/TagCreation.md index b06d274735d..e684ed04ead 100644 --- a/clients/python/docs/TagCreation.md +++ b/clients/python/docs/TagCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | | diff --git a/clients/python/docs/TagsApi.md b/clients/python/docs/TagsApi.md index f0736b261c3..3bf4b1c5083 100644 --- a/clients/python/docs/TagsApi.md +++ b/clients/python/docs/TagsApi.md @@ -22,6 +22,7 @@ create tag * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -91,6 +92,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -110,6 +112,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **201** | tag | - | @@ -134,6 +137,7 @@ delete tag * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -199,6 +203,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -218,6 +223,7 @@ void (empty response body) - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **204** | tag deleted successfully | - | @@ -240,6 +246,7 @@ get tag * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -308,6 +315,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -327,6 +335,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | tag | - | @@ -349,6 +358,7 @@ list tags * Api Key Authentication (oidc_auth): * Api Key Authentication (saml_auth): * Bearer (JWT) Authentication (jwt_token): + ```python import time import os @@ -419,6 +429,7 @@ with lakefs_sdk.ApiClient(configuration) as api_client: ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **repository** | **str**| | @@ -440,6 +451,7 @@ Name | Type | Description | Notes - **Accept**: application/json ### HTTP response details + | Status code | Description | Response headers | |-------------|-------------|------------------| **200** | tag list | - | diff --git a/clients/python/docs/UnderlyingObjectProperties.md b/clients/python/docs/UnderlyingObjectProperties.md index 859922fb155..ec3a6a48362 100644 --- a/clients/python/docs/UnderlyingObjectProperties.md +++ b/clients/python/docs/UnderlyingObjectProperties.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **storage_class** | **str** | | [optional] diff --git a/clients/python/docs/UpdateToken.md b/clients/python/docs/UpdateToken.md index 288bf9eceb1..022402064fa 100644 --- a/clients/python/docs/UpdateToken.md +++ b/clients/python/docs/UpdateToken.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **staging_token** | **str** | | diff --git a/clients/python/docs/User.md b/clients/python/docs/User.md index dc056c73663..11d24b47323 100644 --- a/clients/python/docs/User.md +++ b/clients/python/docs/User.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | A unique identifier for the user. Cannot be edited. | diff --git a/clients/python/docs/UserCreation.md b/clients/python/docs/UserCreation.md index 9d3273d63d7..f9bf5979017 100644 --- a/clients/python/docs/UserCreation.md +++ b/clients/python/docs/UserCreation.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **str** | a unique identifier for the user. | diff --git a/clients/python/docs/UserList.md b/clients/python/docs/UserList.md index 216b54dba27..7a68e6bc74c 100644 --- a/clients/python/docs/UserList.md +++ b/clients/python/docs/UserList.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagination** | [**Pagination**](Pagination.md) | | diff --git a/clients/python/docs/VersionConfig.md b/clients/python/docs/VersionConfig.md index 6e7f345af44..1bcfbc96c6d 100644 --- a/clients/python/docs/VersionConfig.md +++ b/clients/python/docs/VersionConfig.md @@ -2,6 +2,7 @@ ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **version** | **str** | | [optional]