更新文档内容

This commit is contained in:
2023-08-22 10:37:28 +08:00
parent c3f06b456f
commit 73222eee28
329 changed files with 25366 additions and 2475 deletions

View File

@@ -1,17 +1,19 @@
# \AdminApi
All URIs are relative to *http://127.0.0.1:80*
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**AnswerAdminApiAnswerPageGet**](AdminApi.md#AnswerAdminApiAnswerPageGet) | **Get** /answer/admin/api/answer/page | AdminSearchAnswerList
[**AnswerAdminApiAnswerPageGet**](AdminApi.md#AnswerAdminApiAnswerPageGet) | **Get** /answer/admin/api/answer/page | AdminAnswerPage admin answer page
[**AnswerAdminApiAnswerStatusPut**](AdminApi.md#AnswerAdminApiAnswerStatusPut) | **Put** /answer/admin/api/answer/status | AdminSetAnswerStatus
[**AnswerAdminApiDashboardGet**](AdminApi.md#AnswerAdminApiDashboardGet) | **Get** /answer/admin/api/dashboard | DashboardInfo
[**AnswerAdminApiQuestionPageGet**](AdminApi.md#AnswerAdminApiQuestionPageGet) | **Get** /answer/admin/api/question/page | AdminSearchList
[**AnswerAdminApiQuestionPageGet**](AdminApi.md#AnswerAdminApiQuestionPageGet) | **Get** /answer/admin/api/question/page | AdminQuestionPage admin question page
[**AnswerAdminApiQuestionStatusPut**](AdminApi.md#AnswerAdminApiQuestionStatusPut) | **Put** /answer/admin/api/question/status | AdminSetQuestionStatus
[**AnswerAdminApiReportPut**](AdminApi.md#AnswerAdminApiReportPut) | **Put** /answer/admin/api/report/ | handle flag
[**AnswerAdminApiReportsPageGet**](AdminApi.md#AnswerAdminApiReportsPageGet) | **Get** /answer/admin/api/reports/page | list report page
[**AnswerAdminApiRolesGet**](AdminApi.md#AnswerAdminApiRolesGet) | **Get** /answer/admin/api/roles | get role list
[**AnswerAdminApiSettingPrivilegesGet**](AdminApi.md#AnswerAdminApiSettingPrivilegesGet) | **Get** /answer/admin/api/setting/privileges | GetPrivilegesConfig get privileges config
[**AnswerAdminApiSettingPrivilegesPut**](AdminApi.md#AnswerAdminApiSettingPrivilegesPut) | **Put** /answer/admin/api/setting/privileges | update privileges config
[**AnswerAdminApiSettingSmtpGet**](AdminApi.md#AnswerAdminApiSettingSmtpGet) | **Get** /answer/admin/api/setting/smtp | GetSMTPConfig get smtp config
[**AnswerAdminApiSettingSmtpPut**](AdminApi.md#AnswerAdminApiSettingSmtpPut) | **Put** /answer/admin/api/setting/smtp | update smtp config
[**AnswerAdminApiSiteinfoBrandingGet**](AdminApi.md#AnswerAdminApiSiteinfoBrandingGet) | **Get** /answer/admin/api/siteinfo/branding | get site interface
@@ -30,13 +32,17 @@ Method | HTTP request | Description
[**AnswerAdminApiSiteinfoSeoPut**](AdminApi.md#AnswerAdminApiSiteinfoSeoPut) | **Put** /answer/admin/api/siteinfo/seo | update site seo information
[**AnswerAdminApiSiteinfoThemeGet**](AdminApi.md#AnswerAdminApiSiteinfoThemeGet) | **Get** /answer/admin/api/siteinfo/theme | get site info theme config
[**AnswerAdminApiSiteinfoThemePut**](AdminApi.md#AnswerAdminApiSiteinfoThemePut) | **Put** /answer/admin/api/siteinfo/theme | update site custom css html config
[**AnswerAdminApiSiteinfoUsersGet**](AdminApi.md#AnswerAdminApiSiteinfoUsersGet) | **Get** /answer/admin/api/siteinfo/users | get site user config
[**AnswerAdminApiSiteinfoUsersPut**](AdminApi.md#AnswerAdminApiSiteinfoUsersPut) | **Put** /answer/admin/api/siteinfo/users | update site info config about users
[**AnswerAdminApiSiteinfoWriteGet**](AdminApi.md#AnswerAdminApiSiteinfoWriteGet) | **Get** /answer/admin/api/siteinfo/write | get site interface
[**AnswerAdminApiSiteinfoWritePut**](AdminApi.md#AnswerAdminApiSiteinfoWritePut) | **Put** /answer/admin/api/siteinfo/write | update site write info
[**AnswerAdminApiThemeOptionsGet**](AdminApi.md#AnswerAdminApiThemeOptionsGet) | **Get** /answer/admin/api/theme/options | Get theme options
[**AnswerAdminApiUserActivationGet**](AdminApi.md#AnswerAdminApiUserActivationGet) | **Get** /answer/admin/api/user/activation | get user activation
[**AnswerAdminApiUserPasswordPut**](AdminApi.md#AnswerAdminApiUserPasswordPut) | **Put** /answer/admin/api/user/password | update user password
[**AnswerAdminApiUserPost**](AdminApi.md#AnswerAdminApiUserPost) | **Post** /answer/admin/api/user | add user
[**AnswerAdminApiUserRolePut**](AdminApi.md#AnswerAdminApiUserRolePut) | **Put** /answer/admin/api/user/role | update user role
[**AnswerAdminApiUserStatusPut**](AdminApi.md#AnswerAdminApiUserStatusPut) | **Put** /answer/admin/api/user/status | update user
[**AnswerAdminApiUsersActivationPost**](AdminApi.md#AnswerAdminApiUsersActivationPost) | **Post** /answer/admin/api/users/activation | send user activation
[**AnswerAdminApiUsersPageGet**](AdminApi.md#AnswerAdminApiUsersPageGet) | **Get** /answer/admin/api/users/page | get user page
@@ -45,7 +51,7 @@ Method | HTTP request | Description
> HandlerRespBody AnswerAdminApiAnswerPageGet(ctx).Page(page).PageSize(pageSize).Status(status).Query(query).QuestionId(questionId).Execute()
AdminSearchAnswerList
AdminAnswerPage admin answer page
@@ -246,7 +252,7 @@ Other parameters are passed through a pointer to a apiAnswerAdminApiDashboardGet
> HandlerRespBody AnswerAdminApiQuestionPageGet(ctx).Page(page).PageSize(pageSize).Status(status).Query(query).Execute()
AdminSearchList
AdminQuestionPage admin question page
@@ -579,6 +585,133 @@ No authorization required
[[Back to README]](../README.md)
## AnswerAdminApiSettingPrivilegesGet
> AnswerAdminApiSettingPrivilegesGet200Response AnswerAdminApiSettingPrivilegesGet(ctx).Execute()
GetPrivilegesConfig get privileges config
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AdminApi.AnswerAdminApiSettingPrivilegesGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AdminApi.AnswerAdminApiSettingPrivilegesGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerAdminApiSettingPrivilegesGet`: AnswerAdminApiSettingPrivilegesGet200Response
fmt.Fprintf(os.Stdout, "Response from `AdminApi.AnswerAdminApiSettingPrivilegesGet`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerAdminApiSettingPrivilegesGetRequest struct via the builder pattern
### Return type
[**AnswerAdminApiSettingPrivilegesGet200Response**](AnswerAdminApiSettingPrivilegesGet200Response.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)
## AnswerAdminApiSettingPrivilegesPut
> HandlerRespBody AnswerAdminApiSettingPrivilegesPut(ctx).Data(data).Execute()
update privileges config
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)
func main() {
data := *openapiclient.NewSchemaUpdatePrivilegesConfigReq(openapiclient.schema.PrivilegeLevel(1)) // SchemaUpdatePrivilegesConfigReq | config
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AdminApi.AnswerAdminApiSettingPrivilegesPut(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AdminApi.AnswerAdminApiSettingPrivilegesPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerAdminApiSettingPrivilegesPut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `AdminApi.AnswerAdminApiSettingPrivilegesPut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerAdminApiSettingPrivilegesPutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaUpdatePrivilegesConfigReq**](SchemaUpdatePrivilegesConfigReq.md) | config |
### Return type
[**HandlerRespBody**](HandlerRespBody.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)
## AnswerAdminApiSettingSmtpGet
> AnswerAdminApiSettingSmtpGet200Response AnswerAdminApiSettingSmtpGet(ctx).Execute()
@@ -1169,7 +1302,7 @@ import (
)
func main() {
data := *openapiclient.NewSchemaSiteInterfaceReq("DefaultAvatar_example", "Language_example", "TimeZone_example") // SchemaSiteInterfaceReq | general
data := *openapiclient.NewSchemaSiteInterfaceReq("Language_example", "TimeZone_example") // SchemaSiteInterfaceReq | general
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
@@ -1722,6 +1855,133 @@ Name | Type | Description | Notes
[[Back to README]](../README.md)
## AnswerAdminApiSiteinfoUsersGet
> AnswerAdminApiSiteinfoUsersGet200Response AnswerAdminApiSiteinfoUsersGet(ctx).Execute()
get site user config
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AdminApi.AnswerAdminApiSiteinfoUsersGet(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AdminApi.AnswerAdminApiSiteinfoUsersGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerAdminApiSiteinfoUsersGet`: AnswerAdminApiSiteinfoUsersGet200Response
fmt.Fprintf(os.Stdout, "Response from `AdminApi.AnswerAdminApiSiteinfoUsersGet`: %v\n", resp)
}
```
### Path Parameters
This endpoint does not need any parameter.
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerAdminApiSiteinfoUsersGetRequest struct via the builder pattern
### Return type
[**AnswerAdminApiSiteinfoUsersGet200Response**](AnswerAdminApiSiteinfoUsersGet200Response.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)
## AnswerAdminApiSiteinfoUsersPut
> HandlerRespBody AnswerAdminApiSiteinfoUsersPut(ctx).Data(data).Execute()
update site info config about users
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)
func main() {
data := *openapiclient.NewSchemaSiteUsersReq("DefaultAvatar_example") // SchemaSiteUsersReq | users info
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AdminApi.AnswerAdminApiSiteinfoUsersPut(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AdminApi.AnswerAdminApiSiteinfoUsersPut``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerAdminApiSiteinfoUsersPut`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `AdminApi.AnswerAdminApiSiteinfoUsersPut`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerAdminApiSiteinfoUsersPutRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaSiteUsersReq**](SchemaSiteUsersReq.md) | users info |
### Return type
[**HandlerRespBody**](HandlerRespBody.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)
## AnswerAdminApiSiteinfoWriteGet
> AnswerAdminApiSiteinfoWriteGet200Response AnswerAdminApiSiteinfoWriteGet(ctx).Execute()
@@ -1910,6 +2170,72 @@ Other parameters are passed through a pointer to a apiAnswerAdminApiThemeOptions
[[Back to README]](../README.md)
## AnswerAdminApiUserActivationGet
> AnswerAdminApiUserActivationGet200Response AnswerAdminApiUserActivationGet(ctx).UserId(userId).Execute()
get user activation
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)
func main() {
userId := "userId_example" // string | user id
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AdminApi.AnswerAdminApiUserActivationGet(context.Background()).UserId(userId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AdminApi.AnswerAdminApiUserActivationGet``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerAdminApiUserActivationGet`: AnswerAdminApiUserActivationGet200Response
fmt.Fprintf(os.Stdout, "Response from `AdminApi.AnswerAdminApiUserActivationGet`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerAdminApiUserActivationGetRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**userId** | **string** | user id |
### Return type
[**AnswerAdminApiUserActivationGet200Response**](AnswerAdminApiUserActivationGet200Response.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)
## AnswerAdminApiUserPasswordPut
> HandlerRespBody AnswerAdminApiUserPasswordPut(ctx).Data(data).Execute()
@@ -2174,6 +2500,72 @@ Name | Type | Description | Notes
[[Back to README]](../README.md)
## AnswerAdminApiUsersActivationPost
> HandlerRespBody AnswerAdminApiUsersActivationPost(ctx).Data(data).Execute()
send user activation
### Example
```go
package main
import (
"context"
"fmt"
"os"
openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)
func main() {
data := *openapiclient.NewSchemaSendUserActivationReq("UserId_example") // SchemaSendUserActivationReq | SendUserActivationReq
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.AdminApi.AnswerAdminApiUsersActivationPost(context.Background()).Data(data).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `AdminApi.AnswerAdminApiUsersActivationPost``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `AnswerAdminApiUsersActivationPost`: HandlerRespBody
fmt.Fprintf(os.Stdout, "Response from `AdminApi.AnswerAdminApiUsersActivationPost`: %v\n", resp)
}
```
### Path Parameters
### Other Parameters
Other parameters are passed through a pointer to a apiAnswerAdminApiUsersActivationPostRequest struct via the builder pattern
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**data** | [**SchemaSendUserActivationReq**](SchemaSendUserActivationReq.md) | SendUserActivationReq |
### Return type
[**HandlerRespBody**](HandlerRespBody.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)
## AnswerAdminApiUsersPageGet
> AnswerAdminApiUsersPageGet200Response AnswerAdminApiUsersPageGet(ctx).Page(page).PageSize(pageSize).Query(query).Staff(staff).Status(status).Execute()