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

     1  # \RefsApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**diff_refs**](RefsApi.md#diff_refs) | **GET** /repositories/{repository}/refs/{leftRef}/diff/{rightRef} | diff references
     8  [**find_merge_base**](RefsApi.md#find_merge_base) | **GET** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | find the merge base for 2 references
     9  [**log_commits**](RefsApi.md#log_commits) | **GET** /repositories/{repository}/refs/{ref}/commits | get commit log from ref. If both objects and prefixes are empty, return all commits.
    10  [**merge_into_branch**](RefsApi.md#merge_into_branch) | **POST** /repositories/{repository}/refs/{sourceRef}/merge/{destinationBranch} | merge references
    11  
    12  
    13  
    14  ## diff_refs
    15  
    16  > models::DiffList diff_refs(repository, left_ref, right_ref, after, amount, prefix, delimiter, r#type)
    17  diff references
    18  
    19  ### Parameters
    20  
    21  
    22  Name | Type | Description  | Required | Notes
    23  ------------- | ------------- | ------------- | ------------- | -------------
    24  **repository** | **String** |  | [required] |
    25  **left_ref** | **String** | a reference (could be either a branch or a commit ID) | [required] |
    26  **right_ref** | **String** | a reference (could be either a branch or a commit ID) to compare against | [required] |
    27  **after** | Option<**String**> | return items after this value |  |
    28  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
    29  **prefix** | Option<**String**> | return items prefixed with this value |  |
    30  **delimiter** | Option<**String**> | delimiter used to group common prefixes by |  |
    31  **r#type** | Option<**String**> |  |  |[default to three_dot]
    32  
    33  ### Return type
    34  
    35  [**models::DiffList**](DiffList.md)
    36  
    37  ### Authorization
    38  
    39  [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)
    40  
    41  ### HTTP request headers
    42  
    43  - **Content-Type**: Not defined
    44  - **Accept**: application/json
    45  
    46  [[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)
    47  
    48  
    49  ## find_merge_base
    50  
    51  > models::FindMergeBaseResult find_merge_base(repository, source_ref, destination_branch)
    52  find the merge base for 2 references
    53  
    54  ### Parameters
    55  
    56  
    57  Name | Type | Description  | Required | Notes
    58  ------------- | ------------- | ------------- | ------------- | -------------
    59  **repository** | **String** |  | [required] |
    60  **source_ref** | **String** | source ref | [required] |
    61  **destination_branch** | **String** | destination branch name | [required] |
    62  
    63  ### Return type
    64  
    65  [**models::FindMergeBaseResult**](FindMergeBaseResult.md)
    66  
    67  ### Authorization
    68  
    69  [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)
    70  
    71  ### HTTP request headers
    72  
    73  - **Content-Type**: Not defined
    74  - **Accept**: application/json
    75  
    76  [[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)
    77  
    78  
    79  ## log_commits
    80  
    81  > models::CommitList log_commits(repository, r#ref, after, amount, objects, prefixes, limit, first_parent, since, stop_at)
    82  get commit log from ref. If both objects and prefixes are empty, return all commits.
    83  
    84  ### Parameters
    85  
    86  
    87  Name | Type | Description  | Required | Notes
    88  ------------- | ------------- | ------------- | ------------- | -------------
    89  **repository** | **String** |  | [required] |
    90  **r#ref** | **String** |  | [required] |
    91  **after** | Option<**String**> | return items after this value |  |
    92  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
    93  **objects** | Option<[**Vec<String>**](String.md)> | list of paths, each element is a path of a specific object |  |
    94  **prefixes** | Option<[**Vec<String>**](String.md)> | list of paths, each element is a path of a prefix |  |
    95  **limit** | Option<**bool**> | limit the number of items in return to 'amount'. Without further indication on actual number of items. |  |
    96  **first_parent** | Option<**bool**> | if set to true, follow only the first parent upon reaching a merge commit |  |
    97  **since** | Option<**String**> | Show commits more recent than a specific date-time. In case used with stop_at parameter, will stop at the first commit that meets any of the conditions. |  |
    98  **stop_at** | Option<**String**> | A reference to stop at. In case used with since parameter, will stop at the first commit that meets any of the conditions. |  |
    99  
   100  ### Return type
   101  
   102  [**models::CommitList**](CommitList.md)
   103  
   104  ### Authorization
   105  
   106  [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)
   107  
   108  ### HTTP request headers
   109  
   110  - **Content-Type**: Not defined
   111  - **Accept**: application/json
   112  
   113  [[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)
   114  
   115  
   116  ## merge_into_branch
   117  
   118  > models::MergeResult merge_into_branch(repository, source_ref, destination_branch, merge)
   119  merge references
   120  
   121  ### Parameters
   122  
   123  
   124  Name | Type | Description  | Required | Notes
   125  ------------- | ------------- | ------------- | ------------- | -------------
   126  **repository** | **String** |  | [required] |
   127  **source_ref** | **String** | source ref | [required] |
   128  **destination_branch** | **String** | destination branch name | [required] |
   129  **merge** | Option<[**Merge**](Merge.md)> |  |  |
   130  
   131  ### Return type
   132  
   133  [**models::MergeResult**](MergeResult.md)
   134  
   135  ### Authorization
   136  
   137  [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)
   138  
   139  ### HTTP request headers
   140  
   141  - **Content-Type**: application/json
   142  - **Accept**: application/json
   143  
   144  [[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)
   145