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
@@ -5,18 +5,23 @@ All URIs are relative to *http://{{AppSubUrl | JSEscape | Safe}}/api/v1*
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**adminAdoptRepository**](AdminApi.md#adminAdoptRepository) | **POST** admin/unadopted/{owner}/{repo} | Adopt unadopted files as a repository
|
||||
[**adminCreateHook**](AdminApi.md#adminCreateHook) | **POST** admin/hooks | Create a hook
|
||||
[**adminCreateOrg**](AdminApi.md#adminCreateOrg) | **POST** admin/users/{username}/orgs | Create an organization
|
||||
[**adminCreatePublicKey**](AdminApi.md#adminCreatePublicKey) | **POST** admin/users/{username}/keys | Add a public key on behalf of a user
|
||||
[**adminCreateRepo**](AdminApi.md#adminCreateRepo) | **POST** admin/users/{username}/repos | Create a repository on behalf of a user
|
||||
[**adminCreateUser**](AdminApi.md#adminCreateUser) | **POST** admin/users | Create a user
|
||||
[**adminCronList**](AdminApi.md#adminCronList) | **GET** admin/cron | List cron tasks
|
||||
[**adminCronRun**](AdminApi.md#adminCronRun) | **POST** admin/cron/{task} | Run cron task
|
||||
[**adminDeleteHook**](AdminApi.md#adminDeleteHook) | **DELETE** amdin/hooks/{id} | Delete a hook
|
||||
[**adminDeleteUnadoptedRepository**](AdminApi.md#adminDeleteUnadoptedRepository) | **DELETE** admin/unadopted/{owner}/{repo} | Delete unadopted files
|
||||
[**adminDeleteUser**](AdminApi.md#adminDeleteUser) | **DELETE** admin/users/{username} | Delete a user
|
||||
[**adminDeleteUserPublicKey**](AdminApi.md#adminDeleteUserPublicKey) | **DELETE** admin/users/{username}/keys/{id} | Delete a user's public key
|
||||
[**adminEditHook**](AdminApi.md#adminEditHook) | **PATCH** admin/hooks/{id} | Update a hook
|
||||
[**adminEditUser**](AdminApi.md#adminEditUser) | **PATCH** admin/users/{username} | Edit an existing user
|
||||
[**adminGetAllOrgs**](AdminApi.md#adminGetAllOrgs) | **GET** admin/orgs | List all organizations
|
||||
[**adminGetAllUsers**](AdminApi.md#adminGetAllUsers) | **GET** admin/users | List all users
|
||||
[**adminGetHook**](AdminApi.md#adminGetHook) | **GET** admin/hooks/{id} | Get a hook
|
||||
[**adminListHooks**](AdminApi.md#adminListHooks) | **GET** admin/hooks | List system's webhooks
|
||||
[**adminUnadoptedList**](AdminApi.md#adminUnadoptedList) | **GET** admin/unadopted | List unadopted repositories
|
||||
|
||||
<a name="adminAdoptRepository"></a>
|
||||
@@ -108,6 +113,93 @@ Name | Type | Description | Notes
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
<a name="adminCreateHook"></a>
|
||||
# **adminCreateHook**
|
||||
> Hook adminCreateHook(body)
|
||||
|
||||
Create a hook
|
||||
|
||||
### 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.AdminApi;
|
||||
|
||||
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");
|
||||
|
||||
AdminApi apiInstance = new AdminApi();
|
||||
CreateHookOption body = new CreateHookOption(); // CreateHookOption |
|
||||
try {
|
||||
Hook result = apiInstance.adminCreateHook(body);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling AdminApi#adminCreateHook");
|
||||
e.printStackTrace();
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**body** | [**CreateHookOption**](CreateHookOption.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Hook**](Hook.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**: application/json
|
||||
|
||||
<a name="adminCreateOrg"></a>
|
||||
# **adminCreateOrg**
|
||||
> Organization adminCreateOrg(body, username)
|
||||
@@ -633,6 +725,93 @@ Name | Type | Description | Notes
|
||||
|
||||
[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**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
<a name="adminDeleteHook"></a>
|
||||
# **adminDeleteHook**
|
||||
> Void adminDeleteHook(id)
|
||||
|
||||
Delete a hook
|
||||
|
||||
### 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.AdminApi;
|
||||
|
||||
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");
|
||||
|
||||
AdminApi apiInstance = new AdminApi();
|
||||
Long id = 789L; // Long | id of the hook to delete
|
||||
try {
|
||||
Void result = apiInstance.adminDeleteHook(id);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling AdminApi#adminDeleteHook");
|
||||
e.printStackTrace();
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **Long**| id of the hook to delete |
|
||||
|
||||
### 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**: Not defined
|
||||
@@ -903,6 +1082,95 @@ Name | Type | Description | Notes
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
<a name="adminEditHook"></a>
|
||||
# **adminEditHook**
|
||||
> Hook adminEditHook(id, body)
|
||||
|
||||
Update a hook
|
||||
|
||||
### 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.AdminApi;
|
||||
|
||||
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");
|
||||
|
||||
AdminApi apiInstance = new AdminApi();
|
||||
Long id = 789L; // Long | id of the hook to update
|
||||
EditHookOption body = new EditHookOption(); // EditHookOption |
|
||||
try {
|
||||
Hook result = apiInstance.adminEditHook(id, body);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling AdminApi#adminEditHook");
|
||||
e.printStackTrace();
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **Long**| id of the hook to update |
|
||||
**body** | [**EditHookOption**](EditHookOption.md)| | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**Hook**](Hook.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**: application/json
|
||||
|
||||
<a name="adminEditUser"></a>
|
||||
# **adminEditUser**
|
||||
> User adminEditUser(username, body)
|
||||
@@ -1165,6 +1433,182 @@ Name | Type | Description | Notes
|
||||
|
||||
[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**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="adminGetHook"></a>
|
||||
# **adminGetHook**
|
||||
> Hook adminGetHook(id)
|
||||
|
||||
Get a hook
|
||||
|
||||
### 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.AdminApi;
|
||||
|
||||
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");
|
||||
|
||||
AdminApi apiInstance = new AdminApi();
|
||||
Long id = 789L; // Long | id of the hook to get
|
||||
try {
|
||||
Hook result = apiInstance.adminGetHook(id);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling AdminApi#adminGetHook");
|
||||
e.printStackTrace();
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **Long**| id of the hook to get |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Hook**](Hook.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**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
<a name="adminListHooks"></a>
|
||||
# **adminListHooks**
|
||||
> List<Hook> adminListHooks(page, limit)
|
||||
|
||||
List system's webhooks
|
||||
|
||||
### 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.AdminApi;
|
||||
|
||||
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");
|
||||
|
||||
AdminApi apiInstance = new AdminApi();
|
||||
Integer page = 56; // Integer | page number of results to return (1-based)
|
||||
Integer limit = 56; // Integer | page size of results
|
||||
try {
|
||||
List<Hook> result = apiInstance.adminListHooks(page, limit);
|
||||
System.out.println(result);
|
||||
} catch (ApiException e) {
|
||||
System.err.println("Exception when calling AdminApi#adminListHooks");
|
||||
e.printStackTrace();
|
||||
}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**page** | **Integer**| page number of results to return (1-based) | [optional]
|
||||
**limit** | **Integer**| page size of results | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
[**List<Hook>**](Hook.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**: Not defined
|
||||
|
||||
@@ -2,12 +2,15 @@ package org.gitnex.tea4j.v2.apis;
|
||||
|
||||
import java.util.List;
|
||||
import org.gitnex.tea4j.v2.CollectionFormats.*;
|
||||
import org.gitnex.tea4j.v2.models.CreateHookOption;
|
||||
import org.gitnex.tea4j.v2.models.CreateKeyOption;
|
||||
import org.gitnex.tea4j.v2.models.CreateOrgOption;
|
||||
import org.gitnex.tea4j.v2.models.CreateRepoOption;
|
||||
import org.gitnex.tea4j.v2.models.CreateUserOption;
|
||||
import org.gitnex.tea4j.v2.models.Cron;
|
||||
import org.gitnex.tea4j.v2.models.EditHookOption;
|
||||
import org.gitnex.tea4j.v2.models.EditUserOption;
|
||||
import org.gitnex.tea4j.v2.models.Hook;
|
||||
import org.gitnex.tea4j.v2.models.Organization;
|
||||
import org.gitnex.tea4j.v2.models.PublicKey;
|
||||
import org.gitnex.tea4j.v2.models.Repository;
|
||||
@@ -27,6 +30,16 @@ public interface AdminApi {
|
||||
Call<Void> adminAdoptRepository(
|
||||
@retrofit2.http.Path("owner") String owner, @retrofit2.http.Path("repo") String repo);
|
||||
|
||||
/**
|
||||
* Create a hook
|
||||
*
|
||||
* @param body (required)
|
||||
* @return Call<Hook>
|
||||
*/
|
||||
@Headers({"Content-Type:application/json"})
|
||||
@POST("admin/hooks")
|
||||
Call<Hook> adminCreateHook(@retrofit2.http.Body CreateHookOption body);
|
||||
|
||||
/**
|
||||
* Create an organization
|
||||
*
|
||||
@@ -93,6 +106,15 @@ public interface AdminApi {
|
||||
@POST("admin/cron/{task}")
|
||||
Call<Void> adminCronRun(@retrofit2.http.Path("task") String task);
|
||||
|
||||
/**
|
||||
* Delete a hook
|
||||
*
|
||||
* @param id id of the hook to delete (required)
|
||||
* @return Call<Void>
|
||||
*/
|
||||
@DELETE("amdin/hooks/{id}")
|
||||
Call<Void> adminDeleteHook(@retrofit2.http.Path("id") Long id);
|
||||
|
||||
/**
|
||||
* Delete unadopted files
|
||||
*
|
||||
@@ -124,6 +146,18 @@ public interface AdminApi {
|
||||
Call<Void> adminDeleteUserPublicKey(
|
||||
@retrofit2.http.Path("username") String username, @retrofit2.http.Path("id") Long id);
|
||||
|
||||
/**
|
||||
* Update a hook
|
||||
*
|
||||
* @param id id of the hook to update (required)
|
||||
* @param body (optional)
|
||||
* @return Call<Hook>
|
||||
*/
|
||||
@Headers({"Content-Type:application/json"})
|
||||
@PATCH("admin/hooks/{id}")
|
||||
Call<Hook> adminEditHook(
|
||||
@retrofit2.http.Path("id") Long id, @retrofit2.http.Body EditHookOption body);
|
||||
|
||||
/**
|
||||
* Edit an existing user
|
||||
*
|
||||
@@ -158,6 +192,26 @@ public interface AdminApi {
|
||||
Call<List<User>> adminGetAllUsers(
|
||||
@retrofit2.http.Query("page") Integer page, @retrofit2.http.Query("limit") Integer limit);
|
||||
|
||||
/**
|
||||
* Get a hook
|
||||
*
|
||||
* @param id id of the hook to get (required)
|
||||
* @return Call<Hook>
|
||||
*/
|
||||
@GET("admin/hooks/{id}")
|
||||
Call<Hook> adminGetHook(@retrofit2.http.Path("id") Long id);
|
||||
|
||||
/**
|
||||
* List system's webhooks
|
||||
*
|
||||
* @param page page number of results to return (1-based) (optional)
|
||||
* @param limit page size of results (optional)
|
||||
* @return Call<List<Hook>>
|
||||
*/
|
||||
@GET("admin/hooks")
|
||||
Call<List<Hook>> adminListHooks(
|
||||
@retrofit2.http.Query("page") Integer page, @retrofit2.http.Query("limit") Integer limit);
|
||||
|
||||
/**
|
||||
* List unadopted repositories
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user