mirror of
https://codeberg.org/gitnex/tea4j-autodeploy
synced 2026-05-31 07:01:55 +00:00
Synchronizing API and documentation updates
This commit is contained in:
gitnexbot
+101
-7
@@ -6,10 +6,10 @@ Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**createCurrentUserRepo**](UserApi.md#createCurrentUserRepo) | **POST** user/repos | Create a repository
|
||||
[**createUserVariable**](UserApi.md#createUserVariable) | **POST** user/actions/variables/{variablename} | Create a user-level variable
|
||||
[**deleteUserRunner**](UserApi.md#deleteUserRunner) | **DELETE** user/actions/runners/{runner_id} | Delete an user-level runner
|
||||
[**deleteUserRunner**](UserApi.md#deleteUserRunner) | **DELETE** user/actions/runners/{runner_id} | Delete a user-level runner
|
||||
[**deleteUserSecret**](UserApi.md#deleteUserSecret) | **DELETE** user/actions/secrets/{secretname} | Delete a secret in a user scope
|
||||
[**deleteUserVariable**](UserApi.md#deleteUserVariable) | **DELETE** user/actions/variables/{variablename} | Delete a user-level variable which is created by current doer
|
||||
[**getUserRunner**](UserApi.md#getUserRunner) | **GET** user/actions/runners/{runner_id} | Get an user-level runner
|
||||
[**getUserRunner**](UserApi.md#getUserRunner) | **GET** user/actions/runners/{runner_id} | Get a user-level runner
|
||||
[**getUserRunners**](UserApi.md#getUserRunners) | **GET** user/actions/runners | Get user-level runners
|
||||
[**getUserSettings**](UserApi.md#getUserSettings) | **GET** user/settings | Get user settings
|
||||
[**getUserVariable**](UserApi.md#getUserVariable) | **GET** user/actions/variables/{variablename} | Get a user-level variable which is created by current doer
|
||||
@@ -17,6 +17,7 @@ Method | HTTP request | Description
|
||||
[**getUserWorkflowJobs**](UserApi.md#getUserWorkflowJobs) | **GET** user/actions/jobs | Get workflow jobs
|
||||
[**getUserWorkflowRuns**](UserApi.md#getUserWorkflowRuns) | **GET** user/actions/runs | Get workflow runs
|
||||
[**getVerificationToken**](UserApi.md#getVerificationToken) | **GET** user/gpg_key_token | Get a Token to verify
|
||||
[**updateUserRunner**](UserApi.md#updateUserRunner) | **PATCH** user/actions/runners/{runner_id} | Update a user-level runner
|
||||
[**updateUserSecret**](UserApi.md#updateUserSecret) | **PUT** user/actions/secrets/{secretname} | Create or Update a secret value in a user scope
|
||||
[**updateUserSettings**](UserApi.md#updateUserSettings) | **PATCH** user/settings | Update user settings
|
||||
[**updateUserVariable**](UserApi.md#updateUserVariable) | **PUT** user/actions/variables/{variablename} | Update a user-level variable which is created by current doer
|
||||
@@ -260,7 +261,7 @@ Name | Type | Description | Notes
|
||||
# **deleteUserRunner**
|
||||
> Void deleteUserRunner(runnerId)
|
||||
|
||||
Delete an user-level runner
|
||||
Delete a user-level runner
|
||||
|
||||
### Example
|
||||
```java
|
||||
@@ -521,7 +522,7 @@ Name | Type | Description | Notes
|
||||
# **getUserRunner**
|
||||
> Void getUserRunner(runnerId)
|
||||
|
||||
Get an user-level runner
|
||||
Get a user-level runner
|
||||
|
||||
### Example
|
||||
```java
|
||||
@@ -606,7 +607,7 @@ Name | Type | Description | Notes
|
||||
|
||||
<a name="getUserRunners"></a>
|
||||
# **getUserRunners**
|
||||
> Void getUserRunners()
|
||||
> Void getUserRunners(disabled)
|
||||
|
||||
Get user-level runners
|
||||
|
||||
@@ -662,8 +663,9 @@ Token.setApiKey("YOUR API KEY");
|
||||
//Token.setApiKeyPrefix("Token");
|
||||
|
||||
UserApi apiInstance = new UserApi();
|
||||
Boolean disabled = true; // Boolean | filter by disabled status (true or false)
|
||||
try {
|
||||
Void result = apiInstance.getUserRunners();
|
||||
Void result = apiInstance.getUserRunners(disabled);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling UserApi#getUserRunners");
|
||||
@@ -672,7 +674,10 @@ try {
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**disabled** | **Boolean**| filter by disabled status (true or false) | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
@@ -1219,6 +1224,95 @@ This endpoint does not need any parameter.
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
<a name="updateUserRunner"></a>
|
||||
# **updateUserRunner**
|
||||
> Void updateUserRunner(runnerId, body)
|
||||
|
||||
Update a user-level runner
|
||||
|
||||
### Example
|
||||
```java
|
||||
// Import classes:
|
||||
//import org.gitnex.tea4j.v2.ApiClient;
|
||||
//import org.gitnex.tea4j.v2.ApiException;
|
||||
//import org.gitnex.tea4j.v2.Configuration;
|
||||
//import org.gitnex.tea4j.v2.auth.*;
|
||||
//import org.gitnex.tea4j.v2.apis.UserApi;
|
||||
|
||||
ApiClient defaultClient = Configuration.getDefaultApiClient();
|
||||
|
||||
// Configure API key authorization: AccessToken
|
||||
ApiKeyAuth AccessToken = (ApiKeyAuth) defaultClient.getAuthentication("AccessToken");
|
||||
AccessToken.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//AccessToken.setApiKeyPrefix("Token");
|
||||
|
||||
// Configure API key authorization: AuthorizationHeaderToken
|
||||
ApiKeyAuth AuthorizationHeaderToken = (ApiKeyAuth) defaultClient.getAuthentication("AuthorizationHeaderToken");
|
||||
AuthorizationHeaderToken.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//AuthorizationHeaderToken.setApiKeyPrefix("Token");
|
||||
// Configure HTTP basic authorization: BasicAuth
|
||||
HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
|
||||
BasicAuth.setUsername("YOUR USERNAME");
|
||||
BasicAuth.setPassword("YOUR PASSWORD");
|
||||
|
||||
// Configure API key authorization: SudoHeader
|
||||
ApiKeyAuth SudoHeader = (ApiKeyAuth) defaultClient.getAuthentication("SudoHeader");
|
||||
SudoHeader.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//SudoHeader.setApiKeyPrefix("Token");
|
||||
|
||||
// Configure API key authorization: SudoParam
|
||||
ApiKeyAuth SudoParam = (ApiKeyAuth) defaultClient.getAuthentication("SudoParam");
|
||||
SudoParam.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//SudoParam.setApiKeyPrefix("Token");
|
||||
|
||||
// Configure API key authorization: TOTPHeader
|
||||
ApiKeyAuth TOTPHeader = (ApiKeyAuth) defaultClient.getAuthentication("TOTPHeader");
|
||||
TOTPHeader.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//TOTPHeader.setApiKeyPrefix("Token");
|
||||
|
||||
// Configure API key authorization: Token
|
||||
ApiKeyAuth Token = (ApiKeyAuth) defaultClient.getAuthentication("Token");
|
||||
Token.setApiKey("YOUR API KEY");
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//Token.setApiKeyPrefix("Token");
|
||||
|
||||
UserApi apiInstance = new UserApi();
|
||||
String runnerId = "runnerId_example"; // String | id of the runner
|
||||
EditActionRunnerOption body = new EditActionRunnerOption(); // EditActionRunnerOption |
|
||||
try {
|
||||
Void result = apiInstance.updateUserRunner(runnerId, body);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling UserApi#updateUserRunner");
|
||||
e.printStackTrace();
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**runnerId** | **String**| id of the runner |
|
||||
**body** | [**EditActionRunnerOption**](EditActionRunnerOption.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Void**](.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AccessToken](../README.md#AccessToken)[AuthorizationHeaderToken](../README.md#AuthorizationHeaderToken)[BasicAuth](../README.md#BasicAuth)[SudoHeader](../README.md#SudoHeader)[SudoParam](../README.md#SudoParam)[TOTPHeader](../README.md#TOTPHeader)[Token](../README.md#Token)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
<a name="updateUserSecret"></a>
|
||||
# **updateUserSecret**
|
||||
> Void updateUserSecret(secretname, body)
|
||||
|
||||
Reference in New Issue
Block a user