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