Files
few-line-engine/out/ts/docs/LoggingApi.md
lborv 66a461f12a 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.
2025-10-25 17:50:15 +03:00

4.5 KiB

LoggingApi

All URIs are relative to http://localhost:3000

Method HTTP request Description
loggerIdFindAllPost POST /logger/{id}/findAll Find all logs
loggerIdFindPost POST /logger/{id}/find Find logs for query
loggerIdTraceIdGet GET /logger/{id}/{traceId} Get log by trace ID

loggerIdFindAllPost

Array loggerIdFindAllPost(loggerIdFindAllPostRequest)

Find all logs for a project with filtering

Example

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

Authorization

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] [Back to Model list] [Back to README]

loggerIdFindPost

Array loggerIdFindPost(loggerIdFindAllPostRequest)

Find logs for a specific query with filtering

Example

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

Authorization

QueryGuard, 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] [Back to Model list] [Back to README]

loggerIdTraceIdGet

Log loggerIdTraceIdGet()

Retrieve log entries by trace ID

Example

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

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] [Back to Model list] [Back to README]