Add API documentation and models for Functions, Logs, Projects, Queries, and Redis Management

- Created documentation for FunctionsCreatePostRequest and FunctionsDeletePostRequest.
- Added Log and LogContentInner models with corresponding documentation.
- Introduced LoggerIdFindAllPostRequest and LoggingApi for log management.
- Added Migration and Project models with their respective documentation.
- Implemented ProjectCreatePutRequest and ProjectManagementApi for project management.
- Created Query and QueryCreatePostRequest models with documentation.
- Added RedisNode and RedisNodeCreatePostRequest for Redis management.
- Included Token model for API token management.
- Added a script for git push operations and updated index.ts for API exports.
This commit is contained in:
lborv
2025-10-25 17:50:15 +03:00
parent 0180c4115c
commit 66a461f12a
47 changed files with 7123 additions and 0 deletions

1341
openapi.yaml Normal file

File diff suppressed because it is too large Load Diff

4
out/ts/.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
wwwroot/*.js
node_modules
typings
dist

1
out/ts/.npmignore Normal file
View File

@ -0,0 +1 @@
# empty npmignore to ensure all required files (e.g., in the dist folder) are published by npm

View File

@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.
# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md

View File

@ -0,0 +1,44 @@
.gitignore
.npmignore
.openapi-generator-ignore
api.ts
base.ts
common.ts
configuration.ts
docs/APITokensApi.md
docs/ApiTokenGeneratePostRequest.md
docs/CommandCreatePostRequest.md
docs/CommandUpdateIdPostRequest.md
docs/CommandsApi.md
docs/Database.md
docs/DatabaseCreatePostRequest.md
docs/DatabaseManagementApi.md
docs/DatabaseMigrationCreatePostRequest.md
docs/DatabaseNode.md
docs/DatabaseNodeCreatePostRequest.md
docs/DatabaseQueryDatabaseIdPostRequest.md
docs/Error.md
docs/Function.md
docs/FunctionsApi.md
docs/FunctionsCreatePostRequest.md
docs/FunctionsDeletePostRequest.md
docs/Log.md
docs/LogContentInner.md
docs/LoggerIdFindAllPostRequest.md
docs/LoggingApi.md
docs/Migration.md
docs/Project.md
docs/ProjectCreatePutRequest.md
docs/ProjectManagementApi.md
docs/ProjectSetting.md
docs/ProjectSettingsCreatePutRequest.md
docs/QueriesApi.md
docs/Query.md
docs/QueryCreatePostRequest.md
docs/QueryUpdateIdPostRequest.md
docs/RedisManagementApi.md
docs/RedisNode.md
docs/RedisNodeCreatePostRequest.md
docs/Token.md
git_push.sh
index.ts

View File

@ -0,0 +1 @@
7.17.0-SNAPSHOT

2944
out/ts/api.ts Normal file

File diff suppressed because it is too large Load Diff

62
out/ts/base.ts Normal file
View File

@ -0,0 +1,62 @@
/* tslint:disable */
/* eslint-disable */
/**
* Low-Code Engine API
* API documentation for the Low-Code Engine platform that provides query execution, database management, and project administration capabilities.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from './configuration';
// Some imports not used depending on template conditions
// @ts-ignore
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import globalAxios from 'axios';
export const BASE_PATH = "http://localhost:3000".replace(/\/+$/, "");
export const COLLECTION_FORMATS = {
csv: ",",
ssv: " ",
tsv: "\t",
pipes: "|",
};
export interface RequestArgs {
url: string;
options: RawAxiosRequestConfig;
}
export class BaseAPI {
protected configuration: Configuration | undefined;
constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
if (configuration) {
this.configuration = configuration;
this.basePath = configuration.basePath ?? basePath;
}
}
};
export class RequiredError extends Error {
constructor(public field: string, msg?: string) {
super(msg);
this.name = "RequiredError"
}
}
interface ServerMap {
[key: string]: {
url: string,
description: string,
}[];
}
export const operationServerMap: ServerMap = {
}

113
out/ts/common.ts Normal file
View File

@ -0,0 +1,113 @@
/* tslint:disable */
/* eslint-disable */
/**
* Low-Code Engine API
* API documentation for the Low-Code Engine platform that provides query execution, database management, and project administration capabilities.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from "./configuration";
import type { RequestArgs } from "./base";
import type { AxiosInstance, AxiosResponse } from 'axios';
import { RequiredError } from "./base";
export const DUMMY_BASE_URL = 'https://example.com'
/**
*
* @throws {RequiredError}
*/
export const assertParamExists = function (functionName: string, paramName: string, paramValue: unknown) {
if (paramValue === null || paramValue === undefined) {
throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
}
}
export const setApiKeyToObject = async function (object: any, keyParamName: string, configuration?: Configuration) {
if (configuration && configuration.apiKey) {
const localVarApiKeyValue = typeof configuration.apiKey === 'function'
? await configuration.apiKey(keyParamName)
: await configuration.apiKey;
object[keyParamName] = localVarApiKeyValue;
}
}
export const setBasicAuthToObject = function (object: any, configuration?: Configuration) {
if (configuration && (configuration.username || configuration.password)) {
object["auth"] = { username: configuration.username, password: configuration.password };
}
}
export const setBearerAuthToObject = async function (object: any, configuration?: Configuration) {
if (configuration && configuration.accessToken) {
const accessToken = typeof configuration.accessToken === 'function'
? await configuration.accessToken()
: await configuration.accessToken;
object["Authorization"] = "Bearer " + accessToken;
}
}
export const setOAuthToObject = async function (object: any, name: string, scopes: string[], configuration?: Configuration) {
if (configuration && configuration.accessToken) {
const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
? await configuration.accessToken(name, scopes)
: await configuration.accessToken;
object["Authorization"] = "Bearer " + localVarAccessTokenValue;
}
}
function setFlattenedQueryParams(urlSearchParams: URLSearchParams, parameter: any, key: string = ""): void {
if (parameter == null) return;
if (typeof parameter === "object") {
if (Array.isArray(parameter)) {
(parameter as any[]).forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
}
else {
Object.keys(parameter).forEach(currentKey =>
setFlattenedQueryParams(urlSearchParams, parameter[currentKey], `${key}${key !== '' ? '.' : ''}${currentKey}`)
);
}
}
else {
if (urlSearchParams.has(key)) {
urlSearchParams.append(key, parameter);
}
else {
urlSearchParams.set(key, parameter);
}
}
}
export const setSearchParams = function (url: URL, ...objects: any[]) {
const searchParams = new URLSearchParams(url.search);
setFlattenedQueryParams(searchParams, objects);
url.search = searchParams.toString();
}
export const serializeDataIfNeeded = function (value: any, requestOptions: any, configuration?: Configuration) {
const nonString = typeof value !== 'string';
const needsSerialization = nonString && configuration && configuration.isJsonMime
? configuration.isJsonMime(requestOptions.headers['Content-Type'])
: nonString;
return needsSerialization
? JSON.stringify(value !== undefined ? value : {})
: (value || "");
}
export const toPathString = function (url: URL) {
return url.pathname + url.search + url.hash
}
export const createRequestFunction = function (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) {
return <T = unknown, R = AxiosResponse<T>>(axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => {
const axiosRequestArgs = {...axiosArgs.options, url: (axios.defaults.baseURL ? '' : configuration?.basePath ?? basePath) + axiosArgs.url};
return axios.request<T, R>(axiosRequestArgs);
};
}

121
out/ts/configuration.ts Normal file
View File

@ -0,0 +1,121 @@
/* tslint:disable */
/**
* Low-Code Engine API
* API documentation for the Low-Code Engine platform that provides query execution, database management, and project administration capabilities.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
interface AWSv4Configuration {
options?: {
region?: string
service?: string
}
credentials?: {
accessKeyId?: string
secretAccessKey?: string,
sessionToken?: string
}
}
export interface ConfigurationParameters {
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
username?: string;
password?: string;
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
awsv4?: AWSv4Configuration;
basePath?: string;
serverIndex?: number;
baseOptions?: any;
formDataCtor?: new () => any;
}
export class Configuration {
/**
* parameter for apiKey security
* @param name security name
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*/
username?: string;
/**
* parameter for basic security
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* parameter for aws4 signature security
* @param {Object} AWS4Signature - AWS4 Signature security
* @param {string} options.region - aws region
* @param {string} options.service - name of the service.
* @param {string} credentials.accessKeyId - aws access key id
* @param {string} credentials.secretAccessKey - aws access key
* @param {string} credentials.sessionToken - aws session token
* @memberof Configuration
*/
awsv4?: AWSv4Configuration;
/**
* override base path
*/
basePath?: string;
/**
* override server index
*/
serverIndex?: number;
/**
* base options for axios calls
*/
baseOptions?: any;
/**
* The FormData constructor that will be used to create multipart form data
* requests. You can inject this here so that execution environments that
* do not support the FormData class can still run the generated client.
*
* @type {new () => FormData}
*/
formDataCtor?: new () => any;
constructor(param: ConfigurationParameters = {}) {
this.apiKey = param.apiKey;
this.username = param.username;
this.password = param.password;
this.accessToken = param.accessToken;
this.awsv4 = param.awsv4;
this.basePath = param.basePath;
this.serverIndex = param.serverIndex;
this.baseOptions = {
...param.baseOptions,
headers: {
...param.baseOptions?.headers,
},
};
this.formDataCtor = param.formDataCtor;
}
/**
* Check if the given MIME is a JSON MIME.
* JSON MIME examples:
* application/json
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
* @param mime - MIME (Multipurpose Internet Mail Extensions)
* @return True if the given MIME is JSON, false otherwise.
*/
public isJsonMime(mime: string): boolean {
const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
}
}

