Remove deprecated API documentation and models related to logging, project management, queries, and Redis management. This includes the deletion of various markdown files and TypeScript definitions that are no longer in use, streamlining the codebase and improving maintainability.
This commit is contained in:
122
out/js/docs/APITokensApi.md
Normal file
122
out/js/docs/APITokensApi.md
Normal file
@ -0,0 +1,122 @@
|
||||
# LowCodeEngineApi.APITokensApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**apiTokenGeneratePost**](APITokensApi.md#apiTokenGeneratePost) | **POST** /api/token/generate | Generate API token
|
||||
[**apiTokenRevokeTokenDelete**](APITokensApi.md#apiTokenRevokeTokenDelete) | **DELETE** /api/token/revoke/{token} | Revoke API token
|
||||
|
||||
|
||||
|
||||
## apiTokenGeneratePost
|
||||
|
||||
> Token apiTokenGeneratePost(apiTokenGeneratePostRequest)
|
||||
|
||||
Generate API token
|
||||
|
||||
Generate a new API token for a project
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: AdminAuth
|
||||
let AdminAuth = defaultClient.authentications['AdminAuth'];
|
||||
AdminAuth.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//AdminAuth.apiKeyPrefix = 'Token';
|
||||
// Configure API key authorization: ApiKeyAuth
|
||||
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
|
||||
ApiKeyAuth.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//ApiKeyAuth.apiKeyPrefix = 'Token';
|
||||
|
||||
let apiInstance = new LowCodeEngineApi.APITokensApi();
|
||||
let apiTokenGeneratePostRequest = new LowCodeEngineApi.ApiTokenGeneratePostRequest(); // ApiTokenGeneratePostRequest |
|
||||
apiInstance.apiTokenGeneratePost(apiTokenGeneratePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**apiTokenGeneratePostRequest** | [**ApiTokenGeneratePostRequest**](ApiTokenGeneratePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Token**](Token.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## apiTokenRevokeTokenDelete
|
||||
|
||||
> apiTokenRevokeTokenDelete(token)
|
||||
|
||||
Revoke API token
|
||||
|
||||
Revoke an existing API token
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: AdminAuth
|
||||
let AdminAuth = defaultClient.authentications['AdminAuth'];
|
||||
AdminAuth.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//AdminAuth.apiKeyPrefix = 'Token';
|
||||
// Configure API key authorization: ApiKeyAuth
|
||||
let ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
|
||||
ApiKeyAuth.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//ApiKeyAuth.apiKeyPrefix = 'Token';
|
||||
|
||||
let apiInstance = new LowCodeEngineApi.APITokensApi();
|
||||
let token = "token_example"; // String | Token to revoke
|
||||
apiInstance.apiTokenRevokeTokenDelete(token, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully.');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**token** | **String**| Token to revoke |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
Reference in New Issue
Block a user