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

     1  # \ActionsApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**get_run**](ActionsApi.md#get_run) | **GET** /repositories/{repository}/actions/runs/{run_id} | get a run
     8  [**get_run_hook_output**](ActionsApi.md#get_run_hook_output) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks/{hook_run_id}/output | get run hook output
     9  [**list_repository_runs**](ActionsApi.md#list_repository_runs) | **GET** /repositories/{repository}/actions/runs | list runs
    10  [**list_run_hooks**](ActionsApi.md#list_run_hooks) | **GET** /repositories/{repository}/actions/runs/{run_id}/hooks | list run hooks
    11  
    12  
    13  
    14  ## get_run
    15  
    16  > models::ActionRun get_run(repository, run_id)
    17  get a run
    18  
    19  ### Parameters
    20  
    21  
    22  Name | Type | Description  | Required | Notes
    23  ------------- | ------------- | ------------- | ------------- | -------------
    24  **repository** | **String** |  | [required] |
    25  **run_id** | **String** |  | [required] |
    26  
    27  ### Return type
    28  
    29  [**models::ActionRun**](ActionRun.md)
    30  
    31  ### Authorization
    32  
    33  [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)
    34  
    35  ### HTTP request headers
    36  
    37  - **Content-Type**: Not defined
    38  - **Accept**: application/json
    39  
    40  [[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)
    41  
    42  
    43  ## get_run_hook_output
    44  
    45  > std::path::PathBuf get_run_hook_output(repository, run_id, hook_run_id)
    46  get run hook output
    47  
    48  ### Parameters
    49  
    50  
    51  Name | Type | Description  | Required | Notes
    52  ------------- | ------------- | ------------- | ------------- | -------------
    53  **repository** | **String** |  | [required] |
    54  **run_id** | **String** |  | [required] |
    55  **hook_run_id** | **String** |  | [required] |
    56  
    57  ### Return type
    58  
    59  [**std::path::PathBuf**](std::path::PathBuf.md)
    60  
    61  ### Authorization
    62  
    63  [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)
    64  
    65  ### HTTP request headers
    66  
    67  - **Content-Type**: Not defined
    68  - **Accept**: application/octet-stream, application/json
    69  
    70  [[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)
    71  
    72  
    73  ## list_repository_runs
    74  
    75  > models::ActionRunList list_repository_runs(repository, after, amount, branch, commit)
    76  list runs
    77  
    78  ### Parameters
    79  
    80  
    81  Name | Type | Description  | Required | Notes
    82  ------------- | ------------- | ------------- | ------------- | -------------
    83  **repository** | **String** |  | [required] |
    84  **after** | Option<**String**> | return items after this value |  |
    85  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
    86  **branch** | Option<**String**> |  |  |
    87  **commit** | Option<**String**> |  |  |
    88  
    89  ### Return type
    90  
    91  [**models::ActionRunList**](ActionRunList.md)
    92  
    93  ### Authorization
    94  
    95  [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)
    96  
    97  ### HTTP request headers
    98  
    99  - **Content-Type**: Not defined
   100  - **Accept**: application/json
   101  
   102  [[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)
   103  
   104  
   105  ## list_run_hooks
   106  
   107  > models::HookRunList list_run_hooks(repository, run_id, after, amount)
   108  list run hooks
   109  
   110  ### Parameters
   111  
   112  
   113  Name | Type | Description  | Required | Notes
   114  ------------- | ------------- | ------------- | ------------- | -------------
   115  **repository** | **String** |  | [required] |
   116  **run_id** | **String** |  | [required] |
   117  **after** | Option<**String**> | return items after this value |  |
   118  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   119  
   120  ### Return type
   121  
   122  [**models::HookRunList**](HookRunList.md)
   123  
   124  ### Authorization
   125  
   126  [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)
   127  
   128  ### HTTP request headers
   129  
   130  - **Content-Type**: Not defined
   131  - **Accept**: application/json
   132  
   133  [[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)
   134