lborv/few-line-engine
1
0
Fork 0
Code Pull Requests Actions Packages Projects Releases Wiki Activity
Files
66a461f12a72cfb870a68adc431d7784a6845e42
few-line-engine/out/ts/docs/CommandsApi.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

6.0 KiB
Raw Blame History

CommandsApi

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

Method HTTP request Description
commandCreatePost POST /command/create Create command
commandDeleteIdDelete DELETE /command/delete/{id} Delete command
commandRunIdPost POST /command/run/{id} Run command
commandUpdateIdPost POST /command/update/{id} Update command

commandCreatePost

Query commandCreatePost(commandCreatePostRequest)

Create a new command in the project

Example

import {
    CommandsApi,
    Configuration,
    CommandCreatePostRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);

let commandCreatePostRequest: CommandCreatePostRequest; //

const { status, data } = await apiInstance.commandCreatePost(
    commandCreatePostRequest
);

Parameters

Name Type Description Notes
commandCreatePostRequest CommandCreatePostRequest

Return type

Query

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Command created successfully -
401 Unauthorized -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

commandDeleteIdDelete

commandDeleteIdDelete()

Delete an existing command

Example

import {
    CommandsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);

let id: string; //Command ID (default to undefined)

const { status, data } = await apiInstance.commandDeleteIdDelete(
    id
);

Parameters

Name Type Description Notes
id [string] Command ID defaults to undefined

Return type

void (empty response body)

Authorization

QueryGuard, ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 Command deleted successfully -
401 Unauthorized -
403 Query access required -
404 Command not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

commandRunIdPost

object commandRunIdPost(body)

Execute a command with provided data

Example

import {
    CommandsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);

let id: string; //Command ID (default to undefined)
let body: object; //
let xTraceId: string; //Trace ID for logging (optional) (default to undefined)

const { status, data } = await apiInstance.commandRunIdPost(
    id,
    body,
    xTraceId
);

Parameters

Name Type Description Notes
body object
id [string] Command ID defaults to undefined
xTraceId [string] Trace ID for logging (optional) defaults to undefined

Return type

object

Authorization

QueryGuard, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Command executed successfully -
302 Redirect response -
401 Unauthorized -
403 Query access required -
404 Command not found -
500 Internal Server Error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

commandUpdateIdPost

Query commandUpdateIdPost(commandUpdateIdPostRequest)

Update an existing command

Example

import {
    CommandsApi,
    Configuration,
    CommandUpdateIdPostRequest
} from './api';

const configuration = new Configuration();
const apiInstance = new CommandsApi(configuration);

let id: string; //Command ID (default to undefined)
let commandUpdateIdPostRequest: CommandUpdateIdPostRequest; //

const { status, data } = await apiInstance.commandUpdateIdPost(
    id,
    commandUpdateIdPostRequest
);

Parameters

Name Type Description Notes
commandUpdateIdPostRequest CommandUpdateIdPostRequest
id [string] Command ID defaults to undefined

Return type

Query

Authorization

QueryGuard, ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Command updated successfully -
401 Unauthorized -
403 Query access required -
404 Command not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]