更新文档内容
This commit is contained in:
278
docs/AdminPluginApi.md
Normal file
278
docs/AdminPluginApi.md
Normal file
@@ -0,0 +1,278 @@
|
||||
# \AdminPluginApi
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**AnswerAdminApiPluginConfigGet**](AdminPluginApi.md#AnswerAdminApiPluginConfigGet) | **Get** /answer/admin/api/plugin/config | get plugin config
|
||||
[**AnswerAdminApiPluginConfigPut**](AdminPluginApi.md#AnswerAdminApiPluginConfigPut) | **Put** /answer/admin/api/plugin/config | update plugin config
|
||||
[**AnswerAdminApiPluginStatusPut**](AdminPluginApi.md#AnswerAdminApiPluginStatusPut) | **Put** /answer/admin/api/plugin/status | update plugin status
|
||||
[**AnswerAdminApiPluginsGet**](AdminPluginApi.md#AnswerAdminApiPluginsGet) | **Get** /answer/admin/api/plugins | get plugin list
|
||||
|
||||
|
||||
|
||||
## AnswerAdminApiPluginConfigGet
|
||||
|
||||
> AnswerAdminApiPluginConfigGet200Response AnswerAdminApiPluginConfigGet(ctx).PluginSlugName(pluginSlugName).Execute()
|
||||
|
||||
get plugin config
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
pluginSlugName := "pluginSlugName_example" // string | plugin_slug_name
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AdminPluginApi.AnswerAdminApiPluginConfigGet(context.Background()).PluginSlugName(pluginSlugName).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AdminPluginApi.AnswerAdminApiPluginConfigGet``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerAdminApiPluginConfigGet`: AnswerAdminApiPluginConfigGet200Response
|
||||
fmt.Fprintf(os.Stdout, "Response from `AdminPluginApi.AnswerAdminApiPluginConfigGet`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerAdminApiPluginConfigGetRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**pluginSlugName** | **string** | plugin_slug_name |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AnswerAdminApiPluginConfigGet200Response**](AnswerAdminApiPluginConfigGet200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## AnswerAdminApiPluginConfigPut
|
||||
|
||||
> HandlerRespBody AnswerAdminApiPluginConfigPut(ctx).Data(data).Execute()
|
||||
|
||||
update plugin config
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
data := *openapiclient.NewSchemaUpdatePluginConfigReq("PluginSlugName_example") // SchemaUpdatePluginConfigReq | UpdatePluginConfigReq
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AdminPluginApi.AnswerAdminApiPluginConfigPut(context.Background()).Data(data).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AdminPluginApi.AnswerAdminApiPluginConfigPut``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerAdminApiPluginConfigPut`: HandlerRespBody
|
||||
fmt.Fprintf(os.Stdout, "Response from `AdminPluginApi.AnswerAdminApiPluginConfigPut`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerAdminApiPluginConfigPutRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**data** | [**SchemaUpdatePluginConfigReq**](SchemaUpdatePluginConfigReq.md) | UpdatePluginConfigReq |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlerRespBody**](HandlerRespBody.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## AnswerAdminApiPluginStatusPut
|
||||
|
||||
> HandlerRespBody AnswerAdminApiPluginStatusPut(ctx).Data(data).Execute()
|
||||
|
||||
update plugin status
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
data := *openapiclient.NewSchemaUpdatePluginStatusReq("PluginSlugName_example") // SchemaUpdatePluginStatusReq | UpdatePluginStatusReq
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AdminPluginApi.AnswerAdminApiPluginStatusPut(context.Background()).Data(data).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AdminPluginApi.AnswerAdminApiPluginStatusPut``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerAdminApiPluginStatusPut`: HandlerRespBody
|
||||
fmt.Fprintf(os.Stdout, "Response from `AdminPluginApi.AnswerAdminApiPluginStatusPut`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerAdminApiPluginStatusPutRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**data** | [**SchemaUpdatePluginStatusReq**](SchemaUpdatePluginStatusReq.md) | UpdatePluginStatusReq |
|
||||
|
||||
### Return type
|
||||
|
||||
[**HandlerRespBody**](HandlerRespBody.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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)
|
||||
|
||||
|
||||
## AnswerAdminApiPluginsGet
|
||||
|
||||
> AnswerAdminApiPluginsGet200Response AnswerAdminApiPluginsGet(ctx).Status(status).HaveConfig(haveConfig).Execute()
|
||||
|
||||
get plugin list
|
||||
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
"os"
|
||||
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
|
||||
)
|
||||
|
||||
func main() {
|
||||
status := "status_example" // string | status: active/inactive (optional)
|
||||
haveConfig := true // bool | have config (optional)
|
||||
|
||||
configuration := openapiclient.NewConfiguration()
|
||||
apiClient := openapiclient.NewAPIClient(configuration)
|
||||
resp, r, err := apiClient.AdminPluginApi.AnswerAdminApiPluginsGet(context.Background()).Status(status).HaveConfig(haveConfig).Execute()
|
||||
if err != nil {
|
||||
fmt.Fprintf(os.Stderr, "Error when calling `AdminPluginApi.AnswerAdminApiPluginsGet``: %v\n", err)
|
||||
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
||||
}
|
||||
// response from `AnswerAdminApiPluginsGet`: AnswerAdminApiPluginsGet200Response
|
||||
fmt.Fprintf(os.Stdout, "Response from `AdminPluginApi.AnswerAdminApiPluginsGet`: %v\n", resp)
|
||||
}
|
||||
```
|
||||
|
||||
### Path Parameters
|
||||
|
||||
|
||||
|
||||
### Other Parameters
|
||||
|
||||
Other parameters are passed through a pointer to a apiAnswerAdminApiPluginsGetRequest struct via the builder pattern
|
||||
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------- | ------------- | ------------- | -------------
|
||||
**status** | **string** | status: active/inactive |
|
||||
**haveConfig** | **bool** | have config |
|
||||
|
||||
### Return type
|
||||
|
||||
[**AnswerAdminApiPluginsGet200Response**](AnswerAdminApiPluginsGet200Response.md)
|
||||
|
||||
### Authorization
|
||||
|
||||
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
[[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