few-line-engine/out/js/README.md

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 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

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install low_code_engine_api --save

Finally, you need to build the module:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

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:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

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:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. 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):

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:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

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	POST /api/token/generate	Generate API token
LowCodeEngineApi.APITokensApi	apiTokenRevokeTokenDelete	DELETE /api/token/revoke/{token}	Revoke API token
LowCodeEngineApi.CommandsApi	commandCreatePost	POST /command/create	Create command
LowCodeEngineApi.CommandsApi	commandDeleteIdDelete	DELETE /command/delete/{id}	Delete command
LowCodeEngineApi.CommandsApi	commandRunIdPost	POST /command/run/{id}	Run command
LowCodeEngineApi.CommandsApi	commandUpdateIdPost	POST /command/update/{id}	Update command
LowCodeEngineApi.DatabaseManagementApi	databaseColumnsDatabaseIdTableNameGet	GET /database/columns/{databaseId}/{tableName}	Get table columns
LowCodeEngineApi.DatabaseManagementApi	databaseCreatePost	POST /database/create	Create database
LowCodeEngineApi.DatabaseManagementApi	databaseMigrationCreatePost	POST /database/migration/create	Create migration
LowCodeEngineApi.DatabaseManagementApi	databaseMigrationDownDatabaseIdGet	GET /database/migration/down/{databaseId}	Run migrations down
LowCodeEngineApi.DatabaseManagementApi	databaseMigrationUpDatabaseIdGet	GET /database/migration/up/{databaseId}	Run migrations up
LowCodeEngineApi.DatabaseManagementApi	databaseNodeCreatePost	POST /database/node/create	Add database node
LowCodeEngineApi.DatabaseManagementApi	databaseQueryDatabaseIdPost	POST /database/query/{databaseId}	Run database query
LowCodeEngineApi.DatabaseManagementApi	databaseTablesDatabaseIdGet	GET /database/tables/{databaseId}	Get database tables
LowCodeEngineApi.FunctionsApi	functionsCreatePost	POST /functions/create	Create function
LowCodeEngineApi.FunctionsApi	functionsDeletePost	POST /functions/delete	Delete function
LowCodeEngineApi.LoggingApi	loggerIdFindAllPost	POST /logger/{id}/findAll	Find all logs
LowCodeEngineApi.LoggingApi	loggerIdFindPost	POST /logger/{id}/find	Find logs for query
LowCodeEngineApi.LoggingApi	loggerIdTraceIdGet	GET /logger/{id}/{traceId}	Get log by trace ID
LowCodeEngineApi.ProjectManagementApi	projectApiTokensGet	GET /project/api-tokens	Get all API tokens
LowCodeEngineApi.ProjectManagementApi	projectCreatePut	PUT /project/create	Create project
LowCodeEngineApi.ProjectManagementApi	projectCreateWithoutDbPut	PUT /project/create-without-db	Create project without database
LowCodeEngineApi.ProjectManagementApi	projectSettingsCreatePut	PUT /project/settings/create	Create project setting
LowCodeEngineApi.ProjectManagementApi	projectSettingsDeleteKeyDelete	DELETE /project/settings/delete/{key}	Delete project setting
LowCodeEngineApi.ProjectManagementApi	projectSettingsGet	GET /project/settings	Get all project settings
LowCodeEngineApi.QueriesApi	queryCreatePost	POST /query/create	Create query
LowCodeEngineApi.QueriesApi	queryDeleteIdDelete	DELETE /query/delete/{id}	Delete query
LowCodeEngineApi.QueriesApi	queryRunIdPost	POST /query/run/{id}	Run query
LowCodeEngineApi.QueriesApi	queryUpdateIdPost	POST /query/update/{id}	Update query
LowCodeEngineApi.RedisManagementApi	redisNodeCreatePost	POST /redis/node/create	Add Redis node

Documentation for Models

• LowCodeEngineApi.ApiTokenGeneratePostRequest
• LowCodeEngineApi.CommandCreatePostRequest
• LowCodeEngineApi.CommandUpdateIdPostRequest
• LowCodeEngineApi.Database
• LowCodeEngineApi.DatabaseCreatePostRequest
• LowCodeEngineApi.DatabaseMigrationCreatePostRequest
• LowCodeEngineApi.DatabaseNode
• LowCodeEngineApi.DatabaseNodeCreatePostRequest
• LowCodeEngineApi.DatabaseQueryDatabaseIdPostRequest
• LowCodeEngineApi.Error
• LowCodeEngineApi.Function
• LowCodeEngineApi.FunctionsCreatePostRequest
• LowCodeEngineApi.FunctionsDeletePostRequest
• LowCodeEngineApi.Log
• LowCodeEngineApi.LogContentInner
• LowCodeEngineApi.LoggerIdFindAllPostRequest
• LowCodeEngineApi.Migration
• LowCodeEngineApi.Project
• LowCodeEngineApi.ProjectCreatePutRequest
• LowCodeEngineApi.ProjectSetting
• LowCodeEngineApi.ProjectSettingsCreatePutRequest
• LowCodeEngineApi.Query
• LowCodeEngineApi.QueryCreatePostRequest
• LowCodeEngineApi.QueryUpdateIdPostRequest
• LowCodeEngineApi.RedisNode
• LowCodeEngineApi.RedisNodeCreatePostRequest
• LowCodeEngineApi.Token

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