223 lines
11 KiB
Markdown
223 lines
11 KiB
Markdown
# low_code_engine_api
|
|
|
|
LowCodeEngineApi - JavaScript client for low_code_engine_api
|
|
API documentation for the Low-Code Engine platform that provides query execution, database management, and project administration capabilities.
|
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: 1.0.0
|
|
- Package version: 1.0.0
|
|
- Generator version: 7.17.0-SNAPSHOT
|
|
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
|
|
|
|
## Installation
|
|
|
|
### For [Node.js](https://nodejs.org/)
|
|
|
|
#### npm
|
|
|
|
To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
|
|
|
|
Then install it via:
|
|
|
|
```shell
|
|
npm install low_code_engine_api --save
|
|
```
|
|
|
|
Finally, you need to build the module:
|
|
|
|
```shell
|
|
npm run build
|
|
```
|
|
|
|
##### Local development
|
|
|
|
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
|
|
|
|
```shell
|
|
npm install
|
|
```
|
|
|
|
Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
|
|
|
|
```shell
|
|
npm link
|
|
```
|
|
|
|
To use the link you just defined in your project, switch to the directory you want to use your low_code_engine_api from, and run:
|
|
|
|
```shell
|
|
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
|
|
```
|
|
|
|
Finally, you need to build the module:
|
|
|
|
```shell
|
|
npm run build
|
|
```
|
|
|
|
#### git
|
|
|
|
If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
|
|
then install it via:
|
|
|
|
```shell
|
|
npm install GIT_USER_ID/GIT_REPO_ID --save
|
|
```
|
|
|
|
### For browser
|
|
|
|
The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
|
|
the above steps with Node.js and installing browserify with `npm install -g browserify`,
|
|
perform the following (assuming *main.js* is your entry file):
|
|
|
|
```shell
|
|
browserify main.js > bundle.js
|
|
```
|
|
|
|
Then include *bundle.js* in the HTML pages.
|
|
|
|
### Webpack Configuration
|
|
|
|
Using Webpack you may encounter the following error: "Module not found: Error:
|
|
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
|
|
the following section to your webpack config:
|
|
|
|
```javascript
|
|
module: {
|
|
rules: [
|
|
{
|
|
parser: {
|
|
amd: false
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
|
|
```javascript
|
|
var LowCodeEngineApi = require('low_code_engine_api');
|
|
|
|
var defaultClient = LowCodeEngineApi.ApiClient.instance;
|
|
// Configure API key authorization: AdminAuth
|
|
var 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['x-admin-token'] = "Token"
|
|
// Configure API key authorization: ApiKeyAuth
|
|
var 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['Authorization'] = "Token"
|
|
|
|
var api = new LowCodeEngineApi.APITokensApi()
|
|
var apiTokenGeneratePostRequest = new LowCodeEngineApi.ApiTokenGeneratePostRequest(); // {ApiTokenGeneratePostRequest}
|
|
var callback = function(error, data, response) {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully. Returned data: ' + data);
|
|
}
|
|
};
|
|
api.apiTokenGeneratePost(apiTokenGeneratePostRequest, callback);
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://localhost:3000*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*LowCodeEngineApi.APITokensApi* | [**apiTokenGeneratePost**](docs/APITokensApi.md#apiTokenGeneratePost) | **POST** /api/token/generate | Generate API token
|
|
*LowCodeEngineApi.APITokensApi* | [**apiTokenRevokeTokenDelete**](docs/APITokensApi.md#apiTokenRevokeTokenDelete) | **DELETE** /api/token/revoke/{token} | Revoke API token
|
|
*LowCodeEngineApi.CommandsApi* | [**commandCreatePost**](docs/CommandsApi.md#commandCreatePost) | **POST** /command/create | Create command
|
|
*LowCodeEngineApi.CommandsApi* | [**commandDeleteIdDelete**](docs/CommandsApi.md#commandDeleteIdDelete) | **DELETE** /command/delete/{id} | Delete command
|
|
*LowCodeEngineApi.CommandsApi* | [**commandRunIdPost**](docs/CommandsApi.md#commandRunIdPost) | **POST** /command/run/{id} | Run command
|
|
*LowCodeEngineApi.CommandsApi* | [**commandUpdateIdPost**](docs/CommandsApi.md#commandUpdateIdPost) | **POST** /command/update/{id} | Update command
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseColumnsDatabaseIdTableNameGet**](docs/DatabaseManagementApi.md#databaseColumnsDatabaseIdTableNameGet) | **GET** /database/columns/{databaseId}/{tableName} | Get table columns
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseCreatePost**](docs/DatabaseManagementApi.md#databaseCreatePost) | **POST** /database/create | Create database
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseMigrationCreatePost**](docs/DatabaseManagementApi.md#databaseMigrationCreatePost) | **POST** /database/migration/create | Create migration
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseMigrationDownDatabaseIdGet**](docs/DatabaseManagementApi.md#databaseMigrationDownDatabaseIdGet) | **GET** /database/migration/down/{databaseId} | Run migrations down
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseMigrationUpDatabaseIdGet**](docs/DatabaseManagementApi.md#databaseMigrationUpDatabaseIdGet) | **GET** /database/migration/up/{databaseId} | Run migrations up
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseNodeCreatePost**](docs/DatabaseManagementApi.md#databaseNodeCreatePost) | **POST** /database/node/create | Add database node
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseQueryDatabaseIdPost**](docs/DatabaseManagementApi.md#databaseQueryDatabaseIdPost) | **POST** /database/query/{databaseId} | Run database query
|
|
*LowCodeEngineApi.DatabaseManagementApi* | [**databaseTablesDatabaseIdGet**](docs/DatabaseManagementApi.md#databaseTablesDatabaseIdGet) | **GET** /database/tables/{databaseId} | Get database tables
|
|
*LowCodeEngineApi.FunctionsApi* | [**functionsCreatePost**](docs/FunctionsApi.md#functionsCreatePost) | **POST** /functions/create | Create function
|
|
*LowCodeEngineApi.FunctionsApi* | [**functionsDeletePost**](docs/FunctionsApi.md#functionsDeletePost) | **POST** /functions/delete | Delete function
|
|
*LowCodeEngineApi.LoggingApi* | [**loggerIdFindAllPost**](docs/LoggingApi.md#loggerIdFindAllPost) | **POST** /logger/{id}/findAll | Find all logs
|
|
*LowCodeEngineApi.LoggingApi* | [**loggerIdFindPost**](docs/LoggingApi.md#loggerIdFindPost) | **POST** /logger/{id}/find | Find logs for query
|
|
*LowCodeEngineApi.LoggingApi* | [**loggerIdTraceIdGet**](docs/LoggingApi.md#loggerIdTraceIdGet) | **GET** /logger/{id}/{traceId} | Get log by trace ID
|
|
*LowCodeEngineApi.ProjectManagementApi* | [**projectApiTokensGet**](docs/ProjectManagementApi.md#projectApiTokensGet) | **GET** /project/api-tokens | Get all API tokens
|
|
*LowCodeEngineApi.ProjectManagementApi* | [**projectCreatePut**](docs/ProjectManagementApi.md#projectCreatePut) | **PUT** /project/create | Create project
|
|
*LowCodeEngineApi.ProjectManagementApi* | [**projectCreateWithoutDbPut**](docs/ProjectManagementApi.md#projectCreateWithoutDbPut) | **PUT** /project/create-without-db | Create project without database
|
|
*LowCodeEngineApi.ProjectManagementApi* | [**projectSettingsCreatePut**](docs/ProjectManagementApi.md#projectSettingsCreatePut) | **PUT** /project/settings/create | Create project setting
|
|
*LowCodeEngineApi.ProjectManagementApi* | [**projectSettingsDeleteKeyDelete**](docs/ProjectManagementApi.md#projectSettingsDeleteKeyDelete) | **DELETE** /project/settings/delete/{key} | Delete project setting
|
|
*LowCodeEngineApi.ProjectManagementApi* | [**projectSettingsGet**](docs/ProjectManagementApi.md#projectSettingsGet) | **GET** /project/settings | Get all project settings
|
|
*LowCodeEngineApi.QueriesApi* | [**queryCreatePost**](docs/QueriesApi.md#queryCreatePost) | **POST** /query/create | Create query
|
|
*LowCodeEngineApi.QueriesApi* | [**queryDeleteIdDelete**](docs/QueriesApi.md#queryDeleteIdDelete) | **DELETE** /query/delete/{id} | Delete query
|
|
*LowCodeEngineApi.QueriesApi* | [**queryRunIdPost**](docs/QueriesApi.md#queryRunIdPost) | **POST** /query/run/{id} | Run query
|
|
*LowCodeEngineApi.QueriesApi* | [**queryUpdateIdPost**](docs/QueriesApi.md#queryUpdateIdPost) | **POST** /query/update/{id} | Update query
|
|
*LowCodeEngineApi.RedisManagementApi* | [**redisNodeCreatePost**](docs/RedisManagementApi.md#redisNodeCreatePost) | **POST** /redis/node/create | Add Redis node
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [LowCodeEngineApi.ApiTokenGeneratePostRequest](docs/ApiTokenGeneratePostRequest.md)
|
|
- [LowCodeEngineApi.CommandCreatePostRequest](docs/CommandCreatePostRequest.md)
|
|
- [LowCodeEngineApi.CommandUpdateIdPostRequest](docs/CommandUpdateIdPostRequest.md)
|
|
- [LowCodeEngineApi.Database](docs/Database.md)
|
|
- [LowCodeEngineApi.DatabaseCreatePostRequest](docs/DatabaseCreatePostRequest.md)
|
|
- [LowCodeEngineApi.DatabaseMigrationCreatePostRequest](docs/DatabaseMigrationCreatePostRequest.md)
|
|
- [LowCodeEngineApi.DatabaseNode](docs/DatabaseNode.md)
|
|
- [LowCodeEngineApi.DatabaseNodeCreatePostRequest](docs/DatabaseNodeCreatePostRequest.md)
|
|
- [LowCodeEngineApi.DatabaseQueryDatabaseIdPostRequest](docs/DatabaseQueryDatabaseIdPostRequest.md)
|
|
- [LowCodeEngineApi.Error](docs/Error.md)
|
|
- [LowCodeEngineApi.Function](docs/Function.md)
|
|
- [LowCodeEngineApi.FunctionsCreatePostRequest](docs/FunctionsCreatePostRequest.md)
|
|
- [LowCodeEngineApi.FunctionsDeletePostRequest](docs/FunctionsDeletePostRequest.md)
|
|
- [LowCodeEngineApi.Log](docs/Log.md)
|
|
- [LowCodeEngineApi.LogContentInner](docs/LogContentInner.md)
|
|
- [LowCodeEngineApi.LoggerIdFindAllPostRequest](docs/LoggerIdFindAllPostRequest.md)
|
|
- [LowCodeEngineApi.Migration](docs/Migration.md)
|
|
- [LowCodeEngineApi.Project](docs/Project.md)
|
|
- [LowCodeEngineApi.ProjectCreatePutRequest](docs/ProjectCreatePutRequest.md)
|
|
- [LowCodeEngineApi.ProjectSetting](docs/ProjectSetting.md)
|
|
- [LowCodeEngineApi.ProjectSettingsCreatePutRequest](docs/ProjectSettingsCreatePutRequest.md)
|
|
- [LowCodeEngineApi.Query](docs/Query.md)
|
|
- [LowCodeEngineApi.QueryCreatePostRequest](docs/QueryCreatePostRequest.md)
|
|
- [LowCodeEngineApi.QueryUpdateIdPostRequest](docs/QueryUpdateIdPostRequest.md)
|
|
- [LowCodeEngineApi.RedisNode](docs/RedisNode.md)
|
|
- [LowCodeEngineApi.RedisNodeCreatePostRequest](docs/RedisNodeCreatePostRequest.md)
|
|
- [LowCodeEngineApi.Token](docs/Token.md)
|
|
|
|
|
|
## Documentation for Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
### ApiKeyAuth
|
|
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: Authorization
|
|
- **Location**: HTTP header
|
|
|
|
### AdminAuth
|
|
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: x-admin-token
|
|
- **Location**: HTTP header
|
|
|
|
### QueryGuard
|
|
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: x-query-access
|
|
- **Location**: HTTP header
|
|
|