github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/rust/docs/ExperimentalApi.md (about)

     1  # \ExperimentalApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**abort_presign_multipart_upload**](ExperimentalApi.md#abort_presign_multipart_upload) | **DELETE** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Abort a presign multipart upload
     8  [**complete_presign_multipart_upload**](ExperimentalApi.md#complete_presign_multipart_upload) | **PUT** /repositories/{repository}/branches/{branch}/staging/pmpu/{uploadId} | Complete a presign multipart upload request
     9  [**create_presign_multipart_upload**](ExperimentalApi.md#create_presign_multipart_upload) | **POST** /repositories/{repository}/branches/{branch}/staging/pmpu | Initiate a multipart upload
    10  [**create_user_external_principal**](ExperimentalApi.md#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user
    11  [**delete_user_external_principal**](ExperimentalApi.md#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user
    12  [**external_principal_login**](ExperimentalApi.md#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator
    13  [**get_external_principal**](ExperimentalApi.md#get_external_principal) | **GET** /auth/external/principals | describe external principal by id
    14  [**hard_reset_branch**](ExperimentalApi.md#hard_reset_branch) | **PUT** /repositories/{repository}/branches/{branch}/hard_reset | hard reset branch
    15  [**list_user_external_principals**](ExperimentalApi.md#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user
    16  [**sts_login**](ExperimentalApi.md#sts_login) | **POST** /sts/login | perform a login with STS
    17  
    18  
    19  
    20  ## abort_presign_multipart_upload
    21  
    22  > abort_presign_multipart_upload(repository, branch, upload_id, path, abort_presign_multipart_upload)
    23  Abort a presign multipart upload
    24  
    25  Aborts a presign multipart upload.
    26  
    27  ### Parameters
    28  
    29  
    30  Name | Type | Description  | Required | Notes
    31  ------------- | ------------- | ------------- | ------------- | -------------
    32  **repository** | **String** |  | [required] |
    33  **branch** | **String** |  | [required] |
    34  **upload_id** | **String** |  | [required] |
    35  **path** | **String** | relative to the branch | [required] |
    36  **abort_presign_multipart_upload** | Option<[**AbortPresignMultipartUpload**](AbortPresignMultipartUpload.md)> |  |  |
    37  
    38  ### Return type
    39  
    40   (empty response body)
    41  
    42  ### Authorization
    43  
    44  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
    45  
    46  ### HTTP request headers
    47  
    48  - **Content-Type**: application/json
    49  - **Accept**: application/json
    50  
    51  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    52  
    53  
    54  ## complete_presign_multipart_upload
    55  
    56  > models::ObjectStats complete_presign_multipart_upload(repository, branch, upload_id, path, complete_presign_multipart_upload)
    57  Complete a presign multipart upload request
    58  
    59  Completes a presign multipart upload by assembling the uploaded parts.
    60  
    61  ### Parameters
    62  
    63  
    64  Name | Type | Description  | Required | Notes
    65  ------------- | ------------- | ------------- | ------------- | -------------
    66  **repository** | **String** |  | [required] |
    67  **branch** | **String** |  | [required] |
    68  **upload_id** | **String** |  | [required] |
    69  **path** | **String** | relative to the branch | [required] |
    70  **complete_presign_multipart_upload** | Option<[**CompletePresignMultipartUpload**](CompletePresignMultipartUpload.md)> |  |  |
    71  
    72  ### Return type
    73  
    74  [**models::ObjectStats**](ObjectStats.md)
    75  
    76  ### Authorization
    77  
    78  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
    79  
    80  ### HTTP request headers
    81  
    82  - **Content-Type**: application/json
    83  - **Accept**: application/json
    84  
    85  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    86  
    87  
    88  ## create_presign_multipart_upload
    89  
    90  > models::PresignMultipartUpload create_presign_multipart_upload(repository, branch, path, parts)
    91  Initiate a multipart upload
    92  
    93  Initiates a multipart upload and returns an upload ID with presigned URLs for each part (optional). Part numbers starts with 1. Each part except the last one has minimum size depends on the underlying blockstore implementation. For example working with S3 blockstore, minimum size is 5MB (excluding the last part). 
    94  
    95  ### Parameters
    96  
    97  
    98  Name | Type | Description  | Required | Notes
    99  ------------- | ------------- | ------------- | ------------- | -------------
   100  **repository** | **String** |  | [required] |
   101  **branch** | **String** |  | [required] |
   102  **path** | **String** | relative to the branch | [required] |
   103  **parts** | Option<**i32**> | number of presigned URL parts required to upload |  |
   104  
   105  ### Return type
   106  
   107  [**models::PresignMultipartUpload**](PresignMultipartUpload.md)
   108  
   109  ### Authorization
   110  
   111  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   112  
   113  ### HTTP request headers
   114  
   115  - **Content-Type**: Not defined
   116  - **Accept**: application/json
   117  
   118  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   119  
   120  
   121  ## create_user_external_principal
   122  
   123  > create_user_external_principal(user_id, principal_id, external_principal_creation)
   124  attach external principal to user
   125  
   126  ### Parameters
   127  
   128  
   129  Name | Type | Description  | Required | Notes
   130  ------------- | ------------- | ------------- | ------------- | -------------
   131  **user_id** | **String** |  | [required] |
   132  **principal_id** | **String** |  | [required] |
   133  **external_principal_creation** | Option<[**ExternalPrincipalCreation**](ExternalPrincipalCreation.md)> |  |  |
   134  
   135  ### Return type
   136  
   137   (empty response body)
   138  
   139  ### Authorization
   140  
   141  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   142  
   143  ### HTTP request headers
   144  
   145  - **Content-Type**: application/json
   146  - **Accept**: application/json
   147  
   148  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   149  
   150  
   151  ## delete_user_external_principal
   152  
   153  > delete_user_external_principal(user_id, principal_id)
   154  delete external principal from user
   155  
   156  ### Parameters
   157  
   158  
   159  Name | Type | Description  | Required | Notes
   160  ------------- | ------------- | ------------- | ------------- | -------------
   161  **user_id** | **String** |  | [required] |
   162  **principal_id** | **String** |  | [required] |
   163  
   164  ### Return type
   165  
   166   (empty response body)
   167  
   168  ### Authorization
   169  
   170  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   171  
   172  ### HTTP request headers
   173  
   174  - **Content-Type**: Not defined
   175  - **Accept**: application/json
   176  
   177  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   178  
   179  
   180  ## external_principal_login
   181  
   182  > models::AuthenticationToken external_principal_login(external_login_information)
   183  perform a login using an external authenticator
   184  
   185  ### Parameters
   186  
   187  
   188  Name | Type | Description  | Required | Notes
   189  ------------- | ------------- | ------------- | ------------- | -------------
   190  **external_login_information** | Option<[**ExternalLoginInformation**](ExternalLoginInformation.md)> |  |  |
   191  
   192  ### Return type
   193  
   194  [**models::AuthenticationToken**](AuthenticationToken.md)
   195  
   196  ### Authorization
   197  
   198  No authorization required
   199  
   200  ### HTTP request headers
   201  
   202  - **Content-Type**: application/json
   203  - **Accept**: application/json
   204  
   205  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   206  
   207  
   208  ## get_external_principal
   209  
   210  > models::ExternalPrincipal get_external_principal(principal_id)
   211  describe external principal by id
   212  
   213  ### Parameters
   214  
   215  
   216  Name | Type | Description  | Required | Notes
   217  ------------- | ------------- | ------------- | ------------- | -------------
   218  **principal_id** | **String** |  | [required] |
   219  
   220  ### Return type
   221  
   222  [**models::ExternalPrincipal**](ExternalPrincipal.md)
   223  
   224  ### Authorization
   225  
   226  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   227  
   228  ### HTTP request headers
   229  
   230  - **Content-Type**: Not defined
   231  - **Accept**: application/json
   232  
   233  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   234  
   235  
   236  ## hard_reset_branch
   237  
   238  > hard_reset_branch(repository, branch, r#ref, force)
   239  hard reset branch
   240  
   241  Relocate branch to refer to ref.  Branch must not contain uncommitted data.
   242  
   243  ### Parameters
   244  
   245  
   246  Name | Type | Description  | Required | Notes
   247  ------------- | ------------- | ------------- | ------------- | -------------
   248  **repository** | **String** |  | [required] |
   249  **branch** | **String** |  | [required] |
   250  **r#ref** | **String** | After reset, branch will point at this reference. | [required] |
   251  **force** | Option<**bool**> |  |  |[default to false]
   252  
   253  ### Return type
   254  
   255   (empty response body)
   256  
   257  ### Authorization
   258  
   259  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   260  
   261  ### HTTP request headers
   262  
   263  - **Content-Type**: Not defined
   264  - **Accept**: application/json
   265  
   266  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   267  
   268  
   269  ## list_user_external_principals
   270  
   271  > models::ExternalPrincipalList list_user_external_principals(user_id, prefix, after, amount)
   272  list user external policies attached to a user
   273  
   274  ### Parameters
   275  
   276  
   277  Name | Type | Description  | Required | Notes
   278  ------------- | ------------- | ------------- | ------------- | -------------
   279  **user_id** | **String** |  | [required] |
   280  **prefix** | Option<**String**> | return items prefixed with this value |  |
   281  **after** | Option<**String**> | return items after this value |  |
   282  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   283  
   284  ### Return type
   285  
   286  [**models::ExternalPrincipalList**](ExternalPrincipalList.md)
   287  
   288  ### Authorization
   289  
   290  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   291  
   292  ### HTTP request headers
   293  
   294  - **Content-Type**: Not defined
   295  - **Accept**: application/json
   296  
   297  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   298  
   299  
   300  ## sts_login
   301  
   302  > models::AuthenticationToken sts_login(sts_auth_request)
   303  perform a login with STS
   304  
   305  ### Parameters
   306  
   307  
   308  Name | Type | Description  | Required | Notes
   309  ------------- | ------------- | ------------- | ------------- | -------------
   310  **sts_auth_request** | [**StsAuthRequest**](StsAuthRequest.md) |  | [required] |
   311  
   312  ### Return type
   313  
   314  [**models::AuthenticationToken**](AuthenticationToken.md)
   315  
   316  ### Authorization
   317  
   318  No authorization required
   319  
   320  ### HTTP request headers
   321  
   322  - **Content-Type**: application/json
   323  - **Accept**: application/json
   324  
   325  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   326