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