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
|
||||
|
||||
9
out/js/docs/ApiTokenGeneratePostRequest.md
Normal file
9
out/js/docs/ApiTokenGeneratePostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.ApiTokenGeneratePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Project ID |
|
||||
|
||||
|
||||
9
out/js/docs/CommandCreatePostRequest.md
Normal file
9
out/js/docs/CommandCreatePostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.CommandCreatePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**source** | **String** | Command source code |
|
||||
|
||||
|
||||
9
out/js/docs/CommandUpdateIdPostRequest.md
Normal file
9
out/js/docs/CommandUpdateIdPostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.CommandUpdateIdPostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**source** | **String** | Updated command source code | [optional]
|
||||
|
||||
|
||||
239
out/js/docs/CommandsApi.md
Normal file
239
out/js/docs/CommandsApi.md
Normal file
@ -0,0 +1,239 @@
|
||||
# LowCodeEngineApi.CommandsApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**commandCreatePost**](CommandsApi.md#commandCreatePost) | **POST** /command/create | Create command
|
||||
[**commandDeleteIdDelete**](CommandsApi.md#commandDeleteIdDelete) | **DELETE** /command/delete/{id} | Delete command
|
||||
[**commandRunIdPost**](CommandsApi.md#commandRunIdPost) | **POST** /command/run/{id} | Run command
|
||||
[**commandUpdateIdPost**](CommandsApi.md#commandUpdateIdPost) | **POST** /command/update/{id} | Update command
|
||||
|
||||
|
||||
|
||||
## commandCreatePost
|
||||
|
||||
> Query commandCreatePost(commandCreatePostRequest)
|
||||
|
||||
Create command
|
||||
|
||||
Create a new command in the project
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.CommandsApi();
|
||||
let commandCreatePostRequest = new LowCodeEngineApi.CommandCreatePostRequest(); // CommandCreatePostRequest |
|
||||
apiInstance.commandCreatePost(commandCreatePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**commandCreatePostRequest** | [**CommandCreatePostRequest**](CommandCreatePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Query**](Query.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## commandDeleteIdDelete
|
||||
|
||||
> commandDeleteIdDelete(id)
|
||||
|
||||
Delete command
|
||||
|
||||
Delete an existing command
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: QueryGuard
|
||||
let QueryGuard = defaultClient.authentications['QueryGuard'];
|
||||
QueryGuard.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//QueryGuard.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.CommandsApi();
|
||||
let id = "id_example"; // String | Command ID
|
||||
apiInstance.commandDeleteIdDelete(id, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully.');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Command ID |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
## commandRunIdPost
|
||||
|
||||
> Object commandRunIdPost(id, body, opts)
|
||||
|
||||
Run command
|
||||
|
||||
Execute a command with provided data
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: QueryGuard
|
||||
let QueryGuard = defaultClient.authentications['QueryGuard'];
|
||||
QueryGuard.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//QueryGuard.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.CommandsApi();
|
||||
let id = "id_example"; // String | Command ID
|
||||
let body = {key: null}; // Object |
|
||||
let opts = {
|
||||
'xTraceId': "xTraceId_example" // String | Trace ID for logging
|
||||
};
|
||||
apiInstance.commandRunIdPost(id, body, opts, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Command ID |
|
||||
**body** | **Object**| |
|
||||
**xTraceId** | **String**| Trace ID for logging | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
**Object**
|
||||
|
||||
### Authorization
|
||||
|
||||
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## commandUpdateIdPost
|
||||
|
||||
> Query commandUpdateIdPost(id, commandUpdateIdPostRequest)
|
||||
|
||||
Update command
|
||||
|
||||
Update an existing command
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: QueryGuard
|
||||
let QueryGuard = defaultClient.authentications['QueryGuard'];
|
||||
QueryGuard.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//QueryGuard.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.CommandsApi();
|
||||
let id = "id_example"; // String | Command ID
|
||||
let commandUpdateIdPostRequest = new LowCodeEngineApi.CommandUpdateIdPostRequest(); // CommandUpdateIdPostRequest |
|
||||
apiInstance.commandUpdateIdPost(id, commandUpdateIdPostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Command ID |
|
||||
**commandUpdateIdPostRequest** | [**CommandUpdateIdPostRequest**](CommandUpdateIdPostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Query**](Query.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
16
out/js/docs/Database.md
Normal file
16
out/js/docs/Database.md
Normal file
@ -0,0 +1,16 @@
|
||||
# LowCodeEngineApi.Database
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique database identifier | [optional]
|
||||
**qUsername** | **String** | Query username for database access | [optional]
|
||||
**cUsername** | **String** | Command username for database access | [optional]
|
||||
**password** | **String** | Database password | [optional]
|
||||
**database** | **String** | Database name | [optional]
|
||||
**migrations** | [**[Migration]**](Migration.md) | | [optional]
|
||||
**project** | [**Project**](Project.md) | | [optional]
|
||||
**node** | [**DatabaseNode**](DatabaseNode.md) | | [optional]
|
||||
|
||||
|
||||
9
out/js/docs/DatabaseCreatePostRequest.md
Normal file
9
out/js/docs/DatabaseCreatePostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.DatabaseCreatePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**projectId** | **String** | Project ID |
|
||||
|
||||
|
||||
438
out/js/docs/DatabaseManagementApi.md
Normal file
438
out/js/docs/DatabaseManagementApi.md
Normal file
@ -0,0 +1,438 @@
|
||||
# LowCodeEngineApi.DatabaseManagementApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**databaseColumnsDatabaseIdTableNameGet**](DatabaseManagementApi.md#databaseColumnsDatabaseIdTableNameGet) | **GET** /database/columns/{databaseId}/{tableName} | Get table columns
|
||||
[**databaseCreatePost**](DatabaseManagementApi.md#databaseCreatePost) | **POST** /database/create | Create database
|
||||
[**databaseMigrationCreatePost**](DatabaseManagementApi.md#databaseMigrationCreatePost) | **POST** /database/migration/create | Create migration
|
||||
[**databaseMigrationDownDatabaseIdGet**](DatabaseManagementApi.md#databaseMigrationDownDatabaseIdGet) | **GET** /database/migration/down/{databaseId} | Run migrations down
|
||||
[**databaseMigrationUpDatabaseIdGet**](DatabaseManagementApi.md#databaseMigrationUpDatabaseIdGet) | **GET** /database/migration/up/{databaseId} | Run migrations up
|
||||
[**databaseNodeCreatePost**](DatabaseManagementApi.md#databaseNodeCreatePost) | **POST** /database/node/create | Add database node
|
||||
[**databaseQueryDatabaseIdPost**](DatabaseManagementApi.md#databaseQueryDatabaseIdPost) | **POST** /database/query/{databaseId} | Run database query
|
||||
[**databaseTablesDatabaseIdGet**](DatabaseManagementApi.md#databaseTablesDatabaseIdGet) | **GET** /database/tables/{databaseId} | Get database tables
|
||||
|
||||
|
||||
|
||||
## databaseColumnsDatabaseIdTableNameGet
|
||||
|
||||
> [Object] databaseColumnsDatabaseIdTableNameGet(databaseId, tableName)
|
||||
|
||||
Get table columns
|
||||
|
||||
Retrieve columns information for a specific table
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.DatabaseManagementApi();
|
||||
let databaseId = "databaseId_example"; // String | Database ID
|
||||
let tableName = "tableName_example"; // String | Table name
|
||||
apiInstance.databaseColumnsDatabaseIdTableNameGet(databaseId, tableName, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseId** | **String**| Database ID |
|
||||
**tableName** | **String**| Table name |
|
||||
|
||||
### Return type
|
||||
|
||||
**[Object]**
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## databaseCreatePost
|
||||
|
||||
> Database databaseCreatePost(databaseCreatePostRequest)
|
||||
|
||||
Create database
|
||||
|
||||
Create a new database 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.DatabaseManagementApi();
|
||||
let databaseCreatePostRequest = new LowCodeEngineApi.DatabaseCreatePostRequest(); // DatabaseCreatePostRequest |
|
||||
apiInstance.databaseCreatePost(databaseCreatePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseCreatePostRequest** | [**DatabaseCreatePostRequest**](DatabaseCreatePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Database**](Database.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## databaseMigrationCreatePost
|
||||
|
||||
> Migration databaseMigrationCreatePost(databaseMigrationCreatePostRequest)
|
||||
|
||||
Create migration
|
||||
|
||||
Create a new database migration
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.DatabaseManagementApi();
|
||||
let databaseMigrationCreatePostRequest = new LowCodeEngineApi.DatabaseMigrationCreatePostRequest(); // DatabaseMigrationCreatePostRequest |
|
||||
apiInstance.databaseMigrationCreatePost(databaseMigrationCreatePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseMigrationCreatePostRequest** | [**DatabaseMigrationCreatePostRequest**](DatabaseMigrationCreatePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Migration**](Migration.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## databaseMigrationDownDatabaseIdGet
|
||||
|
||||
> databaseMigrationDownDatabaseIdGet(databaseId)
|
||||
|
||||
Run migrations down
|
||||
|
||||
Rollback database migrations
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.DatabaseManagementApi();
|
||||
let databaseId = "databaseId_example"; // String | Database ID
|
||||
apiInstance.databaseMigrationDownDatabaseIdGet(databaseId, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully.');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseId** | **String**| Database ID |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
## databaseMigrationUpDatabaseIdGet
|
||||
|
||||
> databaseMigrationUpDatabaseIdGet(databaseId)
|
||||
|
||||
Run migrations up
|
||||
|
||||
Execute pending database migrations
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.DatabaseManagementApi();
|
||||
let databaseId = "databaseId_example"; // String | Database ID
|
||||
apiInstance.databaseMigrationUpDatabaseIdGet(databaseId, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully.');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseId** | **String**| Database ID |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
## databaseNodeCreatePost
|
||||
|
||||
> DatabaseNode databaseNodeCreatePost(databaseNodeCreatePostRequest)
|
||||
|
||||
Add database node
|
||||
|
||||
Add a new database node to the system
|
||||
|
||||
### 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.DatabaseManagementApi();
|
||||
let databaseNodeCreatePostRequest = new LowCodeEngineApi.DatabaseNodeCreatePostRequest(); // DatabaseNodeCreatePostRequest |
|
||||
apiInstance.databaseNodeCreatePost(databaseNodeCreatePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseNodeCreatePostRequest** | [**DatabaseNodeCreatePostRequest**](DatabaseNodeCreatePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**DatabaseNode**](DatabaseNode.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## databaseQueryDatabaseIdPost
|
||||
|
||||
> Object databaseQueryDatabaseIdPost(databaseId, databaseQueryDatabaseIdPostRequest)
|
||||
|
||||
Run database query
|
||||
|
||||
Execute a SQL query on the database
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.DatabaseManagementApi();
|
||||
let databaseId = "databaseId_example"; // String | Database ID
|
||||
let databaseQueryDatabaseIdPostRequest = new LowCodeEngineApi.DatabaseQueryDatabaseIdPostRequest(); // DatabaseQueryDatabaseIdPostRequest |
|
||||
apiInstance.databaseQueryDatabaseIdPost(databaseId, databaseQueryDatabaseIdPostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseId** | **String**| Database ID |
|
||||
**databaseQueryDatabaseIdPostRequest** | [**DatabaseQueryDatabaseIdPostRequest**](DatabaseQueryDatabaseIdPostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
**Object**
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## databaseTablesDatabaseIdGet
|
||||
|
||||
> [String] databaseTablesDatabaseIdGet(databaseId)
|
||||
|
||||
Get database tables
|
||||
|
||||
Retrieve list of tables in a database
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.DatabaseManagementApi();
|
||||
let databaseId = "databaseId_example"; // String | Database ID
|
||||
apiInstance.databaseTablesDatabaseIdGet(databaseId, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**databaseId** | **String**| Database ID |
|
||||
|
||||
### Return type
|
||||
|
||||
**[String]**
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
11
out/js/docs/DatabaseMigrationCreatePostRequest.md
Normal file
11
out/js/docs/DatabaseMigrationCreatePostRequest.md
Normal file
@ -0,0 +1,11 @@
|
||||
# LowCodeEngineApi.DatabaseMigrationCreatePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**up** | **String** | Migration up SQL |
|
||||
**down** | **String** | Migration down SQL |
|
||||
**databaseId** | **String** | Database ID |
|
||||
|
||||
|
||||
14
out/js/docs/DatabaseNode.md
Normal file
14
out/js/docs/DatabaseNode.md
Normal file
@ -0,0 +1,14 @@
|
||||
# LowCodeEngineApi.DatabaseNode
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique database node identifier | [optional]
|
||||
**host** | **String** | Database host | [optional]
|
||||
**port** | **Number** | Database port | [optional]
|
||||
**username** | **String** | Database username | [optional]
|
||||
**password** | **String** | Database password | [optional]
|
||||
**databases** | [**[Database]**](Database.md) | | [optional]
|
||||
|
||||
|
||||
12
out/js/docs/DatabaseNodeCreatePostRequest.md
Normal file
12
out/js/docs/DatabaseNodeCreatePostRequest.md
Normal file
@ -0,0 +1,12 @@
|
||||
# LowCodeEngineApi.DatabaseNodeCreatePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**host** | **String** | Database host |
|
||||
**port** | **Number** | Database port |
|
||||
**username** | **String** | Database username |
|
||||
**password** | **String** | Database password |
|
||||
|
||||
|
||||
9
out/js/docs/DatabaseQueryDatabaseIdPostRequest.md
Normal file
9
out/js/docs/DatabaseQueryDatabaseIdPostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.DatabaseQueryDatabaseIdPostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**query** | **String** | SQL query to execute |
|
||||
|
||||
|
||||
10
out/js/docs/Error.md
Normal file
10
out/js/docs/Error.md
Normal file
@ -0,0 +1,10 @@
|
||||
# LowCodeEngineApi.Error
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**error** | **String** | Error message | [optional]
|
||||
**details** | **String** | Error details | [optional]
|
||||
|
||||
|
||||
12
out/js/docs/Function.md
Normal file
12
out/js/docs/Function.md
Normal file
@ -0,0 +1,12 @@
|
||||
# LowCodeEngineApi.Function
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique function identifier | [optional]
|
||||
**name** | **String** | Function name | [optional]
|
||||
**source** | **String** | Function source code | [optional]
|
||||
**project** | [**Project**](Project.md) | | [optional]
|
||||
|
||||
|
||||
112
out/js/docs/FunctionsApi.md
Normal file
112
out/js/docs/FunctionsApi.md
Normal file
@ -0,0 +1,112 @@
|
||||
# LowCodeEngineApi.FunctionsApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**functionsCreatePost**](FunctionsApi.md#functionsCreatePost) | **POST** /functions/create | Create function
|
||||
[**functionsDeletePost**](FunctionsApi.md#functionsDeletePost) | **POST** /functions/delete | Delete function
|
||||
|
||||
|
||||
|
||||
## functionsCreatePost
|
||||
|
||||
> Function functionsCreatePost(functionsCreatePostRequest)
|
||||
|
||||
Create function
|
||||
|
||||
Create a new function in the project
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.FunctionsApi();
|
||||
let functionsCreatePostRequest = new LowCodeEngineApi.FunctionsCreatePostRequest(); // FunctionsCreatePostRequest |
|
||||
apiInstance.functionsCreatePost(functionsCreatePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**functionsCreatePostRequest** | [**FunctionsCreatePostRequest**](FunctionsCreatePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Function**](Function.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## functionsDeletePost
|
||||
|
||||
> functionsDeletePost(functionsDeletePostRequest)
|
||||
|
||||
Delete function
|
||||
|
||||
Delete a function from the project
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.FunctionsApi();
|
||||
let functionsDeletePostRequest = new LowCodeEngineApi.FunctionsDeletePostRequest(); // FunctionsDeletePostRequest |
|
||||
apiInstance.functionsDeletePost(functionsDeletePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully.');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**functionsDeletePostRequest** | [**FunctionsDeletePostRequest**](FunctionsDeletePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
10
out/js/docs/FunctionsCreatePostRequest.md
Normal file
10
out/js/docs/FunctionsCreatePostRequest.md
Normal file
@ -0,0 +1,10 @@
|
||||
# LowCodeEngineApi.FunctionsCreatePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **String** | Function name |
|
||||
**source** | **String** | Function source code |
|
||||
|
||||
|
||||
9
out/js/docs/FunctionsDeletePostRequest.md
Normal file
9
out/js/docs/FunctionsDeletePostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.FunctionsDeletePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **String** | Function name to delete |
|
||||
|
||||
|
||||
20
out/js/docs/Log.md
Normal file
20
out/js/docs/Log.md
Normal file
@ -0,0 +1,20 @@
|
||||
# LowCodeEngineApi.Log
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique log identifier | [optional]
|
||||
**traceId** | **String** | Trace ID for tracking requests | [optional]
|
||||
**startTime** | **Number** | Request start timestamp | [optional]
|
||||
**endTime** | **Number** | Request end timestamp | [optional]
|
||||
**payload** | **Object** | Request payload | [optional]
|
||||
**headers** | **Object** | Request headers | [optional]
|
||||
**cookies** | **String** | Request cookies | [optional]
|
||||
**url** | **String** | Request URL | [optional]
|
||||
**response** | **Object** | Response data | [optional]
|
||||
**content** | [**[LogContentInner]**](LogContentInner.md) | | [optional]
|
||||
**project** | [**Project**](Project.md) | | [optional]
|
||||
**query** | [**Query**](Query.md) | | [optional]
|
||||
|
||||
|
||||
11
out/js/docs/LogContentInner.md
Normal file
11
out/js/docs/LogContentInner.md
Normal file
@ -0,0 +1,11 @@
|
||||
# LowCodeEngineApi.LogContentInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**content** | **String** | Log content | [optional]
|
||||
**type** | **String** | Log type (info, error, warning) | [optional]
|
||||
**timeStamp** | **Number** | Log entry timestamp | [optional]
|
||||
|
||||
|
||||
14
out/js/docs/LoggerIdFindAllPostRequest.md
Normal file
14
out/js/docs/LoggerIdFindAllPostRequest.md
Normal file
@ -0,0 +1,14 @@
|
||||
# LowCodeEngineApi.LoggerIdFindAllPostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**traceId** | **String** | Filter by trace ID | [optional]
|
||||
**fromDate** | **Date** | Filter from date | [optional]
|
||||
**toDate** | **Date** | Filter to date | [optional]
|
||||
**url** | **String** | Filter by URL | [optional]
|
||||
**limit** | **Number** | Number of results to return |
|
||||
**offset** | **Number** | Number of results to skip |
|
||||
|
||||
|
||||
175
out/js/docs/LoggingApi.md
Normal file
175
out/js/docs/LoggingApi.md
Normal file
@ -0,0 +1,175 @@
|
||||
# LowCodeEngineApi.LoggingApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**loggerIdFindAllPost**](LoggingApi.md#loggerIdFindAllPost) | **POST** /logger/{id}/findAll | Find all logs
|
||||
[**loggerIdFindPost**](LoggingApi.md#loggerIdFindPost) | **POST** /logger/{id}/find | Find logs for query
|
||||
[**loggerIdTraceIdGet**](LoggingApi.md#loggerIdTraceIdGet) | **GET** /logger/{id}/{traceId} | Get log by trace ID
|
||||
|
||||
|
||||
|
||||
## loggerIdFindAllPost
|
||||
|
||||
> [Log] loggerIdFindAllPost(id, loggerIdFindAllPostRequest)
|
||||
|
||||
Find all logs
|
||||
|
||||
Find all logs for a project with filtering
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.LoggingApi();
|
||||
let id = "id_example"; // String | Project ID
|
||||
let loggerIdFindAllPostRequest = new LowCodeEngineApi.LoggerIdFindAllPostRequest(); // LoggerIdFindAllPostRequest |
|
||||
apiInstance.loggerIdFindAllPost(id, loggerIdFindAllPostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Project ID |
|
||||
**loggerIdFindAllPostRequest** | [**LoggerIdFindAllPostRequest**](LoggerIdFindAllPostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[Log]**](Log.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## loggerIdFindPost
|
||||
|
||||
> [Log] loggerIdFindPost(id, loggerIdFindAllPostRequest)
|
||||
|
||||
Find logs for query
|
||||
|
||||
Find logs for a specific query with filtering
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: QueryGuard
|
||||
let QueryGuard = defaultClient.authentications['QueryGuard'];
|
||||
QueryGuard.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//QueryGuard.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.LoggingApi();
|
||||
let id = "id_example"; // String | Query ID
|
||||
let loggerIdFindAllPostRequest = new LowCodeEngineApi.LoggerIdFindAllPostRequest(); // LoggerIdFindAllPostRequest |
|
||||
apiInstance.loggerIdFindPost(id, loggerIdFindAllPostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Query ID |
|
||||
**loggerIdFindAllPostRequest** | [**LoggerIdFindAllPostRequest**](LoggerIdFindAllPostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**[Log]**](Log.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## loggerIdTraceIdGet
|
||||
|
||||
> Log loggerIdTraceIdGet(id, traceId)
|
||||
|
||||
Get log by trace ID
|
||||
|
||||
Retrieve log entries by trace ID
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.LoggingApi();
|
||||
let id = "id_example"; // String | Log ID
|
||||
let traceId = "traceId_example"; // String | Trace ID
|
||||
apiInstance.loggerIdTraceIdGet(id, traceId, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Log ID |
|
||||
**traceId** | **String**| Trace ID |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Log**](Log.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
12
out/js/docs/Migration.md
Normal file
12
out/js/docs/Migration.md
Normal file
@ -0,0 +1,12 @@
|
||||
# LowCodeEngineApi.Migration
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique migration identifier | [optional]
|
||||
**up** | **String** | Migration up SQL | [optional]
|
||||
**down** | **String** | Migration down SQL | [optional]
|
||||
**database** | [**Database**](Database.md) | | [optional]
|
||||
|
||||
|
||||
15
out/js/docs/Project.md
Normal file
15
out/js/docs/Project.md
Normal file
@ -0,0 +1,15 @@
|
||||
# LowCodeEngineApi.Project
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique project identifier | [optional]
|
||||
**name** | **String** | Project name | [optional]
|
||||
**apiTokens** | [**[Token]**](Token.md) | | [optional]
|
||||
**database** | [**Database**](Database.md) | | [optional]
|
||||
**queries** | [**[Query]**](Query.md) | | [optional]
|
||||
**functions** | [**[Function]**](Function.md) | | [optional]
|
||||
**settings** | [**[ProjectSetting]**](ProjectSetting.md) | | [optional]
|
||||
|
||||
|
||||
9
out/js/docs/ProjectCreatePutRequest.md
Normal file
9
out/js/docs/ProjectCreatePutRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.ProjectCreatePutRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **String** | Project name |
|
||||
|
||||
|
||||
322
out/js/docs/ProjectManagementApi.md
Normal file
322
out/js/docs/ProjectManagementApi.md
Normal file
@ -0,0 +1,322 @@
|
||||
# LowCodeEngineApi.ProjectManagementApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**projectApiTokensGet**](ProjectManagementApi.md#projectApiTokensGet) | **GET** /project/api-tokens | Get all API tokens
|
||||
[**projectCreatePut**](ProjectManagementApi.md#projectCreatePut) | **PUT** /project/create | Create project
|
||||
[**projectCreateWithoutDbPut**](ProjectManagementApi.md#projectCreateWithoutDbPut) | **PUT** /project/create-without-db | Create project without database
|
||||
[**projectSettingsCreatePut**](ProjectManagementApi.md#projectSettingsCreatePut) | **PUT** /project/settings/create | Create project setting
|
||||
[**projectSettingsDeleteKeyDelete**](ProjectManagementApi.md#projectSettingsDeleteKeyDelete) | **DELETE** /project/settings/delete/{key} | Delete project setting
|
||||
[**projectSettingsGet**](ProjectManagementApi.md#projectSettingsGet) | **GET** /project/settings | Get all project settings
|
||||
|
||||
|
||||
|
||||
## projectApiTokensGet
|
||||
|
||||
> [Token] projectApiTokensGet()
|
||||
|
||||
Get all API tokens
|
||||
|
||||
Retrieve all API tokens for the current 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.ProjectManagementApi();
|
||||
apiInstance.projectApiTokensGet((error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**[Token]**](Token.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## projectCreatePut
|
||||
|
||||
> Project projectCreatePut(projectCreatePutRequest)
|
||||
|
||||
Create project
|
||||
|
||||
Create a new project with database
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.ProjectManagementApi();
|
||||
let projectCreatePutRequest = new LowCodeEngineApi.ProjectCreatePutRequest(); // ProjectCreatePutRequest |
|
||||
apiInstance.projectCreatePut(projectCreatePutRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**projectCreatePutRequest** | [**ProjectCreatePutRequest**](ProjectCreatePutRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Project**](Project.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## projectCreateWithoutDbPut
|
||||
|
||||
> Project projectCreateWithoutDbPut(projectCreatePutRequest)
|
||||
|
||||
Create project without database
|
||||
|
||||
Create a new project without creating a database
|
||||
|
||||
### 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.ProjectManagementApi();
|
||||
let projectCreatePutRequest = new LowCodeEngineApi.ProjectCreatePutRequest(); // ProjectCreatePutRequest |
|
||||
apiInstance.projectCreateWithoutDbPut(projectCreatePutRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**projectCreatePutRequest** | [**ProjectCreatePutRequest**](ProjectCreatePutRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Project**](Project.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## projectSettingsCreatePut
|
||||
|
||||
> ProjectSetting projectSettingsCreatePut(projectSettingsCreatePutRequest)
|
||||
|
||||
Create project setting
|
||||
|
||||
Create a new project setting
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.ProjectManagementApi();
|
||||
let projectSettingsCreatePutRequest = new LowCodeEngineApi.ProjectSettingsCreatePutRequest(); // ProjectSettingsCreatePutRequest |
|
||||
apiInstance.projectSettingsCreatePut(projectSettingsCreatePutRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**projectSettingsCreatePutRequest** | [**ProjectSettingsCreatePutRequest**](ProjectSettingsCreatePutRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**ProjectSetting**](ProjectSetting.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## projectSettingsDeleteKeyDelete
|
||||
|
||||
> projectSettingsDeleteKeyDelete(key)
|
||||
|
||||
Delete project setting
|
||||
|
||||
Delete a project setting by key
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.ProjectManagementApi();
|
||||
let key = "key_example"; // String | Setting key to delete
|
||||
apiInstance.projectSettingsDeleteKeyDelete(key, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully.');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**key** | **String**| Setting key to delete |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
## projectSettingsGet
|
||||
|
||||
> [ProjectSetting] projectSettingsGet()
|
||||
|
||||
Get all project settings
|
||||
|
||||
Retrieve all settings for the current project
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.ProjectManagementApi();
|
||||
apiInstance.projectSettingsGet((error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
|
||||
[**[ProjectSetting]**](ProjectSetting.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
12
out/js/docs/ProjectSetting.md
Normal file
12
out/js/docs/ProjectSetting.md
Normal file
@ -0,0 +1,12 @@
|
||||
# LowCodeEngineApi.ProjectSetting
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique setting identifier | [optional]
|
||||
**key** | **String** | Setting key | [optional]
|
||||
**value** | **String** | Setting value | [optional]
|
||||
**project** | [**Project**](Project.md) | | [optional]
|
||||
|
||||
|
||||
10
out/js/docs/ProjectSettingsCreatePutRequest.md
Normal file
10
out/js/docs/ProjectSettingsCreatePutRequest.md
Normal file
@ -0,0 +1,10 @@
|
||||
# LowCodeEngineApi.ProjectSettingsCreatePutRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**key** | **String** | Setting key |
|
||||
**value** | **String** | Setting value |
|
||||
|
||||
|
||||
239
out/js/docs/QueriesApi.md
Normal file
239
out/js/docs/QueriesApi.md
Normal file
@ -0,0 +1,239 @@
|
||||
# LowCodeEngineApi.QueriesApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**queryCreatePost**](QueriesApi.md#queryCreatePost) | **POST** /query/create | Create query
|
||||
[**queryDeleteIdDelete**](QueriesApi.md#queryDeleteIdDelete) | **DELETE** /query/delete/{id} | Delete query
|
||||
[**queryRunIdPost**](QueriesApi.md#queryRunIdPost) | **POST** /query/run/{id} | Run query
|
||||
[**queryUpdateIdPost**](QueriesApi.md#queryUpdateIdPost) | **POST** /query/update/{id} | Update query
|
||||
|
||||
|
||||
|
||||
## queryCreatePost
|
||||
|
||||
> Query queryCreatePost(queryCreatePostRequest)
|
||||
|
||||
Create query
|
||||
|
||||
Create a new query in the project
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// 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.QueriesApi();
|
||||
let queryCreatePostRequest = new LowCodeEngineApi.QueryCreatePostRequest(); // QueryCreatePostRequest |
|
||||
apiInstance.queryCreatePost(queryCreatePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**queryCreatePostRequest** | [**QueryCreatePostRequest**](QueryCreatePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Query**](Query.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## queryDeleteIdDelete
|
||||
|
||||
> queryDeleteIdDelete(id)
|
||||
|
||||
Delete query
|
||||
|
||||
Delete an existing query
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: QueryGuard
|
||||
let QueryGuard = defaultClient.authentications['QueryGuard'];
|
||||
QueryGuard.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//QueryGuard.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.QueriesApi();
|
||||
let id = "id_example"; // String | Query ID
|
||||
apiInstance.queryDeleteIdDelete(id, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully.');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Query ID |
|
||||
|
||||
### Return type
|
||||
|
||||
null (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
## queryRunIdPost
|
||||
|
||||
> Object queryRunIdPost(id, body, opts)
|
||||
|
||||
Run query
|
||||
|
||||
Execute a query with provided data
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: QueryGuard
|
||||
let QueryGuard = defaultClient.authentications['QueryGuard'];
|
||||
QueryGuard.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//QueryGuard.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.QueriesApi();
|
||||
let id = "id_example"; // String | Query ID
|
||||
let body = {key: null}; // Object |
|
||||
let opts = {
|
||||
'xTraceId': "xTraceId_example" // String | Trace ID for logging
|
||||
};
|
||||
apiInstance.queryRunIdPost(id, body, opts, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Query ID |
|
||||
**body** | **Object**| |
|
||||
**xTraceId** | **String**| Trace ID for logging | [optional]
|
||||
|
||||
### Return type
|
||||
|
||||
**Object**
|
||||
|
||||
### Authorization
|
||||
|
||||
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
## queryUpdateIdPost
|
||||
|
||||
> Query queryUpdateIdPost(id, queryUpdateIdPostRequest)
|
||||
|
||||
Update query
|
||||
|
||||
Update an existing query
|
||||
|
||||
### Example
|
||||
|
||||
```javascript
|
||||
import LowCodeEngineApi from 'low_code_engine_api';
|
||||
let defaultClient = LowCodeEngineApi.ApiClient.instance;
|
||||
// Configure API key authorization: QueryGuard
|
||||
let QueryGuard = defaultClient.authentications['QueryGuard'];
|
||||
QueryGuard.apiKey = 'YOUR API KEY';
|
||||
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
|
||||
//QueryGuard.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.QueriesApi();
|
||||
let id = "id_example"; // String | Query ID
|
||||
let queryUpdateIdPostRequest = new LowCodeEngineApi.QueryUpdateIdPostRequest(); // QueryUpdateIdPostRequest |
|
||||
apiInstance.queryUpdateIdPost(id, queryUpdateIdPostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**id** | **String**| Query ID |
|
||||
**queryUpdateIdPostRequest** | [**QueryUpdateIdPostRequest**](QueryUpdateIdPostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**Query**](Query.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
14
out/js/docs/Query.md
Normal file
14
out/js/docs/Query.md
Normal file
@ -0,0 +1,14 @@
|
||||
# LowCodeEngineApi.Query
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique query identifier | [optional]
|
||||
**source** | **String** | Query source code | [optional]
|
||||
**isActive** | **Number** | Whether the query is active (1 = active, 0 = inactive) | [optional]
|
||||
**isCommand** | **Number** | Whether this is a command (1 = command, 0 = query) | [optional]
|
||||
**project** | [**Project**](Project.md) | | [optional]
|
||||
**logs** | [**[Log]**](Log.md) | | [optional]
|
||||
|
||||
|
||||
9
out/js/docs/QueryCreatePostRequest.md
Normal file
9
out/js/docs/QueryCreatePostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.QueryCreatePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**source** | **String** | Query source code |
|
||||
|
||||
|
||||
9
out/js/docs/QueryUpdateIdPostRequest.md
Normal file
9
out/js/docs/QueryUpdateIdPostRequest.md
Normal file
@ -0,0 +1,9 @@
|
||||
# LowCodeEngineApi.QueryUpdateIdPostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**source** | **String** | Updated query source code | [optional]
|
||||
|
||||
|
||||
65
out/js/docs/RedisManagementApi.md
Normal file
65
out/js/docs/RedisManagementApi.md
Normal file
@ -0,0 +1,65 @@
|
||||
# LowCodeEngineApi.RedisManagementApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**redisNodeCreatePost**](RedisManagementApi.md#redisNodeCreatePost) | **POST** /redis/node/create | Add Redis node
|
||||
|
||||
|
||||
|
||||
## redisNodeCreatePost
|
||||
|
||||
> RedisNode redisNodeCreatePost(redisNodeCreatePostRequest)
|
||||
|
||||
Add Redis node
|
||||
|
||||
Add a new Redis node to the system
|
||||
|
||||
### 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.RedisManagementApi();
|
||||
let redisNodeCreatePostRequest = new LowCodeEngineApi.RedisNodeCreatePostRequest(); // RedisNodeCreatePostRequest |
|
||||
apiInstance.redisNodeCreatePost(redisNodeCreatePostRequest, (error, data, response) => {
|
||||
if (error) {
|
||||
console.error(error);
|
||||
} else {
|
||||
console.log('API called successfully. Returned data: ' + data);
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**redisNodeCreatePostRequest** | [**RedisNodeCreatePostRequest**](RedisNodeCreatePostRequest.md)| |
|
||||
|
||||
### Return type
|
||||
|
||||
[**RedisNode**](RedisNode.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
14
out/js/docs/RedisNode.md
Normal file
14
out/js/docs/RedisNode.md
Normal file
@ -0,0 +1,14 @@
|
||||
# LowCodeEngineApi.RedisNode
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **String** | Unique Redis node identifier | [optional]
|
||||
**host** | **String** | Redis host | [optional]
|
||||
**port** | **Number** | Redis port | [optional]
|
||||
**user** | **String** | Redis username | [optional]
|
||||
**password** | **String** | Redis password | [optional]
|
||||
**projects** | [**[Project]**](Project.md) | | [optional]
|
||||
|
||||
|
||||
12
out/js/docs/RedisNodeCreatePostRequest.md
Normal file
12
out/js/docs/RedisNodeCreatePostRequest.md
Normal file
@ -0,0 +1,12 @@
|
||||
# LowCodeEngineApi.RedisNodeCreatePostRequest
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**host** | **String** | Redis host |
|
||||
**port** | **Number** | Redis port |
|
||||
**user** | **String** | Redis username |
|
||||
**password** | **String** | Redis password |
|
||||
|
||||
|
||||
12
out/js/docs/Token.md
Normal file
12
out/js/docs/Token.md
Normal file
@ -0,0 +1,12 @@
|
||||
# LowCodeEngineApi.Token
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**token** | **String** | Unique token identifier | [optional]
|
||||
**isActive** | **Boolean** | Whether the token is active | [optional]
|
||||
**isAdmin** | **Boolean** | Whether the token has admin privileges | [optional]
|
||||
**project** | [**Project**](Project.md) | | [optional]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user