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