118
out/ts/docs/APITokensApi.md Normal file
View File

@ -0,0 +1,118 @@
# APITokensApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**apiTokenGeneratePost**](#apitokengeneratepost) | **POST** /api/token/generate | Generate API token|
|[**apiTokenRevokeTokenDelete**](#apitokenrevoketokendelete) | **DELETE** /api/token/revoke/{token} | Revoke API token|
# **apiTokenGeneratePost**
> Token apiTokenGeneratePost(apiTokenGeneratePostRequest)
Generate a new API token for a project
### Example
```typescript
import {
APITokensApi,
Configuration,
ApiTokenGeneratePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new APITokensApi(configuration);
let apiTokenGeneratePostRequest: ApiTokenGeneratePostRequest; //
const { status, data } = await apiInstance.apiTokenGeneratePost(
apiTokenGeneratePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **apiTokenGeneratePostRequest** | **ApiTokenGeneratePostRequest**| | |
### Return type
**Token**
### Authorization
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Token generated successfully | - |
|**400** | Project ID is required | - |
|**401** | Unauthorized | - |
|**403** | Admin access required | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **apiTokenRevokeTokenDelete**
> apiTokenRevokeTokenDelete()
Revoke an existing API token
### Example
```typescript
import {
APITokensApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new APITokensApi(configuration);
let token: string; //Token to revoke (default to undefined)
const { status, data } = await apiInstance.apiTokenRevokeTokenDelete(
token
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **token** | [**string**] | Token to revoke | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Token revoked successfully | - |
|**401** | Unauthorized | - |
|**403** | Admin access required | - |
|**404** | Token not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# ApiTokenGeneratePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Project ID | [default to undefined]
## Example
```typescript
import { ApiTokenGeneratePostRequest } from './api';
const instance: ApiTokenGeneratePostRequest = {
id,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# CommandCreatePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **string** | Command source code | [default to undefined]
## Example
```typescript
import { CommandCreatePostRequest } from './api';
const instance: CommandCreatePostRequest = {
source,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# CommandUpdateIdPostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **string** | Updated command source code | [optional] [default to undefined]
## Example
```typescript
import { CommandUpdateIdPostRequest } from './api';
const instance: CommandUpdateIdPostRequest = {
source,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

238
out/ts/docs/CommandsApi.md Normal file
View File

@ -0,0 +1,238 @@
# CommandsApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**commandCreatePost**](#commandcreatepost) | **POST** /command/create | Create command|
|[**commandDeleteIdDelete**](#commanddeleteiddelete) | **DELETE** /command/delete/{id} | Delete command|
|[**commandRunIdPost**](#commandrunidpost) | **POST** /command/run/{id} | Run command|
|[**commandUpdateIdPost**](#commandupdateidpost) | **POST** /command/update/{id} | Update command|
# **commandCreatePost**
> Query commandCreatePost(commandCreatePostRequest)
Create a new command in the project
### Example
```typescript
import {
CommandsApi,
Configuration,
CommandCreatePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);
let commandCreatePostRequest: CommandCreatePostRequest; //
const { status, data } = await apiInstance.commandCreatePost(
commandCreatePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **commandCreatePostRequest** | **CommandCreatePostRequest**| | |
### Return type
**Query**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Command created successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **commandDeleteIdDelete**
> commandDeleteIdDelete()
Delete an existing command
### Example
```typescript
import {
CommandsApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);
let id: string; //Command ID (default to undefined)
const { status, data } = await apiInstance.commandDeleteIdDelete(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Command ID | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Command deleted successfully | - |
|**401** | Unauthorized | - |
|**403** | Query access required | - |
|**404** | Command not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **commandRunIdPost**
> object commandRunIdPost(body)
Execute a command with provided data
### Example
```typescript
import {
CommandsApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);
let id: string; //Command ID (default to undefined)
let body: object; //
let xTraceId: string; //Trace ID for logging (optional) (default to undefined)
const { status, data } = await apiInstance.commandRunIdPost(
id,
body,
xTraceId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **object**| | |
| **id** | [**string**] | Command ID | defaults to undefined|
| **xTraceId** | [**string**] | Trace ID for logging | (optional) defaults to undefined|
### Return type
**object**
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Command executed successfully | - |
|**302** | Redirect response | - |
|**401** | Unauthorized | - |
|**403** | Query access required | - |
|**404** | Command not found | - |
|**500** | Internal Server Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **commandUpdateIdPost**
> Query commandUpdateIdPost(commandUpdateIdPostRequest)
Update an existing command
### Example
```typescript
import {
CommandsApi,
Configuration,
CommandUpdateIdPostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);
let id: string; //Command ID (default to undefined)
let commandUpdateIdPostRequest: CommandUpdateIdPostRequest; //
const { status, data } = await apiInstance.commandUpdateIdPost(
id,
commandUpdateIdPostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **commandUpdateIdPostRequest** | **CommandUpdateIdPostRequest**| | |
| **id** | [**string**] | Command ID | defaults to undefined|
### Return type
**Query**
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Command updated successfully | - |
|**401** | Unauthorized | - |
|**403** | Query access required | - |
|**404** | Command not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

34
out/ts/docs/Database.md Normal file
View File

@ -0,0 +1,34 @@
# Database
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique database identifier | [optional] [default to undefined]
**q_username** | **string** | Query username for database access | [optional] [default to undefined]
**c_username** | **string** | Command username for database access | [optional] [default to undefined]
**password** | **string** | Database password | [optional] [default to undefined]
**database** | **string** | Database name | [optional] [default to undefined]
**migrations** | [**Array&lt;Migration&gt;**](Migration.md) | | [optional] [default to undefined]
**project** | [**Project**](Project.md) | | [optional] [default to undefined]
**node** | [**DatabaseNode**](DatabaseNode.md) | | [optional] [default to undefined]
## Example
```typescript
import { Database } from './api';
const instance: Database = {
id,
q_username,
c_username,
password,
database,
migrations,
project,
node,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# DatabaseCreatePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**projectId** | **string** | Project ID | [default to undefined]
## Example
```typescript
import { DatabaseCreatePostRequest } from './api';
const instance: DatabaseCreatePostRequest = {
projectId,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,448 @@
# DatabaseManagementApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**databaseColumnsDatabaseIdTableNameGet**](#databasecolumnsdatabaseidtablenameget) | **GET** /database/columns/{databaseId}/{tableName} | Get table columns|
|[**databaseCreatePost**](#databasecreatepost) | **POST** /database/create | Create database|
|[**databaseMigrationCreatePost**](#databasemigrationcreatepost) | **POST** /database/migration/create | Create migration|
|[**databaseMigrationDownDatabaseIdGet**](#databasemigrationdowndatabaseidget) | **GET** /database/migration/down/{databaseId} | Run migrations down|
|[**databaseMigrationUpDatabaseIdGet**](#databasemigrationupdatabaseidget) | **GET** /database/migration/up/{databaseId} | Run migrations up|
|[**databaseNodeCreatePost**](#databasenodecreatepost) | **POST** /database/node/create | Add database node|
|[**databaseQueryDatabaseIdPost**](#databasequerydatabaseidpost) | **POST** /database/query/{databaseId} | Run database query|
|[**databaseTablesDatabaseIdGet**](#databasetablesdatabaseidget) | **GET** /database/tables/{databaseId} | Get database tables|
# **databaseColumnsDatabaseIdTableNameGet**
> Array<object> databaseColumnsDatabaseIdTableNameGet()
Retrieve columns information for a specific table
### Example
```typescript
import {
DatabaseManagementApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseId: string; //Database ID (default to undefined)
let tableName: string; //Table name (default to undefined)
const { status, data } = await apiInstance.databaseColumnsDatabaseIdTableNameGet(
databaseId,
tableName
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseId** | [**string**] | Database ID | defaults to undefined|
| **tableName** | [**string**] | Table name | defaults to undefined|
### Return type
**Array<object>**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Columns retrieved successfully | - |
|**401** | Unauthorized | - |
|**404** | Database or table not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **databaseCreatePost**
> Database databaseCreatePost(databaseCreatePostRequest)
Create a new database for a project
### Example
```typescript
import {
DatabaseManagementApi,
Configuration,
DatabaseCreatePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseCreatePostRequest: DatabaseCreatePostRequest; //
const { status, data } = await apiInstance.databaseCreatePost(
databaseCreatePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseCreatePostRequest** | **DatabaseCreatePostRequest**| | |
### Return type
**Database**
### Authorization
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Database created successfully | - |
|**401** | Unauthorized | - |
|**403** | Admin access required | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **databaseMigrationCreatePost**
> Migration databaseMigrationCreatePost(databaseMigrationCreatePostRequest)
Create a new database migration
### Example
```typescript
import {
DatabaseManagementApi,
Configuration,
DatabaseMigrationCreatePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseMigrationCreatePostRequest: DatabaseMigrationCreatePostRequest; //
const { status, data } = await apiInstance.databaseMigrationCreatePost(
databaseMigrationCreatePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseMigrationCreatePostRequest** | **DatabaseMigrationCreatePostRequest**| | |
### Return type
**Migration**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Migration created successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **databaseMigrationDownDatabaseIdGet**
> databaseMigrationDownDatabaseIdGet()
Rollback database migrations
### Example
```typescript
import {
DatabaseManagementApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseId: string; //Database ID (default to undefined)
const { status, data } = await apiInstance.databaseMigrationDownDatabaseIdGet(
databaseId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseId** | [**string**] | Database ID | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Migrations rolled back successfully | - |
|**401** | Unauthorized | - |
|**404** | Database not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **databaseMigrationUpDatabaseIdGet**
> databaseMigrationUpDatabaseIdGet()
Execute pending database migrations
### Example
```typescript
import {
DatabaseManagementApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseId: string; //Database ID (default to undefined)
const { status, data } = await apiInstance.databaseMigrationUpDatabaseIdGet(
databaseId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseId** | [**string**] | Database ID | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Migrations executed successfully | - |
|**401** | Unauthorized | - |
|**404** | Database not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **databaseNodeCreatePost**
> DatabaseNode databaseNodeCreatePost(databaseNodeCreatePostRequest)
Add a new database node to the system
### Example
```typescript
import {
DatabaseManagementApi,
Configuration,
DatabaseNodeCreatePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseNodeCreatePostRequest: DatabaseNodeCreatePostRequest; //
const { status, data } = await apiInstance.databaseNodeCreatePost(
databaseNodeCreatePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseNodeCreatePostRequest** | **DatabaseNodeCreatePostRequest**| | |
### Return type
**DatabaseNode**
### Authorization
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Database node created successfully | - |
|**401** | Unauthorized | - |
|**403** | Admin access required | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **databaseQueryDatabaseIdPost**
> object databaseQueryDatabaseIdPost(databaseQueryDatabaseIdPostRequest)
Execute a SQL query on the database
### Example
```typescript
import {
DatabaseManagementApi,
Configuration,
DatabaseQueryDatabaseIdPostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseId: string; //Database ID (default to undefined)
let databaseQueryDatabaseIdPostRequest: DatabaseQueryDatabaseIdPostRequest; //
const { status, data } = await apiInstance.databaseQueryDatabaseIdPost(
databaseId,
databaseQueryDatabaseIdPostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseQueryDatabaseIdPostRequest** | **DatabaseQueryDatabaseIdPostRequest**| | |
| **databaseId** | [**string**] | Database ID | defaults to undefined|
### Return type
**object**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query executed successfully | - |
|**401** | Unauthorized | - |
|**404** | Database not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **databaseTablesDatabaseIdGet**
> Array<string> databaseTablesDatabaseIdGet()
Retrieve list of tables in a database
### Example
```typescript
import {
DatabaseManagementApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new DatabaseManagementApi(configuration);
let databaseId: string; //Database ID (default to undefined)
const { status, data } = await apiInstance.databaseTablesDatabaseIdGet(
databaseId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **databaseId** | [**string**] | Database ID | defaults to undefined|
### Return type
**Array<string>**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Tables retrieved successfully | - |
|**401** | Unauthorized | - |
|**404** | Database not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@ -0,0 +1,24 @@
# DatabaseMigrationCreatePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**up** | **string** | Migration up SQL | [default to undefined]
**down** | **string** | Migration down SQL | [default to undefined]
**databaseId** | **string** | Database ID | [default to undefined]
## Example
```typescript
import { DatabaseMigrationCreatePostRequest } from './api';
const instance: DatabaseMigrationCreatePostRequest = {
up,
down,
databaseId,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# DatabaseNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique database node identifier | [optional] [default to undefined]
**host** | **string** | Database host | [optional] [default to undefined]
**port** | **number** | Database port | [optional] [default to undefined]
**username** | **string** | Database username | [optional] [default to undefined]
**password** | **string** | Database password | [optional] [default to undefined]
**databases** | [**Array&lt;Database&gt;**](Database.md) | | [optional] [default to undefined]
## Example
```typescript
import { DatabaseNode } from './api';
const instance: DatabaseNode = {
id,
host,
port,
username,
password,
databases,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,26 @@
# DatabaseNodeCreatePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**host** | **string** | Database host | [default to undefined]
**port** | **number** | Database port | [default to undefined]
**username** | **string** | Database username | [default to undefined]
**password** | **string** | Database password | [default to undefined]
## Example
```typescript
import { DatabaseNodeCreatePostRequest } from './api';
const instance: DatabaseNodeCreatePostRequest = {
host,
port,
username,
password,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# DatabaseQueryDatabaseIdPostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**query** | **string** | SQL query to execute | [default to undefined]
## Example
```typescript
import { DatabaseQueryDatabaseIdPostRequest } from './api';
const instance: DatabaseQueryDatabaseIdPostRequest = {
query,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

22
out/ts/docs/Error.md Normal file
View File

@ -0,0 +1,22 @@
# ModelError
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**error** | **string** | Error message | [optional] [default to undefined]
**details** | **string** | Error details | [optional] [default to undefined]
## Example
```typescript
import { ModelError } from './api';
const instance: ModelError = {
error,
details,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

26
out/ts/docs/Function.md Normal file
View File

@ -0,0 +1,26 @@
# Function
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique function identifier | [optional] [default to undefined]
**name** | **string** | Function name | [optional] [default to undefined]
**source** | **string** | Function source code | [optional] [default to undefined]
**project** | [**Project**](Project.md) | | [optional] [default to undefined]
## Example
```typescript
import { Function } from './api';
const instance: Function = {
id,
name,
source,
project,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

116
out/ts/docs/FunctionsApi.md Normal file
View File

@ -0,0 +1,116 @@
# FunctionsApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**functionsCreatePost**](#functionscreatepost) | **POST** /functions/create | Create function|
|[**functionsDeletePost**](#functionsdeletepost) | **POST** /functions/delete | Delete function|
# **functionsCreatePost**
> Function functionsCreatePost(functionsCreatePostRequest)
Create a new function in the project
### Example
```typescript
import {
FunctionsApi,
Configuration,
FunctionsCreatePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new FunctionsApi(configuration);
let functionsCreatePostRequest: FunctionsCreatePostRequest; //
const { status, data } = await apiInstance.functionsCreatePost(
functionsCreatePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **functionsCreatePostRequest** | **FunctionsCreatePostRequest**| | |
### Return type
**Function**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Function created successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **functionsDeletePost**
> functionsDeletePost(functionsDeletePostRequest)
Delete a function from the project
### Example
```typescript
import {
FunctionsApi,
Configuration,
FunctionsDeletePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new FunctionsApi(configuration);
let functionsDeletePostRequest: FunctionsDeletePostRequest; //
const { status, data } = await apiInstance.functionsDeletePost(
functionsDeletePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **functionsDeletePostRequest** | **FunctionsDeletePostRequest**| | |
### Return type
void (empty response body)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Function deleted successfully | - |
|**401** | Unauthorized | - |
|**404** | Function not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@ -0,0 +1,22 @@
# FunctionsCreatePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Function name | [default to undefined]
**source** | **string** | Function source code | [default to undefined]
## Example
```typescript
import { FunctionsCreatePostRequest } from './api';
const instance: FunctionsCreatePostRequest = {
name,
source,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# FunctionsDeletePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Function name to delete | [default to undefined]
## Example
```typescript
import { FunctionsDeletePostRequest } from './api';
const instance: FunctionsDeletePostRequest = {
name,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

42
out/ts/docs/Log.md Normal file
View File

@ -0,0 +1,42 @@
# Log
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique log identifier | [optional] [default to undefined]
**traceId** | **string** | Trace ID for tracking requests | [optional] [default to undefined]
**startTime** | **number** | Request start timestamp | [optional] [default to undefined]
**endTime** | **number** | Request end timestamp | [optional] [default to undefined]
**payload** | **object** | Request payload | [optional] [default to undefined]
**headers** | **object** | Request headers | [optional] [default to undefined]
**cookies** | **string** | Request cookies | [optional] [default to undefined]
**url** | **string** | Request URL | [optional] [default to undefined]
**response** | **object** | Response data | [optional] [default to undefined]
**content** | [**Array&lt;LogContentInner&gt;**](LogContentInner.md) | | [optional] [default to undefined]
**project** | [**Project**](Project.md) | | [optional] [default to undefined]
**query** | [**Query**](Query.md) | | [optional] [default to undefined]
## Example
```typescript
import { Log } from './api';
const instance: Log = {
id,
traceId,
startTime,
endTime,
payload,
headers,
cookies,
url,
response,
content,
project,
query,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,24 @@
# LogContentInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**content** | **string** | Log content | [optional] [default to undefined]
**type** | **string** | Log type (info, error, warning) | [optional] [default to undefined]
**timeStamp** | **number** | Log entry timestamp | [optional] [default to undefined]
## Example
```typescript
import { LogContentInner } from './api';
const instance: LogContentInner = {
content,
type,
timeStamp,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,30 @@
# LoggerIdFindAllPostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**traceId** | **string** | Filter by trace ID | [optional] [default to undefined]
**fromDate** | **string** | Filter from date | [optional] [default to undefined]
**toDate** | **string** | Filter to date | [optional] [default to undefined]
**url** | **string** | Filter by URL | [optional] [default to undefined]
**limit** | **number** | Number of results to return | [default to undefined]
**offset** | **number** | Number of results to skip | [default to undefined]
## Example
```typescript
import { LoggerIdFindAllPostRequest } from './api';
const instance: LoggerIdFindAllPostRequest = {
traceId,
fromDate,
toDate,
url,
limit,
offset,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

179
out/ts/docs/LoggingApi.md Normal file
View File

@ -0,0 +1,179 @@
# LoggingApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**loggerIdFindAllPost**](#loggeridfindallpost) | **POST** /logger/{id}/findAll | Find all logs|
|[**loggerIdFindPost**](#loggeridfindpost) | **POST** /logger/{id}/find | Find logs for query|
|[**loggerIdTraceIdGet**](#loggeridtraceidget) | **GET** /logger/{id}/{traceId} | Get log by trace ID|
# **loggerIdFindAllPost**
> Array<Log> loggerIdFindAllPost(loggerIdFindAllPostRequest)
Find all logs for a project with filtering
### Example
```typescript
import {
LoggingApi,
Configuration,
LoggerIdFindAllPostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new LoggingApi(configuration);
let id: string; //Project ID (default to undefined)
let loggerIdFindAllPostRequest: LoggerIdFindAllPostRequest; //
const { status, data } = await apiInstance.loggerIdFindAllPost(
id,
loggerIdFindAllPostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **loggerIdFindAllPostRequest** | **LoggerIdFindAllPostRequest**| | |
| **id** | [**string**] | Project ID | defaults to undefined|
### Return type
**Array<Log>**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Logs retrieved successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **loggerIdFindPost**
> Array<Log> loggerIdFindPost(loggerIdFindAllPostRequest)
Find logs for a specific query with filtering
### Example
```typescript
import {
LoggingApi,
Configuration,
LoggerIdFindAllPostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new LoggingApi(configuration);
let id: string; //Query ID (default to undefined)
let loggerIdFindAllPostRequest: LoggerIdFindAllPostRequest; //
const { status, data } = await apiInstance.loggerIdFindPost(
id,
loggerIdFindAllPostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **loggerIdFindAllPostRequest** | **LoggerIdFindAllPostRequest**| | |
| **id** | [**string**] | Query ID | defaults to undefined|
### Return type
**Array<Log>**
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Logs retrieved successfully | - |
|**401** | Unauthorized | - |
|**403** | Query access required | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **loggerIdTraceIdGet**
> Log loggerIdTraceIdGet()
Retrieve log entries by trace ID
### Example
```typescript
import {
LoggingApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new LoggingApi(configuration);
let id: string; //Log ID (default to undefined)
let traceId: string; //Trace ID (default to undefined)
const { status, data } = await apiInstance.loggerIdTraceIdGet(
id,
traceId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Log ID | defaults to undefined|
| **traceId** | [**string**] | Trace ID | defaults to undefined|
### Return type
**Log**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Log retrieved successfully | - |
|**401** | Unauthorized | - |
|**404** | Log not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

26
out/ts/docs/Migration.md Normal file
View File

@ -0,0 +1,26 @@
# Migration
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique migration identifier | [optional] [default to undefined]
**up** | **string** | Migration up SQL | [optional] [default to undefined]
**down** | **string** | Migration down SQL | [optional] [default to undefined]
**database** | [**Database**](Database.md) | | [optional] [default to undefined]
## Example
```typescript
import { Migration } from './api';
const instance: Migration = {
id,
up,
down,
database,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

32
out/ts/docs/Project.md Normal file
View File

@ -0,0 +1,32 @@
# Project
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique project identifier | [optional] [default to undefined]
**name** | **string** | Project name | [optional] [default to undefined]
**apiTokens** | [**Array&lt;Token&gt;**](Token.md) | | [optional] [default to undefined]
**database** | [**Database**](Database.md) | | [optional] [default to undefined]
**queries** | [**Array&lt;Query&gt;**](Query.md) | | [optional] [default to undefined]
**functions** | [**Array&lt;Function&gt;**](Function.md) | | [optional] [default to undefined]
**settings** | [**Array&lt;ProjectSetting&gt;**](ProjectSetting.md) | | [optional] [default to undefined]
## Example
```typescript
import { Project } from './api';
const instance: Project = {
id,
name,
apiTokens,
database,
queries,
functions,
settings,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# ProjectCreatePutRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **string** | Project name | [default to undefined]
## Example
```typescript
import { ProjectCreatePutRequest } from './api';
const instance: ProjectCreatePutRequest = {
name,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,317 @@
# ProjectManagementApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**projectApiTokensGet**](#projectapitokensget) | **GET** /project/api-tokens | Get all API tokens|
|[**projectCreatePut**](#projectcreateput) | **PUT** /project/create | Create project|
|[**projectCreateWithoutDbPut**](#projectcreatewithoutdbput) | **PUT** /project/create-without-db | Create project without database|
|[**projectSettingsCreatePut**](#projectsettingscreateput) | **PUT** /project/settings/create | Create project setting|
|[**projectSettingsDeleteKeyDelete**](#projectsettingsdeletekeydelete) | **DELETE** /project/settings/delete/{key} | Delete project setting|
|[**projectSettingsGet**](#projectsettingsget) | **GET** /project/settings | Get all project settings|
# **projectApiTokensGet**
> Array<Token> projectApiTokensGet()
Retrieve all API tokens for the current project
### Example
```typescript
import {
ProjectManagementApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);
const { status, data } = await apiInstance.projectApiTokensGet();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**Array<Token>**
### Authorization
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | API tokens retrieved successfully | - |
|**401** | Unauthorized | - |
|**403** | Admin access required | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **projectCreatePut**
> Project projectCreatePut(projectCreatePutRequest)
Create a new project with database
### Example
```typescript
import {
ProjectManagementApi,
Configuration,
ProjectCreatePutRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);
let projectCreatePutRequest: ProjectCreatePutRequest; //
const { status, data } = await apiInstance.projectCreatePut(
projectCreatePutRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectCreatePutRequest** | **ProjectCreatePutRequest**| | |
### Return type
**Project**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Project created successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **projectCreateWithoutDbPut**
> Project projectCreateWithoutDbPut(projectCreatePutRequest)
Create a new project without creating a database
### Example
```typescript
import {
ProjectManagementApi,
Configuration,
ProjectCreatePutRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);
let projectCreatePutRequest: ProjectCreatePutRequest; //
const { status, data } = await apiInstance.projectCreateWithoutDbPut(
projectCreatePutRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectCreatePutRequest** | **ProjectCreatePutRequest**| | |
### Return type
**Project**
### Authorization
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Project created successfully | - |
|**401** | Unauthorized | - |
|**403** | Admin access required | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **projectSettingsCreatePut**
> ProjectSetting projectSettingsCreatePut(projectSettingsCreatePutRequest)
Create a new project setting
### Example
```typescript
import {
ProjectManagementApi,
Configuration,
ProjectSettingsCreatePutRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);
let projectSettingsCreatePutRequest: ProjectSettingsCreatePutRequest; //
const { status, data } = await apiInstance.projectSettingsCreatePut(
projectSettingsCreatePutRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectSettingsCreatePutRequest** | **ProjectSettingsCreatePutRequest**| | |
### Return type
**ProjectSetting**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Setting created successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **projectSettingsDeleteKeyDelete**
> projectSettingsDeleteKeyDelete()
Delete a project setting by key
### Example
```typescript
import {
ProjectManagementApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);
let key: string; //Setting key to delete (default to undefined)
const { status, data } = await apiInstance.projectSettingsDeleteKeyDelete(
key
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **key** | [**string**] | Setting key to delete | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Setting deleted successfully | - |
|**401** | Unauthorized | - |
|**404** | Setting not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **projectSettingsGet**
> Array<ProjectSetting> projectSettingsGet()
Retrieve all settings for the current project
### Example
```typescript
import {
ProjectManagementApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new ProjectManagementApi(configuration);
const { status, data } = await apiInstance.projectSettingsGet();
```
### Parameters
This endpoint does not have any parameters.
### Return type
**Array<ProjectSetting>**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Settings retrieved successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

View File

@ -0,0 +1,26 @@
# ProjectSetting
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique setting identifier | [optional] [default to undefined]
**key** | **string** | Setting key | [optional] [default to undefined]
**value** | **string** | Setting value | [optional] [default to undefined]
**project** | [**Project**](Project.md) | | [optional] [default to undefined]
## Example
```typescript
import { ProjectSetting } from './api';
const instance: ProjectSetting = {
id,
key,
value,
project,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,22 @@
# ProjectSettingsCreatePutRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **string** | Setting key | [default to undefined]
**value** | **string** | Setting value | [default to undefined]
## Example
```typescript
import { ProjectSettingsCreatePutRequest } from './api';
const instance: ProjectSettingsCreatePutRequest = {
key,
value,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

238
out/ts/docs/QueriesApi.md Normal file
View File

@ -0,0 +1,238 @@
# QueriesApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**queryCreatePost**](#querycreatepost) | **POST** /query/create | Create query|
|[**queryDeleteIdDelete**](#querydeleteiddelete) | **DELETE** /query/delete/{id} | Delete query|
|[**queryRunIdPost**](#queryrunidpost) | **POST** /query/run/{id} | Run query|
|[**queryUpdateIdPost**](#queryupdateidpost) | **POST** /query/update/{id} | Update query|
# **queryCreatePost**
> Query queryCreatePost(queryCreatePostRequest)
Create a new query in the project
### Example
```typescript
import {
QueriesApi,
Configuration,
QueryCreatePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);
let queryCreatePostRequest: QueryCreatePostRequest; //
const { status, data } = await apiInstance.queryCreatePost(
queryCreatePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **queryCreatePostRequest** | **QueryCreatePostRequest**| | |
### Return type
**Query**
### Authorization
[ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query created successfully | - |
|**401** | Unauthorized | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **queryDeleteIdDelete**
> queryDeleteIdDelete()
Delete an existing query
### Example
```typescript
import {
QueriesApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);
let id: string; //Query ID (default to undefined)
const { status, data } = await apiInstance.queryDeleteIdDelete(
id
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] | Query ID | defaults to undefined|
### Return type
void (empty response body)
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query deleted successfully | - |
|**401** | Unauthorized | - |
|**403** | Query access required | - |
|**404** | Query not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **queryRunIdPost**
> object queryRunIdPost(body)
Execute a query with provided data
### Example
```typescript
import {
QueriesApi,
Configuration
} from './api';
const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);
let id: string; //Query ID (default to undefined)
let body: object; //
let xTraceId: string; //Trace ID for logging (optional) (default to undefined)
const { status, data } = await apiInstance.queryRunIdPost(
id,
body,
xTraceId
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **body** | **object**| | |
| **id** | [**string**] | Query ID | defaults to undefined|
| **xTraceId** | [**string**] | Trace ID for logging | (optional) defaults to undefined|
### Return type
**object**
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query executed successfully | - |
|**302** | Redirect response | - |
|**401** | Unauthorized | - |
|**403** | Query access required | - |
|**404** | Query not found | - |
|**500** | Internal Server Error | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
# **queryUpdateIdPost**
> Query queryUpdateIdPost(queryUpdateIdPostRequest)
Update an existing query
### Example
```typescript
import {
QueriesApi,
Configuration,
QueryUpdateIdPostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new QueriesApi(configuration);
let id: string; //Query ID (default to undefined)
let queryUpdateIdPostRequest: QueryUpdateIdPostRequest; //
const { status, data } = await apiInstance.queryUpdateIdPost(
id,
queryUpdateIdPostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **queryUpdateIdPostRequest** | **QueryUpdateIdPostRequest**| | |
| **id** | [**string**] | Query ID | defaults to undefined|
### Return type
**Query**
### Authorization
[QueryGuard](../README.md#QueryGuard), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Query updated successfully | - |
|**401** | Unauthorized | - |
|**403** | Query access required | - |
|**404** | Query not found | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

30
out/ts/docs/Query.md Normal file
View File

@ -0,0 +1,30 @@
# Query
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique query identifier | [optional] [default to undefined]
**source** | **string** | Query source code | [optional] [default to undefined]
**isActive** | **number** | Whether the query is active (1 &#x3D; active, 0 &#x3D; inactive) | [optional] [default to undefined]
**isCommand** | **number** | Whether this is a command (1 &#x3D; command, 0 &#x3D; query) | [optional] [default to undefined]
**project** | [**Project**](Project.md) | | [optional] [default to undefined]
**logs** | [**Array&lt;Log&gt;**](Log.md) | | [optional] [default to undefined]
## Example
```typescript
import { Query } from './api';
const instance: Query = {
id,
source,
isActive,
isCommand,
project,
logs,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# QueryCreatePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **string** | Query source code | [default to undefined]
## Example
```typescript
import { QueryCreatePostRequest } from './api';
const instance: QueryCreatePostRequest = {
source,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,20 @@
# QueryUpdateIdPostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | **string** | Updated query source code | [optional] [default to undefined]
## Example
```typescript
import { QueryUpdateIdPostRequest } from './api';
const instance: QueryUpdateIdPostRequest = {
source,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,62 @@
# RedisManagementApi
All URIs are relative to *http://localhost:3000*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**redisNodeCreatePost**](#redisnodecreatepost) | **POST** /redis/node/create | Add Redis node|
# **redisNodeCreatePost**
> RedisNode redisNodeCreatePost(redisNodeCreatePostRequest)
Add a new Redis node to the system
### Example
```typescript
import {
RedisManagementApi,
Configuration,
RedisNodeCreatePostRequest
} from './api';
const configuration = new Configuration();
const apiInstance = new RedisManagementApi(configuration);
let redisNodeCreatePostRequest: RedisNodeCreatePostRequest; //
const { status, data } = await apiInstance.redisNodeCreatePost(
redisNodeCreatePostRequest
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **redisNodeCreatePostRequest** | **RedisNodeCreatePostRequest**| | |
### Return type
**RedisNode**
### Authorization
[AdminAuth](../README.md#AdminAuth), [ApiKeyAuth](../README.md#ApiKeyAuth)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Redis node created successfully | - |
|**401** | Unauthorized | - |
|**403** | Admin access required | - |
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

30
out/ts/docs/RedisNode.md Normal file
View File

@ -0,0 +1,30 @@
# RedisNode
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Unique Redis node identifier | [optional] [default to undefined]
**host** | **string** | Redis host | [optional] [default to undefined]
**port** | **number** | Redis port | [optional] [default to undefined]
**user** | **string** | Redis username | [optional] [default to undefined]
**password** | **string** | Redis password | [optional] [default to undefined]
**projects** | [**Array&lt;Project&gt;**](Project.md) | | [optional] [default to undefined]
## Example
```typescript
import { RedisNode } from './api';
const instance: RedisNode = {
id,
host,
port,
user,
password,
projects,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@ -0,0 +1,26 @@
# RedisNodeCreatePostRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**host** | **string** | Redis host | [default to undefined]
**port** | **number** | Redis port | [default to undefined]
**user** | **string** | Redis username | [default to undefined]
**password** | **string** | Redis password | [default to undefined]
## Example
```typescript
import { RedisNodeCreatePostRequest } from './api';
const instance: RedisNodeCreatePostRequest = {
host,
port,
user,
password,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

26
out/ts/docs/Token.md Normal file
View File

@ -0,0 +1,26 @@
# Token
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**token** | **string** | Unique token identifier | [optional] [default to undefined]
**isActive** | **boolean** | Whether the token is active | [optional] [default to undefined]
**isAdmin** | **boolean** | Whether the token has admin privileges | [optional] [default to undefined]
**project** | [**Project**](Project.md) | | [optional] [default to undefined]
## Example
```typescript
import { Token } from './api';
const instance: Token = {
token,
isActive,
isAdmin,
project,
};
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

57
out/ts/git_push.sh Normal file
View File

@ -0,0 +1,57 @@
#!/bin/sh
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
#
# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
git_user_id=$1
git_repo_id=$2
release_note=$3
git_host=$4
if [ "$git_host" = "" ]; then
git_host="github.com"
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
fi
if [ "$git_user_id" = "" ]; then
git_user_id="GIT_USER_ID"
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
fi
if [ "$git_repo_id" = "" ]; then
git_repo_id="GIT_REPO_ID"
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
fi
if [ "$release_note" = "" ]; then
release_note="Minor update"
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
fi
# Initialize the local directory as a Git repository
git init
# Adds the files in the local repository and stages them for commit.
git add .
# Commits the tracked changes and prepares them to be pushed to a remote repository.
git commit -m "$release_note"
# Sets the new remote
git_remote=$(git remote)
if [ "$git_remote" = "" ]; then # git remote not defined
if [ "$GIT_TOKEN" = "" ]; then
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
else
git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
fi
fi
git pull origin master
# Pushes (Forces) the changes in the local repository up to the remote repository
echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
git push origin master 2>&1 | grep -v 'To https'

18
out/ts/index.ts Normal file
View File

@ -0,0 +1,18 @@
/* tslint:disable */
/* eslint-disable */
/**
* Low-Code Engine API
* API documentation for the Low-Code Engine platform that provides query execution, database management, and project administration capabilities.
*
* The version of the OpenAPI document: 1.0.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
export * from "./api";
export * from "./configuration";