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

     1  # \BranchesApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**cherry_pick**](BranchesApi.md#cherry_pick) | **POST** /repositories/{repository}/branches/{branch}/cherry-pick | Replay the changes from the given commit on the branch
     8  [**create_branch**](BranchesApi.md#create_branch) | **POST** /repositories/{repository}/branches | create branch
     9  [**delete_branch**](BranchesApi.md#delete_branch) | **DELETE** /repositories/{repository}/branches/{branch} | delete branch
    10  [**diff_branch**](BranchesApi.md#diff_branch) | **GET** /repositories/{repository}/branches/{branch}/diff | diff branch
    11  [**get_branch**](BranchesApi.md#get_branch) | **GET** /repositories/{repository}/branches/{branch} | get branch
    12  [**list_branches**](BranchesApi.md#list_branches) | **GET** /repositories/{repository}/branches | list branches
    13  [**reset_branch**](BranchesApi.md#reset_branch) | **PUT** /repositories/{repository}/branches/{branch} | reset branch
    14  [**revert_branch**](BranchesApi.md#revert_branch) | **POST** /repositories/{repository}/branches/{branch}/revert | revert
    15  
    16  
    17  
    18  ## cherry_pick
    19  
    20  > models::Commit cherry_pick(repository, branch, cherry_pick_creation)
    21  Replay the changes from the given commit on the branch
    22  
    23  ### Parameters
    24  
    25  
    26  Name | Type | Description  | Required | Notes
    27  ------------- | ------------- | ------------- | ------------- | -------------
    28  **repository** | **String** |  | [required] |
    29  **branch** | **String** |  | [required] |
    30  **cherry_pick_creation** | [**CherryPickCreation**](CherryPickCreation.md) |  | [required] |
    31  
    32  ### Return type
    33  
    34  [**models::Commit**](Commit.md)
    35  
    36  ### Authorization
    37  
    38  [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)
    39  
    40  ### HTTP request headers
    41  
    42  - **Content-Type**: application/json
    43  - **Accept**: application/json
    44  
    45  [[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)
    46  
    47  
    48  ## create_branch
    49  
    50  > String create_branch(repository, branch_creation)
    51  create branch
    52  
    53  ### Parameters
    54  
    55  
    56  Name | Type | Description  | Required | Notes
    57  ------------- | ------------- | ------------- | ------------- | -------------
    58  **repository** | **String** |  | [required] |
    59  **branch_creation** | [**BranchCreation**](BranchCreation.md) |  | [required] |
    60  
    61  ### Return type
    62  
    63  **String**
    64  
    65  ### Authorization
    66  
    67  [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)
    68  
    69  ### HTTP request headers
    70  
    71  - **Content-Type**: application/json
    72  - **Accept**: text/html, application/json
    73  
    74  [[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)
    75  
    76  
    77  ## delete_branch
    78  
    79  > delete_branch(repository, branch, force)
    80  delete branch
    81  
    82  ### Parameters
    83  
    84  
    85  Name | Type | Description  | Required | Notes
    86  ------------- | ------------- | ------------- | ------------- | -------------
    87  **repository** | **String** |  | [required] |
    88  **branch** | **String** |  | [required] |
    89  **force** | Option<**bool**> |  |  |[default to false]
    90  
    91  ### Return type
    92  
    93   (empty response body)
    94  
    95  ### Authorization
    96  
    97  [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)
    98  
    99  ### HTTP request headers
   100  
   101  - **Content-Type**: Not defined
   102  - **Accept**: application/json
   103  
   104  [[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)
   105  
   106  
   107  ## diff_branch
   108  
   109  > models::DiffList diff_branch(repository, branch, after, amount, prefix, delimiter)
   110  diff branch
   111  
   112  ### Parameters
   113  
   114  
   115  Name | Type | Description  | Required | Notes
   116  ------------- | ------------- | ------------- | ------------- | -------------
   117  **repository** | **String** |  | [required] |
   118  **branch** | **String** |  | [required] |
   119  **after** | Option<**String**> | return items after this value |  |
   120  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   121  **prefix** | Option<**String**> | return items prefixed with this value |  |
   122  **delimiter** | Option<**String**> | delimiter used to group common prefixes by |  |
   123  
   124  ### Return type
   125  
   126  [**models::DiffList**](DiffList.md)
   127  
   128  ### Authorization
   129  
   130  [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)
   131  
   132  ### HTTP request headers
   133  
   134  - **Content-Type**: Not defined
   135  - **Accept**: application/json
   136  
   137  [[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)
   138  
   139  
   140  ## get_branch
   141  
   142  > models::Ref get_branch(repository, branch)
   143  get branch
   144  
   145  ### Parameters
   146  
   147  
   148  Name | Type | Description  | Required | Notes
   149  ------------- | ------------- | ------------- | ------------- | -------------
   150  **repository** | **String** |  | [required] |
   151  **branch** | **String** |  | [required] |
   152  
   153  ### Return type
   154  
   155  [**models::Ref**](Ref.md)
   156  
   157  ### Authorization
   158  
   159  [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)
   160  
   161  ### HTTP request headers
   162  
   163  - **Content-Type**: Not defined
   164  - **Accept**: application/json
   165  
   166  [[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)
   167  
   168  
   169  ## list_branches
   170  
   171  > models::RefList list_branches(repository, prefix, after, amount)
   172  list branches
   173  
   174  ### Parameters
   175  
   176  
   177  Name | Type | Description  | Required | Notes
   178  ------------- | ------------- | ------------- | ------------- | -------------
   179  **repository** | **String** |  | [required] |
   180  **prefix** | Option<**String**> | return items prefixed with this value |  |
   181  **after** | Option<**String**> | return items after this value |  |
   182  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   183  
   184  ### Return type
   185  
   186  [**models::RefList**](RefList.md)
   187  
   188  ### Authorization
   189  
   190  [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)
   191  
   192  ### HTTP request headers
   193  
   194  - **Content-Type**: Not defined
   195  - **Accept**: application/json
   196  
   197  [[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)
   198  
   199  
   200  ## reset_branch
   201  
   202  > reset_branch(repository, branch, reset_creation)
   203  reset branch
   204  
   205  ### Parameters
   206  
   207  
   208  Name | Type | Description  | Required | Notes
   209  ------------- | ------------- | ------------- | ------------- | -------------
   210  **repository** | **String** |  | [required] |
   211  **branch** | **String** |  | [required] |
   212  **reset_creation** | [**ResetCreation**](ResetCreation.md) |  | [required] |
   213  
   214  ### Return type
   215  
   216   (empty response body)
   217  
   218  ### Authorization
   219  
   220  [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)
   221  
   222  ### HTTP request headers
   223  
   224  - **Content-Type**: application/json
   225  - **Accept**: application/json
   226  
   227  [[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)
   228  
   229  
   230  ## revert_branch
   231  
   232  > revert_branch(repository, branch, revert_creation)
   233  revert
   234  
   235  ### Parameters
   236  
   237  
   238  Name | Type | Description  | Required | Notes
   239  ------------- | ------------- | ------------- | ------------- | -------------
   240  **repository** | **String** |  | [required] |
   241  **branch** | **String** |  | [required] |
   242  **revert_creation** | [**RevertCreation**](RevertCreation.md) |  | [required] |
   243  
   244  ### Return type
   245  
   246   (empty response body)
   247  
   248  ### Authorization
   249  
   250  [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)
   251  
   252  ### HTTP request headers
   253  
   254  - **Content-Type**: application/json
   255  - **Accept**: application/json
   256  
   257  [[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)
   258