[DOCUMENT] Add API and model documents

This commit is contained in:
Hui Yu
2021-03-17 16:35:19 +08:00
parent ea540c9da3
commit 6381367c3c
744 changed files with 45250 additions and 0 deletions

View File

@@ -0,0 +1,61 @@
# LogsAPI
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**LogsAPI_logFileHandler**](LogsAPI.md#LogsAPI_logFileHandler) | **GET** /logs/{logpath} |
[**LogsAPI_logFileListHandler**](LogsAPI.md#LogsAPI_logFileListHandler) | **GET** /logs/ |
# **LogsAPI_logFileHandler**
```c
void LogsAPI_logFileHandler(apiClient_t *apiClient, char * logpath);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**apiClient** | **apiClient_t \*** | context containing the client configuration |
**logpath** | **char \*** | path to the log |
### Return type
void
### Authorization
[BearerToken](../README.md#BearerToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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)
# **LogsAPI_logFileListHandler**
```c
void LogsAPI_logFileListHandler(apiClient_t *apiClient);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**apiClient** | **apiClient_t \*** | context containing the client configuration |
### Return type
void
### Authorization
[BearerToken](../README.md#BearerToken)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[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)