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
448
out/ts/docs/DatabaseManagementApi.md
Normal file
448
out/ts/docs/DatabaseManagementApi.md
Normal 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)
|
||||
|
||||
Reference in New Issue
Block a user