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

     1  # \RepositoriesApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**create_repository**](RepositoriesApi.md#create_repository) | **POST** /repositories | create repository
     8  [**delete_gc_rules**](RepositoriesApi.md#delete_gc_rules) | **DELETE** /repositories/{repository}/settings/gc_rules | 
     9  [**delete_repository**](RepositoriesApi.md#delete_repository) | **DELETE** /repositories/{repository} | delete repository
    10  [**dump_status**](RepositoriesApi.md#dump_status) | **GET** /repositories/{repository}/dump | Status of a repository dump task
    11  [**dump_submit**](RepositoriesApi.md#dump_submit) | **POST** /repositories/{repository}/dump | Backup the repository metadata (tags, commits, branches) and save the backup to the object store.
    12  [**get_branch_protection_rules**](RepositoriesApi.md#get_branch_protection_rules) | **GET** /repositories/{repository}/settings/branch_protection | get branch protection rules
    13  [**get_gc_rules**](RepositoriesApi.md#get_gc_rules) | **GET** /repositories/{repository}/settings/gc_rules | get repository GC rules
    14  [**get_repository**](RepositoriesApi.md#get_repository) | **GET** /repositories/{repository} | get repository
    15  [**get_repository_metadata**](RepositoriesApi.md#get_repository_metadata) | **GET** /repositories/{repository}/metadata | get repository metadata
    16  [**list_repositories**](RepositoriesApi.md#list_repositories) | **GET** /repositories | list repositories
    17  [**restore_status**](RepositoriesApi.md#restore_status) | **GET** /repositories/{repository}/restore | Status of a restore request
    18  [**restore_submit**](RepositoriesApi.md#restore_submit) | **POST** /repositories/{repository}/restore | Restore repository from a dump in the object store
    19  [**set_branch_protection_rules**](RepositoriesApi.md#set_branch_protection_rules) | **PUT** /repositories/{repository}/settings/branch_protection | 
    20  [**set_gc_rules**](RepositoriesApi.md#set_gc_rules) | **PUT** /repositories/{repository}/settings/gc_rules | 
    21  
    22  
    23  
    24  ## create_repository
    25  
    26  > models::Repository create_repository(repository_creation, bare)
    27  create repository
    28  
    29  ### Parameters
    30  
    31  
    32  Name | Type | Description  | Required | Notes
    33  ------------- | ------------- | ------------- | ------------- | -------------
    34  **repository_creation** | [**RepositoryCreation**](RepositoryCreation.md) |  | [required] |
    35  **bare** | Option<**bool**> | If true, create a bare repository with no initial commit and branch |  |[default to false]
    36  
    37  ### Return type
    38  
    39  [**models::Repository**](Repository.md)
    40  
    41  ### Authorization
    42  
    43  [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)
    44  
    45  ### HTTP request headers
    46  
    47  - **Content-Type**: application/json
    48  - **Accept**: application/json
    49  
    50  [[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)
    51  
    52  
    53  ## delete_gc_rules
    54  
    55  > delete_gc_rules(repository)
    56  
    57  
    58  ### Parameters
    59  
    60  
    61  Name | Type | Description  | Required | Notes
    62  ------------- | ------------- | ------------- | ------------- | -------------
    63  **repository** | **String** |  | [required] |
    64  
    65  ### Return type
    66  
    67   (empty response body)
    68  
    69  ### Authorization
    70  
    71  [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)
    72  
    73  ### HTTP request headers
    74  
    75  - **Content-Type**: Not defined
    76  - **Accept**: application/json
    77  
    78  [[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)
    79  
    80  
    81  ## delete_repository
    82  
    83  > delete_repository(repository, force)
    84  delete repository
    85  
    86  ### Parameters
    87  
    88  
    89  Name | Type | Description  | Required | Notes
    90  ------------- | ------------- | ------------- | ------------- | -------------
    91  **repository** | **String** |  | [required] |
    92  **force** | Option<**bool**> | Bypass read-only protection and delete the repository |  |[default to false]
    93  
    94  ### Return type
    95  
    96   (empty response body)
    97  
    98  ### Authorization
    99  
   100  [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)
   101  
   102  ### HTTP request headers
   103  
   104  - **Content-Type**: Not defined
   105  - **Accept**: application/json
   106  
   107  [[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)
   108  
   109  
   110  ## dump_status
   111  
   112  > models::RepositoryDumpStatus dump_status(repository, task_id)
   113  Status of a repository dump task
   114  
   115  ### Parameters
   116  
   117  
   118  Name | Type | Description  | Required | Notes
   119  ------------- | ------------- | ------------- | ------------- | -------------
   120  **repository** | **String** |  | [required] |
   121  **task_id** | **String** |  | [required] |
   122  
   123  ### Return type
   124  
   125  [**models::RepositoryDumpStatus**](RepositoryDumpStatus.md)
   126  
   127  ### Authorization
   128  
   129  [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)
   130  
   131  ### HTTP request headers
   132  
   133  - **Content-Type**: Not defined
   134  - **Accept**: application/json
   135  
   136  [[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)
   137  
   138  
   139  ## dump_submit
   140  
   141  > models::TaskInfo dump_submit(repository)
   142  Backup the repository metadata (tags, commits, branches) and save the backup to the object store.
   143  
   144  ### Parameters
   145  
   146  
   147  Name | Type | Description  | Required | Notes
   148  ------------- | ------------- | ------------- | ------------- | -------------
   149  **repository** | **String** |  | [required] |
   150  
   151  ### Return type
   152  
   153  [**models::TaskInfo**](TaskInfo.md)
   154  
   155  ### Authorization
   156  
   157  [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)
   158  
   159  ### HTTP request headers
   160  
   161  - **Content-Type**: Not defined
   162  - **Accept**: application/json
   163  
   164  [[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)
   165  
   166  
   167  ## get_branch_protection_rules
   168  
   169  > Vec<models::BranchProtectionRule> get_branch_protection_rules(repository)
   170  get branch protection rules
   171  
   172  ### Parameters
   173  
   174  
   175  Name | Type | Description  | Required | Notes
   176  ------------- | ------------- | ------------- | ------------- | -------------
   177  **repository** | **String** |  | [required] |
   178  
   179  ### Return type
   180  
   181  [**Vec<models::BranchProtectionRule>**](BranchProtectionRule.md)
   182  
   183  ### Authorization
   184  
   185  [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)
   186  
   187  ### HTTP request headers
   188  
   189  - **Content-Type**: Not defined
   190  - **Accept**: application/json
   191  
   192  [[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)
   193  
   194  
   195  ## get_gc_rules
   196  
   197  > models::GarbageCollectionRules get_gc_rules(repository)
   198  get repository GC rules
   199  
   200  ### Parameters
   201  
   202  
   203  Name | Type | Description  | Required | Notes
   204  ------------- | ------------- | ------------- | ------------- | -------------
   205  **repository** | **String** |  | [required] |
   206  
   207  ### Return type
   208  
   209  [**models::GarbageCollectionRules**](GarbageCollectionRules.md)
   210  
   211  ### Authorization
   212  
   213  [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)
   214  
   215  ### HTTP request headers
   216  
   217  - **Content-Type**: Not defined
   218  - **Accept**: application/json
   219  
   220  [[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)
   221  
   222  
   223  ## get_repository
   224  
   225  > models::Repository get_repository(repository)
   226  get repository
   227  
   228  ### Parameters
   229  
   230  
   231  Name | Type | Description  | Required | Notes
   232  ------------- | ------------- | ------------- | ------------- | -------------
   233  **repository** | **String** |  | [required] |
   234  
   235  ### Return type
   236  
   237  [**models::Repository**](Repository.md)
   238  
   239  ### Authorization
   240  
   241  [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)
   242  
   243  ### HTTP request headers
   244  
   245  - **Content-Type**: Not defined
   246  - **Accept**: application/json
   247  
   248  [[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)
   249  
   250  
   251  ## get_repository_metadata
   252  
   253  > std::collections::HashMap<String, String> get_repository_metadata(repository)
   254  get repository metadata
   255  
   256  ### Parameters
   257  
   258  
   259  Name | Type | Description  | Required | Notes
   260  ------------- | ------------- | ------------- | ------------- | -------------
   261  **repository** | **String** |  | [required] |
   262  
   263  ### Return type
   264  
   265  **std::collections::HashMap<String, String>**
   266  
   267  ### Authorization
   268  
   269  [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)
   270  
   271  ### HTTP request headers
   272  
   273  - **Content-Type**: Not defined
   274  - **Accept**: application/json
   275  
   276  [[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)
   277  
   278  
   279  ## list_repositories
   280  
   281  > models::RepositoryList list_repositories(prefix, after, amount)
   282  list repositories
   283  
   284  ### Parameters
   285  
   286  
   287  Name | Type | Description  | Required | Notes
   288  ------------- | ------------- | ------------- | ------------- | -------------
   289  **prefix** | Option<**String**> | return items prefixed with this value |  |
   290  **after** | Option<**String**> | return items after this value |  |
   291  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   292  
   293  ### Return type
   294  
   295  [**models::RepositoryList**](RepositoryList.md)
   296  
   297  ### Authorization
   298  
   299  [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)
   300  
   301  ### HTTP request headers
   302  
   303  - **Content-Type**: Not defined
   304  - **Accept**: application/json
   305  
   306  [[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)
   307  
   308  
   309  ## restore_status
   310  
   311  > models::RepositoryRestoreStatus restore_status(repository, task_id)
   312  Status of a restore request
   313  
   314  ### Parameters
   315  
   316  
   317  Name | Type | Description  | Required | Notes
   318  ------------- | ------------- | ------------- | ------------- | -------------
   319  **repository** | **String** |  | [required] |
   320  **task_id** | **String** |  | [required] |
   321  
   322  ### Return type
   323  
   324  [**models::RepositoryRestoreStatus**](RepositoryRestoreStatus.md)
   325  
   326  ### Authorization
   327  
   328  [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)
   329  
   330  ### HTTP request headers
   331  
   332  - **Content-Type**: Not defined
   333  - **Accept**: application/json
   334  
   335  [[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)
   336  
   337  
   338  ## restore_submit
   339  
   340  > models::TaskInfo restore_submit(repository, refs_restore)
   341  Restore repository from a dump in the object store
   342  
   343  ### Parameters
   344  
   345  
   346  Name | Type | Description  | Required | Notes
   347  ------------- | ------------- | ------------- | ------------- | -------------
   348  **repository** | **String** |  | [required] |
   349  **refs_restore** | [**RefsRestore**](RefsRestore.md) |  | [required] |
   350  
   351  ### Return type
   352  
   353  [**models::TaskInfo**](TaskInfo.md)
   354  
   355  ### Authorization
   356  
   357  [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)
   358  
   359  ### HTTP request headers
   360  
   361  - **Content-Type**: application/json
   362  - **Accept**: application/json
   363  
   364  [[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)
   365  
   366  
   367  ## set_branch_protection_rules
   368  
   369  > set_branch_protection_rules(repository, branch_protection_rule, if_match)
   370  
   371  
   372  ### Parameters
   373  
   374  
   375  Name | Type | Description  | Required | Notes
   376  ------------- | ------------- | ------------- | ------------- | -------------
   377  **repository** | **String** |  | [required] |
   378  **branch_protection_rule** | [**Vec<models::BranchProtectionRule>**](BranchProtectionRule.md) |  | [required] |
   379  **if_match** | Option<**String**> | if provided, the branch protection rules will be updated only if the current ETag match the provided value |  |
   380  
   381  ### Return type
   382  
   383   (empty response body)
   384  
   385  ### Authorization
   386  
   387  [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)
   388  
   389  ### HTTP request headers
   390  
   391  - **Content-Type**: application/json
   392  - **Accept**: application/json
   393  
   394  [[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)
   395  
   396  
   397  ## set_gc_rules
   398  
   399  > set_gc_rules(repository, garbage_collection_rules)
   400  
   401  
   402  ### Parameters
   403  
   404  
   405  Name | Type | Description  | Required | Notes
   406  ------------- | ------------- | ------------- | ------------- | -------------
   407  **repository** | **String** |  | [required] |
   408  **garbage_collection_rules** | [**GarbageCollectionRules**](GarbageCollectionRules.md) |  | [required] |
   409  
   410  ### Return type
   411  
   412   (empty response body)
   413  
   414  ### Authorization
   415  
   416  [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)
   417  
   418  ### HTTP request headers
   419  
   420  - **Content-Type**: application/json
   421  - **Accept**: application/json
   422  
   423  [[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)
   424