66a461f12a
- Created documentation for FunctionsCreatePostRequest and FunctionsDeletePostRequest. - Added Log and LogContentInner models with corresponding documentation. - Introduced LoggerIdFindAllPostRequest and LoggingApi for log management. - Added Migration and Project models with their respective documentation. - Implemented ProjectCreatePutRequest and ProjectManagementApi for project management. - Created Query and QueryCreatePostRequest models with documentation. - Added RedisNode and RedisNodeCreatePostRequest for Redis management. - Included Token model for API token management. - Added a script for git push operations and updated index.ts for API exports.
119 lines
3.0 KiB
Markdown
119 lines
3.0 KiB
Markdown
# APITokensApi
|
|
|
|
All URIs are relative to *http://localhost:3000*
|
|
|
|
|Method | HTTP request | Description|
|
|
|------------- | ------------- | -------------|
|
|
|[**apiTokenGeneratePost**](#apitokengeneratepost) | **POST** /api/token/generate | Generate API token|
|
|
|[**apiTokenRevokeTokenDelete**](#apitokenrevoketokendelete) | **DELETE** /api/token/revoke/{token} | Revoke API token|
|
|
|
|
# **apiTokenGeneratePost**
|
|
> Token apiTokenGeneratePost(apiTokenGeneratePostRequest)
|
|
|
|
Generate a new API token for a project
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
APITokensApi,
|
|
Configuration,
|
|
ApiTokenGeneratePostRequest
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new APITokensApi(configuration);
|
|
|
|
let apiTokenGeneratePostRequest: ApiTokenGeneratePostRequest; //
|
|
|
|
const { status, data } = await apiInstance.apiTokenGeneratePost(
|
|
apiTokenGeneratePostRequest
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **apiTokenGeneratePostRequest** | **ApiTokenGeneratePostRequest**| | |
|
|
|
|
|
|
### Return type
|
|
|
|
**Token**
|
|
|
|
### Authorization
|
|
|
|
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: application/json
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | Token generated successfully | - |
|
|
|**400** | Project ID is required | - |
|
|
|**401** | Unauthorized | - |
|
|
|**403** | Admin access required | - |
|
|
|
|
[[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)
|
|
|
|
# **apiTokenRevokeTokenDelete**
|
|
> apiTokenRevokeTokenDelete()
|
|
|
|
Revoke an existing API token
|
|
|
|
### Example
|
|
|
|
```typescript
|
|
import {
|
|
APITokensApi,
|
|
Configuration
|
|
} from './api';
|
|
|
|
const configuration = new Configuration();
|
|
const apiInstance = new APITokensApi(configuration);
|
|
|
|
let token: string; //Token to revoke (default to undefined)
|
|
|
|
const { status, data } = await apiInstance.apiTokenRevokeTokenDelete(
|
|
token
|
|
);
|
|
```
|
|
|
|
### Parameters
|
|
|
|
|Name | Type | Description | Notes|
|
|
|------------- | ------------- | ------------- | -------------|
|
|
| **token** | [**string**] | Token to revoke | defaults to undefined|
|
|
|
|
|
|
### Return type
|
|
|
|
void (empty response body)
|
|
|
|
### Authorization
|
|
|
|
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: Not defined
|
|
|
|
|
|
### HTTP response details
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
|**200** | Token revoked successfully | - |
|
|
|**401** | Unauthorized | - |
|
|
|**403** | Admin access required | - |
|
|
|**404** | Token not found | - |
|
|
|
|
[[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)
|
|
|