419 lines
35 KiB
Markdown
419 lines
35 KiB
Markdown
# Go API client for openapi
|
|
|
|
answer api
|
|
|
|
## Overview
|
|
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: v0.0.1
|
|
- Package version: 1.0.0
|
|
- Build package: org.openapitools.codegen.languages.GoClientCodegen
|
|
|
|
## Installation
|
|
|
|
Install the following dependencies:
|
|
|
|
```shell
|
|
go get github.com/stretchr/testify/assert
|
|
go get golang.org/x/net/context
|
|
```
|
|
|
|
Put the package under your project folder and add the following in import:
|
|
|
|
```golang
|
|
import openapi "github.com/GIT_USER_ID/GIT_REPO_ID"
|
|
```
|
|
|
|
To use a proxy, set the environment variable `HTTP_PROXY`:
|
|
|
|
```golang
|
|
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
|
|
```
|
|
|
|
## Configuration of Server URL
|
|
|
|
Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
|
|
|
|
### Select Server Configuration
|
|
|
|
For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.
|
|
|
|
```golang
|
|
ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)
|
|
```
|
|
|
|
### Templated Server URL
|
|
|
|
Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.
|
|
|
|
```golang
|
|
ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
|
|
"basePath": "v2",
|
|
})
|
|
```
|
|
|
|
Note, enum values are always validated and all unused variables are silently ignored.
|
|
|
|
### URLs Configuration per Operation
|
|
|
|
Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
|
|
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
|
|
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.
|
|
|
|
```golang
|
|
ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
|
|
"{classname}Service.{nickname}": 2,
|
|
})
|
|
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
|
|
"{classname}Service.{nickname}": {
|
|
"port": "8443",
|
|
},
|
|
})
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://127.0.0.1:80*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*ActivityApi* | [**AnswerApiV1FollowPost**](docs/ActivityApi.md#answerapiv1followpost) | **Post** /answer/api/v1/follow | follow object or cancel follow operation
|
|
*ActivityApi* | [**AnswerApiV1FollowTagsPut**](docs/ActivityApi.md#answerapiv1followtagsput) | **Put** /answer/api/v1/follow/tags | update user follow tags
|
|
*ActivityApi* | [**AnswerApiV1PersonalVotePageGet**](docs/ActivityApi.md#answerapiv1personalvotepageget) | **Get** /answer/api/v1/personal/vote/page | user's votes
|
|
*ActivityApi* | [**AnswerApiV1VoteDownPost**](docs/ActivityApi.md#answerapiv1votedownpost) | **Post** /answer/api/v1/vote/down | vote down
|
|
*ActivityApi* | [**AnswerApiV1VoteUpPost**](docs/ActivityApi.md#answerapiv1voteuppost) | **Post** /answer/api/v1/vote/up | vote up
|
|
*AdminApi* | [**AnswerAdminApiAnswerPageGet**](docs/AdminApi.md#answeradminapianswerpageget) | **Get** /answer/admin/api/answer/page | AdminSearchAnswerList
|
|
*AdminApi* | [**AnswerAdminApiAnswerStatusPut**](docs/AdminApi.md#answeradminapianswerstatusput) | **Put** /answer/admin/api/answer/status | AdminSetAnswerStatus
|
|
*AdminApi* | [**AnswerAdminApiDashboardGet**](docs/AdminApi.md#answeradminapidashboardget) | **Get** /answer/admin/api/dashboard | DashboardInfo
|
|
*AdminApi* | [**AnswerAdminApiQuestionPageGet**](docs/AdminApi.md#answeradminapiquestionpageget) | **Get** /answer/admin/api/question/page | AdminSearchList
|
|
*AdminApi* | [**AnswerAdminApiQuestionStatusPut**](docs/AdminApi.md#answeradminapiquestionstatusput) | **Put** /answer/admin/api/question/status | AdminSetQuestionStatus
|
|
*AdminApi* | [**AnswerAdminApiReportPut**](docs/AdminApi.md#answeradminapireportput) | **Put** /answer/admin/api/report/ | handle flag
|
|
*AdminApi* | [**AnswerAdminApiReportsPageGet**](docs/AdminApi.md#answeradminapireportspageget) | **Get** /answer/admin/api/reports/page | list report page
|
|
*AdminApi* | [**AnswerAdminApiRolesGet**](docs/AdminApi.md#answeradminapirolesget) | **Get** /answer/admin/api/roles | get role list
|
|
*AdminApi* | [**AnswerAdminApiSettingSmtpGet**](docs/AdminApi.md#answeradminapisettingsmtpget) | **Get** /answer/admin/api/setting/smtp | GetSMTPConfig get smtp config
|
|
*AdminApi* | [**AnswerAdminApiSettingSmtpPut**](docs/AdminApi.md#answeradminapisettingsmtpput) | **Put** /answer/admin/api/setting/smtp | update smtp config
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoBrandingGet**](docs/AdminApi.md#answeradminapisiteinfobrandingget) | **Get** /answer/admin/api/siteinfo/branding | get site interface
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoBrandingPut**](docs/AdminApi.md#answeradminapisiteinfobrandingput) | **Put** /answer/admin/api/siteinfo/branding | update site info branding
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoCustomCssHtmlGet**](docs/AdminApi.md#answeradminapisiteinfocustomcsshtmlget) | **Get** /answer/admin/api/siteinfo/custom-css-html | get site info custom html css config
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoCustomCssHtmlPut**](docs/AdminApi.md#answeradminapisiteinfocustomcsshtmlput) | **Put** /answer/admin/api/siteinfo/custom-css-html | update site custom css html config
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoGeneralGet**](docs/AdminApi.md#answeradminapisiteinfogeneralget) | **Get** /answer/admin/api/siteinfo/general | get site general information
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoGeneralPut**](docs/AdminApi.md#answeradminapisiteinfogeneralput) | **Put** /answer/admin/api/siteinfo/general | update site general information
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoInterfaceGet**](docs/AdminApi.md#answeradminapisiteinfointerfaceget) | **Get** /answer/admin/api/siteinfo/interface | get site interface
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoInterfacePut**](docs/AdminApi.md#answeradminapisiteinfointerfaceput) | **Put** /answer/admin/api/siteinfo/interface | update site info interface
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoLegalGet**](docs/AdminApi.md#answeradminapisiteinfolegalget) | **Get** /answer/admin/api/siteinfo/legal | Set the legal information for the site
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoLegalPut**](docs/AdminApi.md#answeradminapisiteinfolegalput) | **Put** /answer/admin/api/siteinfo/legal | update site legal info
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoLoginGet**](docs/AdminApi.md#answeradminapisiteinfologinget) | **Get** /answer/admin/api/siteinfo/login | get site info login config
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoLoginPut**](docs/AdminApi.md#answeradminapisiteinfologinput) | **Put** /answer/admin/api/siteinfo/login | update site login
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoSeoGet**](docs/AdminApi.md#answeradminapisiteinfoseoget) | **Get** /answer/admin/api/siteinfo/seo | get site seo information
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoSeoPut**](docs/AdminApi.md#answeradminapisiteinfoseoput) | **Put** /answer/admin/api/siteinfo/seo | update site seo information
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoThemeGet**](docs/AdminApi.md#answeradminapisiteinfothemeget) | **Get** /answer/admin/api/siteinfo/theme | get site info theme config
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoThemePut**](docs/AdminApi.md#answeradminapisiteinfothemeput) | **Put** /answer/admin/api/siteinfo/theme | update site custom css html config
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoWriteGet**](docs/AdminApi.md#answeradminapisiteinfowriteget) | **Get** /answer/admin/api/siteinfo/write | get site interface
|
|
*AdminApi* | [**AnswerAdminApiSiteinfoWritePut**](docs/AdminApi.md#answeradminapisiteinfowriteput) | **Put** /answer/admin/api/siteinfo/write | update site write info
|
|
*AdminApi* | [**AnswerAdminApiThemeOptionsGet**](docs/AdminApi.md#answeradminapithemeoptionsget) | **Get** /answer/admin/api/theme/options | Get theme options
|
|
*AdminApi* | [**AnswerAdminApiUserPasswordPut**](docs/AdminApi.md#answeradminapiuserpasswordput) | **Put** /answer/admin/api/user/password | update user password
|
|
*AdminApi* | [**AnswerAdminApiUserPost**](docs/AdminApi.md#answeradminapiuserpost) | **Post** /answer/admin/api/user | add user
|
|
*AdminApi* | [**AnswerAdminApiUserRolePut**](docs/AdminApi.md#answeradminapiuserroleput) | **Put** /answer/admin/api/user/role | update user role
|
|
*AdminApi* | [**AnswerAdminApiUserStatusPut**](docs/AdminApi.md#answeradminapiuserstatusput) | **Put** /answer/admin/api/user/status | update user
|
|
*AdminApi* | [**AnswerAdminApiUsersPageGet**](docs/AdminApi.md#answeradminapiuserspageget) | **Get** /answer/admin/api/users/page | get user page
|
|
*ApiAnswerApi* | [**AnswerApiV1AnswerAcceptancePost**](docs/ApiAnswerApi.md#answerapiv1answeracceptancepost) | **Post** /answer/api/v1/answer/acceptance | Accepted
|
|
*ApiAnswerApi* | [**AnswerApiV1AnswerDelete**](docs/ApiAnswerApi.md#answerapiv1answerdelete) | **Delete** /answer/api/v1/answer | delete answer
|
|
*ApiAnswerApi* | [**AnswerApiV1AnswerInfoGet**](docs/ApiAnswerApi.md#answerapiv1answerinfoget) | **Get** /answer/api/v1/answer/info | Get Answer
|
|
*ApiAnswerApi* | [**AnswerApiV1AnswerPageGet**](docs/ApiAnswerApi.md#answerapiv1answerpageget) | **Get** /answer/api/v1/answer/page | AnswerList
|
|
*ApiAnswerApi* | [**AnswerApiV1AnswerPost**](docs/ApiAnswerApi.md#answerapiv1answerpost) | **Post** /answer/api/v1/answer | Insert Answer
|
|
*ApiAnswerApi* | [**AnswerApiV1AnswerPut**](docs/ApiAnswerApi.md#answerapiv1answerput) | **Put** /answer/api/v1/answer | Update Answer
|
|
*ApiAnswerApi* | [**AnswerApiV1PersonalAnswerPageGet**](docs/ApiAnswerApi.md#answerapiv1personalanswerpageget) | **Get** /answer/api/v1/personal/answer/page | UserAnswerList
|
|
*CollectionApi* | [**AnswerApiV1CollectionSwitchPost**](docs/CollectionApi.md#answerapiv1collectionswitchpost) | **Post** /answer/api/v1/collection/switch | add collection
|
|
*CollectionApi* | [**AnswerApiV1PersonalCollectionPageGet**](docs/CollectionApi.md#answerapiv1personalcollectionpageget) | **Get** /answer/api/v1/personal/collection/page | UserCollectionList
|
|
*CommentApi* | [**AnswerApiV1ActivityTimelineDetailGet**](docs/CommentApi.md#answerapiv1activitytimelinedetailget) | **Get** /answer/api/v1/activity/timeline/detail | get object timeline detail
|
|
*CommentApi* | [**AnswerApiV1ActivityTimelineGet**](docs/CommentApi.md#answerapiv1activitytimelineget) | **Get** /answer/api/v1/activity/timeline | get object timeline
|
|
*CommentApi* | [**AnswerApiV1CommentDelete**](docs/CommentApi.md#answerapiv1commentdelete) | **Delete** /answer/api/v1/comment | remove comment
|
|
*CommentApi* | [**AnswerApiV1CommentGet**](docs/CommentApi.md#answerapiv1commentget) | **Get** /answer/api/v1/comment | get comment by id
|
|
*CommentApi* | [**AnswerApiV1CommentPageGet**](docs/CommentApi.md#answerapiv1commentpageget) | **Get** /answer/api/v1/comment/page | get comment page
|
|
*CommentApi* | [**AnswerApiV1CommentPost**](docs/CommentApi.md#answerapiv1commentpost) | **Post** /answer/api/v1/comment | add comment
|
|
*CommentApi* | [**AnswerApiV1CommentPut**](docs/CommentApi.md#answerapiv1commentput) | **Put** /answer/api/v1/comment | update comment
|
|
*CommentApi* | [**AnswerApiV1PersonalCommentPageGet**](docs/CommentApi.md#answerapiv1personalcommentpageget) | **Get** /answer/api/v1/personal/comment/page | user personal comment list
|
|
*InstallationApi* | [**InstallationBaseInfoPost**](docs/InstallationApi.md#installationbaseinfopost) | **Post** /installation/base-info | init base info
|
|
*InstallationApi* | [**InstallationConfigFileCheckPost**](docs/InstallationApi.md#installationconfigfilecheckpost) | **Post** /installation/config-file/check | check config file if exist when installation
|
|
*InstallationApi* | [**InstallationDbCheckPost**](docs/InstallationApi.md#installationdbcheckpost) | **Post** /installation/db/check | check database if exist when installation
|
|
*InstallationApi* | [**InstallationInitPost**](docs/InstallationApi.md#installationinitpost) | **Post** /installation/init | init environment
|
|
*InstallationApi* | [**RootGet**](docs/InstallationApi.md#rootget) | **Get** / | if config file not exist try to redirect to install page
|
|
*LangApi* | [**AnswerAdminApiLanguageOptionsGet**](docs/LangApi.md#answeradminapilanguageoptionsget) | **Get** /answer/admin/api/language/options | Get language options
|
|
*LangApi* | [**AnswerApiV1LanguageConfigGet**](docs/LangApi.md#answerapiv1languageconfigget) | **Get** /answer/api/v1/language/config | get language config mapping
|
|
*LangApi* | [**AnswerApiV1LanguageOptionsGet**](docs/LangApi.md#answerapiv1languageoptionsget) | **Get** /answer/api/v1/language/options | Get language options
|
|
*LangApi* | [**InstallationLanguageOptionsGet**](docs/LangApi.md#installationlanguageoptionsget) | **Get** /installation/language/options | get installation language options
|
|
*NotificationApi* | [**AnswerApiV1NotificationPageGet**](docs/NotificationApi.md#answerapiv1notificationpageget) | **Get** /answer/api/v1/notification/page | get notification list
|
|
*NotificationApi* | [**AnswerApiV1NotificationReadStateAllPut**](docs/NotificationApi.md#answerapiv1notificationreadstateallput) | **Put** /answer/api/v1/notification/read/state/all | ClearUnRead
|
|
*NotificationApi* | [**AnswerApiV1NotificationReadStatePut**](docs/NotificationApi.md#answerapiv1notificationreadstateput) | **Put** /answer/api/v1/notification/read/state | ClearUnRead
|
|
*NotificationApi* | [**AnswerApiV1NotificationStatusGet**](docs/NotificationApi.md#answerapiv1notificationstatusget) | **Get** /answer/api/v1/notification/status | GetRedDot
|
|
*NotificationApi* | [**AnswerApiV1NotificationStatusPut**](docs/NotificationApi.md#answerapiv1notificationstatusput) | **Put** /answer/api/v1/notification/status | DelRedDot
|
|
*QuestionApi* | [**AnswerApiV1PersonalQaTopGet**](docs/QuestionApi.md#answerapiv1personalqatopget) | **Get** /answer/api/v1/personal/qa/top | UserTop
|
|
*QuestionApi* | [**AnswerApiV1QuestionAnswerPost**](docs/QuestionApi.md#answerapiv1questionanswerpost) | **Post** /answer/api/v1/question/answer | add question and answer
|
|
*QuestionApi* | [**AnswerApiV1QuestionClosemsglistGet**](docs/QuestionApi.md#answerapiv1questionclosemsglistget) | **Get** /answer/api/v1/question/closemsglist | close question msg list
|
|
*QuestionApi* | [**AnswerApiV1QuestionDelete**](docs/QuestionApi.md#answerapiv1questiondelete) | **Delete** /answer/api/v1/question | delete question
|
|
*QuestionApi* | [**AnswerApiV1QuestionInfoGet**](docs/QuestionApi.md#answerapiv1questioninfoget) | **Get** /answer/api/v1/question/info | get question details
|
|
*QuestionApi* | [**AnswerApiV1QuestionOperationPut**](docs/QuestionApi.md#answerapiv1questionoperationput) | **Put** /answer/api/v1/question/operation | Operation question
|
|
*QuestionApi* | [**AnswerApiV1QuestionPageGet**](docs/QuestionApi.md#answerapiv1questionpageget) | **Get** /answer/api/v1/question/page | get questions by page
|
|
*QuestionApi* | [**AnswerApiV1QuestionPost**](docs/QuestionApi.md#answerapiv1questionpost) | **Post** /answer/api/v1/question | add question
|
|
*QuestionApi* | [**AnswerApiV1QuestionPut**](docs/QuestionApi.md#answerapiv1questionput) | **Put** /answer/api/v1/question | update question
|
|
*QuestionApi* | [**AnswerApiV1QuestionReopenPut**](docs/QuestionApi.md#answerapiv1questionreopenput) | **Put** /answer/api/v1/question/reopen | reopen question
|
|
*QuestionApi* | [**AnswerApiV1QuestionSimilarGet**](docs/QuestionApi.md#answerapiv1questionsimilarget) | **Get** /answer/api/v1/question/similar | add question title like
|
|
*QuestionApi* | [**AnswerApiV1QuestionSimilarTagGet**](docs/QuestionApi.md#answerapiv1questionsimilartagget) | **Get** /answer/api/v1/question/similar/tag | Search Similar Question
|
|
*QuestionApi* | [**AnswerApiV1QuestionStatusPut**](docs/QuestionApi.md#answerapiv1questionstatusput) | **Put** /answer/api/v1/question/status | Close question
|
|
*QuestionApi* | [**PersonalQuestionPageGet**](docs/QuestionApi.md#personalquestionpageget) | **Get** /personal/question/page | UserList
|
|
*RankApi* | [**AnswerApiV1PersonalRankPageGet**](docs/RankApi.md#answerapiv1personalrankpageget) | **Get** /answer/api/v1/personal/rank/page | user personal rank list
|
|
*ReasonApi* | [**AnswerAdminApiReasonsGet**](docs/ReasonApi.md#answeradminapireasonsget) | **Get** /answer/admin/api/reasons | get reasons by object type and action
|
|
*ReasonApi* | [**AnswerApiV1ReasonsGet**](docs/ReasonApi.md#answerapiv1reasonsget) | **Get** /answer/api/v1/reasons | get reasons by object type and action
|
|
*ReportApi* | [**AnswerApiV1ReportPost**](docs/ReportApi.md#answerapiv1reportpost) | **Post** /answer/api/v1/report | add report
|
|
*ReportApi* | [**AnswerApiV1ReportTypeListGet**](docs/ReportApi.md#answerapiv1reporttypelistget) | **Get** /answer/api/v1/report/type/list | get report type list
|
|
*RevisionApi* | [**AnswerApiV1RevisionsAuditPut**](docs/RevisionApi.md#answerapiv1revisionsauditput) | **Put** /answer/api/v1/revisions/audit | revision audit
|
|
*RevisionApi* | [**AnswerApiV1RevisionsEditCheckGet**](docs/RevisionApi.md#answerapiv1revisionseditcheckget) | **Get** /answer/api/v1/revisions/edit/check | check can update revision
|
|
*RevisionApi* | [**AnswerApiV1RevisionsGet**](docs/RevisionApi.md#answerapiv1revisionsget) | **Get** /answer/api/v1/revisions | get revision list
|
|
*RevisionApi* | [**AnswerApiV1RevisionsUnreviewedGet**](docs/RevisionApi.md#answerapiv1revisionsunreviewedget) | **Get** /answer/api/v1/revisions/unreviewed | get unreviewed revision list
|
|
*SearchApi* | [**AnswerApiV1SearchGet**](docs/SearchApi.md#answerapiv1searchget) | **Get** /answer/api/v1/search | search object
|
|
*SiteApi* | [**AnswerApiV1SiteinfoGet**](docs/SiteApi.md#answerapiv1siteinfoget) | **Get** /answer/api/v1/siteinfo | get site info
|
|
*SiteApi* | [**AnswerApiV1SiteinfoLegalGet**](docs/SiteApi.md#answerapiv1siteinfolegalget) | **Get** /answer/api/v1/siteinfo/legal | get site legal info
|
|
*SiteApi* | [**CustomCssGet**](docs/SiteApi.md#customcssget) | **Get** /custom.css | get site robots information
|
|
*SiteApi* | [**RobotsTxtGet**](docs/SiteApi.md#robotstxtget) | **Get** /robots.txt | get site robots information
|
|
*TagApi* | [**AnswerApiV1QuestionTagsGet**](docs/TagApi.md#answerapiv1questiontagsget) | **Get** /answer/api/v1/question/tags | get tag list
|
|
*TagApi* | [**AnswerApiV1TagDelete**](docs/TagApi.md#answerapiv1tagdelete) | **Delete** /answer/api/v1/tag | delete tag
|
|
*TagApi* | [**AnswerApiV1TagGet**](docs/TagApi.md#answerapiv1tagget) | **Get** /answer/api/v1/tag | get tag one
|
|
*TagApi* | [**AnswerApiV1TagPost**](docs/TagApi.md#answerapiv1tagpost) | **Post** /answer/api/v1/tag | add tag
|
|
*TagApi* | [**AnswerApiV1TagPut**](docs/TagApi.md#answerapiv1tagput) | **Put** /answer/api/v1/tag | update tag
|
|
*TagApi* | [**AnswerApiV1TagSynonymPut**](docs/TagApi.md#answerapiv1tagsynonymput) | **Put** /answer/api/v1/tag/synonym | update tag
|
|
*TagApi* | [**AnswerApiV1TagSynonymsGet**](docs/TagApi.md#answerapiv1tagsynonymsget) | **Get** /answer/api/v1/tag/synonyms | get tag synonyms
|
|
*TagApi* | [**AnswerApiV1TagsFollowingGet**](docs/TagApi.md#answerapiv1tagsfollowingget) | **Get** /answer/api/v1/tags/following | get following tag list
|
|
*TagApi* | [**AnswerApiV1TagsGet**](docs/TagApi.md#answerapiv1tagsget) | **Get** /answer/api/v1/tags | get tags list
|
|
*TagApi* | [**AnswerApiV1TagsPageGet**](docs/TagApi.md#answerapiv1tagspageget) | **Get** /answer/api/v1/tags/page | get tag page
|
|
*UploadApi* | [**AnswerApiV1FilePost**](docs/UploadApi.md#answerapiv1filepost) | **Post** /answer/api/v1/file | upload file
|
|
*UploadApi* | [**AnswerApiV1PostRenderPost**](docs/UploadApi.md#answerapiv1postrenderpost) | **Post** /answer/api/v1/post/render | render post content
|
|
*UserApi* | [**AnswerApiV1PersonalUserInfoGet**](docs/UserApi.md#answerapiv1personaluserinfoget) | **Get** /answer/api/v1/personal/user/info | GetOtherUserInfoByUsername
|
|
*UserApi* | [**AnswerApiV1UserActionRecordGet**](docs/UserApi.md#answerapiv1useractionrecordget) | **Get** /answer/api/v1/user/action/record | ActionRecord
|
|
*UserApi* | [**AnswerApiV1UserEmailChangeCodePost**](docs/UserApi.md#answerapiv1useremailchangecodepost) | **Post** /answer/api/v1/user/email/change/code | send email to the user email then change their email
|
|
*UserApi* | [**AnswerApiV1UserEmailNotificationPut**](docs/UserApi.md#answerapiv1useremailnotificationput) | **Put** /answer/api/v1/user/email/notification | unsubscribe email notification
|
|
*UserApi* | [**AnswerApiV1UserEmailPut**](docs/UserApi.md#answerapiv1useremailput) | **Put** /answer/api/v1/user/email | user change email verification
|
|
*UserApi* | [**AnswerApiV1UserEmailVerificationPost**](docs/UserApi.md#answerapiv1useremailverificationpost) | **Post** /answer/api/v1/user/email/verification | UserVerifyEmail
|
|
*UserApi* | [**AnswerApiV1UserEmailVerificationSendPost**](docs/UserApi.md#answerapiv1useremailverificationsendpost) | **Post** /answer/api/v1/user/email/verification/send | UserVerifyEmailSend
|
|
*UserApi* | [**AnswerApiV1UserInfoGet**](docs/UserApi.md#answerapiv1userinfoget) | **Get** /answer/api/v1/user/info | GetUserInfoByUserID
|
|
*UserApi* | [**AnswerApiV1UserInfoPut**](docs/UserApi.md#answerapiv1userinfoput) | **Put** /answer/api/v1/user/info | UserUpdateInfo update user info
|
|
*UserApi* | [**AnswerApiV1UserInterfacePut**](docs/UserApi.md#answerapiv1userinterfaceput) | **Put** /answer/api/v1/user/interface | UserUpdateInterface update user interface config
|
|
*UserApi* | [**AnswerApiV1UserLoginEmailPost**](docs/UserApi.md#answerapiv1userloginemailpost) | **Post** /answer/api/v1/user/login/email | UserEmailLogin
|
|
*UserApi* | [**AnswerApiV1UserLogoutGet**](docs/UserApi.md#answerapiv1userlogoutget) | **Get** /answer/api/v1/user/logout | user logout
|
|
*UserApi* | [**AnswerApiV1UserNoticeSetPost**](docs/UserApi.md#answerapiv1usernoticesetpost) | **Post** /answer/api/v1/user/notice/set | UserNoticeSet
|
|
*UserApi* | [**AnswerApiV1UserPasswordPut**](docs/UserApi.md#answerapiv1userpasswordput) | **Put** /answer/api/v1/user/password | UserModifyPassWord
|
|
*UserApi* | [**AnswerApiV1UserPasswordReplacementPost**](docs/UserApi.md#answerapiv1userpasswordreplacementpost) | **Post** /answer/api/v1/user/password/replacement | UseRePassWord
|
|
*UserApi* | [**AnswerApiV1UserPasswordResetPost**](docs/UserApi.md#answerapiv1userpasswordresetpost) | **Post** /answer/api/v1/user/password/reset | RetrievePassWord
|
|
*UserApi* | [**AnswerApiV1UserRankingGet**](docs/UserApi.md#answerapiv1userrankingget) | **Get** /answer/api/v1/user/ranking | get user ranking
|
|
*UserApi* | [**AnswerApiV1UserRegisterCaptchaGet**](docs/UserApi.md#answerapiv1userregistercaptchaget) | **Get** /answer/api/v1/user/register/captcha | UserRegisterCaptcha
|
|
*UserApi* | [**AnswerApiV1UserRegisterEmailPost**](docs/UserApi.md#answerapiv1userregisteremailpost) | **Post** /answer/api/v1/user/register/email | UserRegisterByEmail
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [AnswerAdminApiRolesGet200Response](docs/AnswerAdminApiRolesGet200Response.md)
|
|
- [AnswerAdminApiSettingSmtpGet200Response](docs/AnswerAdminApiSettingSmtpGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoBrandingGet200Response](docs/AnswerAdminApiSiteinfoBrandingGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoCustomCssHtmlGet200Response](docs/AnswerAdminApiSiteinfoCustomCssHtmlGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoGeneralGet200Response](docs/AnswerAdminApiSiteinfoGeneralGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoInterfaceGet200Response](docs/AnswerAdminApiSiteinfoInterfaceGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoLegalGet200Response](docs/AnswerAdminApiSiteinfoLegalGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoLoginGet200Response](docs/AnswerAdminApiSiteinfoLoginGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoSeoGet200Response](docs/AnswerAdminApiSiteinfoSeoGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoThemeGet200Response](docs/AnswerAdminApiSiteinfoThemeGet200Response.md)
|
|
- [AnswerAdminApiSiteinfoWriteGet200Response](docs/AnswerAdminApiSiteinfoWriteGet200Response.md)
|
|
- [AnswerAdminApiUsersPageGet200Response](docs/AnswerAdminApiUsersPageGet200Response.md)
|
|
- [AnswerAdminApiUsersPageGet200ResponseData](docs/AnswerAdminApiUsersPageGet200ResponseData.md)
|
|
- [AnswerAdminApiUsersPageGet200ResponseDataAllOf](docs/AnswerAdminApiUsersPageGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1ActivityTimelineGet200Response](docs/AnswerApiV1ActivityTimelineGet200Response.md)
|
|
- [AnswerApiV1CollectionSwitchPost200Response](docs/AnswerApiV1CollectionSwitchPost200Response.md)
|
|
- [AnswerApiV1CommentGet200Response](docs/AnswerApiV1CommentGet200Response.md)
|
|
- [AnswerApiV1CommentGet200ResponseData](docs/AnswerApiV1CommentGet200ResponseData.md)
|
|
- [AnswerApiV1CommentGet200ResponseDataAllOf](docs/AnswerApiV1CommentGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1CommentPost200Response](docs/AnswerApiV1CommentPost200Response.md)
|
|
- [AnswerApiV1FilePost200Response](docs/AnswerApiV1FilePost200Response.md)
|
|
- [AnswerApiV1FollowPost200Response](docs/AnswerApiV1FollowPost200Response.md)
|
|
- [AnswerApiV1PersonalCommentPageGet200Response](docs/AnswerApiV1PersonalCommentPageGet200Response.md)
|
|
- [AnswerApiV1PersonalCommentPageGet200ResponseData](docs/AnswerApiV1PersonalCommentPageGet200ResponseData.md)
|
|
- [AnswerApiV1PersonalCommentPageGet200ResponseDataAllOf](docs/AnswerApiV1PersonalCommentPageGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1PersonalRankPageGet200Response](docs/AnswerApiV1PersonalRankPageGet200Response.md)
|
|
- [AnswerApiV1PersonalRankPageGet200ResponseData](docs/AnswerApiV1PersonalRankPageGet200ResponseData.md)
|
|
- [AnswerApiV1PersonalRankPageGet200ResponseDataAllOf](docs/AnswerApiV1PersonalRankPageGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1PersonalUserInfoGet200Response](docs/AnswerApiV1PersonalUserInfoGet200Response.md)
|
|
- [AnswerApiV1PersonalVotePageGet200Response](docs/AnswerApiV1PersonalVotePageGet200Response.md)
|
|
- [AnswerApiV1PersonalVotePageGet200ResponseData](docs/AnswerApiV1PersonalVotePageGet200ResponseData.md)
|
|
- [AnswerApiV1PersonalVotePageGet200ResponseDataAllOf](docs/AnswerApiV1PersonalVotePageGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1QuestionPageGet200Response](docs/AnswerApiV1QuestionPageGet200Response.md)
|
|
- [AnswerApiV1QuestionPageGet200ResponseData](docs/AnswerApiV1QuestionPageGet200ResponseData.md)
|
|
- [AnswerApiV1QuestionPageGet200ResponseDataAllOf](docs/AnswerApiV1QuestionPageGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1QuestionTagsGet200Response](docs/AnswerApiV1QuestionTagsGet200Response.md)
|
|
- [AnswerApiV1ReportTypeListGet200Response](docs/AnswerApiV1ReportTypeListGet200Response.md)
|
|
- [AnswerApiV1RevisionsGet200Response](docs/AnswerApiV1RevisionsGet200Response.md)
|
|
- [AnswerApiV1RevisionsUnreviewedGet200Response](docs/AnswerApiV1RevisionsUnreviewedGet200Response.md)
|
|
- [AnswerApiV1RevisionsUnreviewedGet200ResponseData](docs/AnswerApiV1RevisionsUnreviewedGet200ResponseData.md)
|
|
- [AnswerApiV1RevisionsUnreviewedGet200ResponseDataAllOf](docs/AnswerApiV1RevisionsUnreviewedGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1SearchGet200Response](docs/AnswerApiV1SearchGet200Response.md)
|
|
- [AnswerApiV1SiteinfoGet200Response](docs/AnswerApiV1SiteinfoGet200Response.md)
|
|
- [AnswerApiV1SiteinfoLegalGet200Response](docs/AnswerApiV1SiteinfoLegalGet200Response.md)
|
|
- [AnswerApiV1TagGet200Response](docs/AnswerApiV1TagGet200Response.md)
|
|
- [AnswerApiV1TagSynonymsGet200Response](docs/AnswerApiV1TagSynonymsGet200Response.md)
|
|
- [AnswerApiV1TagsFollowingGet200Response](docs/AnswerApiV1TagsFollowingGet200Response.md)
|
|
- [AnswerApiV1TagsPageGet200Response](docs/AnswerApiV1TagsPageGet200Response.md)
|
|
- [AnswerApiV1TagsPageGet200ResponseData](docs/AnswerApiV1TagsPageGet200ResponseData.md)
|
|
- [AnswerApiV1TagsPageGet200ResponseDataAllOf](docs/AnswerApiV1TagsPageGet200ResponseDataAllOf.md)
|
|
- [AnswerApiV1UserActionRecordGet200Response](docs/AnswerApiV1UserActionRecordGet200Response.md)
|
|
- [AnswerApiV1UserEmailVerificationPost200Response](docs/AnswerApiV1UserEmailVerificationPost200Response.md)
|
|
- [AnswerApiV1UserInfoGet200Response](docs/AnswerApiV1UserInfoGet200Response.md)
|
|
- [AnswerApiV1UserNoticeSetPost200Response](docs/AnswerApiV1UserNoticeSetPost200Response.md)
|
|
- [AnswerApiV1UserRankingGet200Response](docs/AnswerApiV1UserRankingGet200Response.md)
|
|
- [AnswerApiV1VoteDownPost200Response](docs/AnswerApiV1VoteDownPost200Response.md)
|
|
- [HandlerRespBody](docs/HandlerRespBody.md)
|
|
- [InstallCheckConfigFileResp](docs/InstallCheckConfigFileResp.md)
|
|
- [InstallCheckDatabaseReq](docs/InstallCheckDatabaseReq.md)
|
|
- [InstallInitBaseInfoReq](docs/InstallInitBaseInfoReq.md)
|
|
- [InstallationConfigFileCheckPost200Response](docs/InstallationConfigFileCheckPost200Response.md)
|
|
- [InstallationLanguageOptionsGet200Response](docs/InstallationLanguageOptionsGet200Response.md)
|
|
- [PagerPageModel](docs/PagerPageModel.md)
|
|
- [SchemaActObjectInfo](docs/SchemaActObjectInfo.md)
|
|
- [SchemaActObjectTimeline](docs/SchemaActObjectTimeline.md)
|
|
- [SchemaActionRecordResp](docs/SchemaActionRecordResp.md)
|
|
- [SchemaAddCommentReq](docs/SchemaAddCommentReq.md)
|
|
- [SchemaAddReportReq](docs/SchemaAddReportReq.md)
|
|
- [SchemaAddTagReq](docs/SchemaAddTagReq.md)
|
|
- [SchemaAddUserReq](docs/SchemaAddUserReq.md)
|
|
- [SchemaAdminSetAnswerStatusRequest](docs/SchemaAdminSetAnswerStatusRequest.md)
|
|
- [SchemaAdminSetQuestionStatusRequest](docs/SchemaAdminSetQuestionStatusRequest.md)
|
|
- [SchemaAnswerAcceptedReq](docs/SchemaAnswerAcceptedReq.md)
|
|
- [SchemaAnswerAddReq](docs/SchemaAnswerAddReq.md)
|
|
- [SchemaAnswerUpdateReq](docs/SchemaAnswerUpdateReq.md)
|
|
- [SchemaAvatarInfo](docs/SchemaAvatarInfo.md)
|
|
- [SchemaCloseQuestionReq](docs/SchemaCloseQuestionReq.md)
|
|
- [SchemaCollectionSwitchReq](docs/SchemaCollectionSwitchReq.md)
|
|
- [SchemaCollectionSwitchResp](docs/SchemaCollectionSwitchResp.md)
|
|
- [SchemaFollowReq](docs/SchemaFollowReq.md)
|
|
- [SchemaFollowResp](docs/SchemaFollowResp.md)
|
|
- [SchemaGetCommentPersonalWithPageResp](docs/SchemaGetCommentPersonalWithPageResp.md)
|
|
- [SchemaGetCommentResp](docs/SchemaGetCommentResp.md)
|
|
- [SchemaGetFollowingTagsResp](docs/SchemaGetFollowingTagsResp.md)
|
|
- [SchemaGetObjectTimelineResp](docs/SchemaGetObjectTimelineResp.md)
|
|
- [SchemaGetOtherUserInfoByUsernameResp](docs/SchemaGetOtherUserInfoByUsernameResp.md)
|
|
- [SchemaGetOtherUserInfoResp](docs/SchemaGetOtherUserInfoResp.md)
|
|
- [SchemaGetRankPersonalWithPageResp](docs/SchemaGetRankPersonalWithPageResp.md)
|
|
- [SchemaGetReportTypeResp](docs/SchemaGetReportTypeResp.md)
|
|
- [SchemaGetRevisionResp](docs/SchemaGetRevisionResp.md)
|
|
- [SchemaGetRoleResp](docs/SchemaGetRoleResp.md)
|
|
- [SchemaGetSMTPConfigResp](docs/SchemaGetSMTPConfigResp.md)
|
|
- [SchemaGetSiteLegalInfoResp](docs/SchemaGetSiteLegalInfoResp.md)
|
|
- [SchemaGetTagPageResp](docs/SchemaGetTagPageResp.md)
|
|
- [SchemaGetTagResp](docs/SchemaGetTagResp.md)
|
|
- [SchemaGetTagSynonymsResp](docs/SchemaGetTagSynonymsResp.md)
|
|
- [SchemaGetUnreviewedRevisionResp](docs/SchemaGetUnreviewedRevisionResp.md)
|
|
- [SchemaGetUserPageResp](docs/SchemaGetUserPageResp.md)
|
|
- [SchemaGetUserResp](docs/SchemaGetUserResp.md)
|
|
- [SchemaGetUserToSetShowResp](docs/SchemaGetUserToSetShowResp.md)
|
|
- [SchemaGetVoteWithPageResp](docs/SchemaGetVoteWithPageResp.md)
|
|
- [SchemaNotificationClearIDRequest](docs/SchemaNotificationClearIDRequest.md)
|
|
- [SchemaNotificationClearRequest](docs/SchemaNotificationClearRequest.md)
|
|
- [SchemaOperationQuestionReq](docs/SchemaOperationQuestionReq.md)
|
|
- [SchemaPermissionMemberAction](docs/SchemaPermissionMemberAction.md)
|
|
- [SchemaPostRenderReq](docs/SchemaPostRenderReq.md)
|
|
- [SchemaQuestionAdd](docs/SchemaQuestionAdd.md)
|
|
- [SchemaQuestionAddByAnswer](docs/SchemaQuestionAddByAnswer.md)
|
|
- [SchemaQuestionPageReq](docs/SchemaQuestionPageReq.md)
|
|
- [SchemaQuestionPageResp](docs/SchemaQuestionPageResp.md)
|
|
- [SchemaQuestionPageRespOperator](docs/SchemaQuestionPageRespOperator.md)
|
|
- [SchemaQuestionUpdate](docs/SchemaQuestionUpdate.md)
|
|
- [SchemaRemoveAnswerReq](docs/SchemaRemoveAnswerReq.md)
|
|
- [SchemaRemoveCommentReq](docs/SchemaRemoveCommentReq.md)
|
|
- [SchemaRemoveQuestionReq](docs/SchemaRemoveQuestionReq.md)
|
|
- [SchemaRemoveTagReq](docs/SchemaRemoveTagReq.md)
|
|
- [SchemaReopenQuestionReq](docs/SchemaReopenQuestionReq.md)
|
|
- [SchemaReportHandleReq](docs/SchemaReportHandleReq.md)
|
|
- [SchemaRevisionAuditReq](docs/SchemaRevisionAuditReq.md)
|
|
- [SchemaSearchListResp](docs/SchemaSearchListResp.md)
|
|
- [SchemaSearchObject](docs/SchemaSearchObject.md)
|
|
- [SchemaSearchResp](docs/SchemaSearchResp.md)
|
|
- [SchemaSiteBrandingReq](docs/SchemaSiteBrandingReq.md)
|
|
- [SchemaSiteBrandingResp](docs/SchemaSiteBrandingResp.md)
|
|
- [SchemaSiteCustomCssHTMLReq](docs/SchemaSiteCustomCssHTMLReq.md)
|
|
- [SchemaSiteCustomCssHTMLResp](docs/SchemaSiteCustomCssHTMLResp.md)
|
|
- [SchemaSiteGeneralReq](docs/SchemaSiteGeneralReq.md)
|
|
- [SchemaSiteGeneralResp](docs/SchemaSiteGeneralResp.md)
|
|
- [SchemaSiteInfoResp](docs/SchemaSiteInfoResp.md)
|
|
- [SchemaSiteInterfaceReq](docs/SchemaSiteInterfaceReq.md)
|
|
- [SchemaSiteInterfaceResp](docs/SchemaSiteInterfaceResp.md)
|
|
- [SchemaSiteLegalReq](docs/SchemaSiteLegalReq.md)
|
|
- [SchemaSiteLegalResp](docs/SchemaSiteLegalResp.md)
|
|
- [SchemaSiteLoginReq](docs/SchemaSiteLoginReq.md)
|
|
- [SchemaSiteLoginResp](docs/SchemaSiteLoginResp.md)
|
|
- [SchemaSiteSeoReq](docs/SchemaSiteSeoReq.md)
|
|
- [SchemaSiteSeoResp](docs/SchemaSiteSeoResp.md)
|
|
- [SchemaSiteThemeReq](docs/SchemaSiteThemeReq.md)
|
|
- [SchemaSiteThemeResp](docs/SchemaSiteThemeResp.md)
|
|
- [SchemaSiteWriteReq](docs/SchemaSiteWriteReq.md)
|
|
- [SchemaSiteWriteResp](docs/SchemaSiteWriteResp.md)
|
|
- [SchemaTagItem](docs/SchemaTagItem.md)
|
|
- [SchemaTagResp](docs/SchemaTagResp.md)
|
|
- [SchemaTagSynonym](docs/SchemaTagSynonym.md)
|
|
- [SchemaThemeOption](docs/SchemaThemeOption.md)
|
|
- [SchemaUnreviewedRevisionInfoInfo](docs/SchemaUnreviewedRevisionInfoInfo.md)
|
|
- [SchemaUpdateCommentReq](docs/SchemaUpdateCommentReq.md)
|
|
- [SchemaUpdateFollowTagsReq](docs/SchemaUpdateFollowTagsReq.md)
|
|
- [SchemaUpdateInfoRequest](docs/SchemaUpdateInfoRequest.md)
|
|
- [SchemaUpdateSMTPConfigReq](docs/SchemaUpdateSMTPConfigReq.md)
|
|
- [SchemaUpdateTagReq](docs/SchemaUpdateTagReq.md)
|
|
- [SchemaUpdateTagSynonymReq](docs/SchemaUpdateTagSynonymReq.md)
|
|
- [SchemaUpdateUserInterfaceRequest](docs/SchemaUpdateUserInterfaceRequest.md)
|
|
- [SchemaUpdateUserPasswordReq](docs/SchemaUpdateUserPasswordReq.md)
|
|
- [SchemaUpdateUserRoleReq](docs/SchemaUpdateUserRoleReq.md)
|
|
- [SchemaUpdateUserStatusReq](docs/SchemaUpdateUserStatusReq.md)
|
|
- [SchemaUserBasicInfo](docs/SchemaUserBasicInfo.md)
|
|
- [SchemaUserChangeEmailSendCodeReq](docs/SchemaUserChangeEmailSendCodeReq.md)
|
|
- [SchemaUserChangeEmailVerifyReq](docs/SchemaUserChangeEmailVerifyReq.md)
|
|
- [SchemaUserEmailLogin](docs/SchemaUserEmailLogin.md)
|
|
- [SchemaUserModifyPassWordRequest](docs/SchemaUserModifyPassWordRequest.md)
|
|
- [SchemaUserNoticeSetRequest](docs/SchemaUserNoticeSetRequest.md)
|
|
- [SchemaUserNoticeSetResp](docs/SchemaUserNoticeSetResp.md)
|
|
- [SchemaUserRankingResp](docs/SchemaUserRankingResp.md)
|
|
- [SchemaUserRankingSimpleInfo](docs/SchemaUserRankingSimpleInfo.md)
|
|
- [SchemaUserRePassWordRequest](docs/SchemaUserRePassWordRequest.md)
|
|
- [SchemaUserRegisterReq](docs/SchemaUserRegisterReq.md)
|
|
- [SchemaUserRetrievePassWordRequest](docs/SchemaUserRetrievePassWordRequest.md)
|
|
- [SchemaVoteReq](docs/SchemaVoteReq.md)
|
|
- [SchemaVoteResp](docs/SchemaVoteResp.md)
|
|
- [TranslatorLangOption](docs/TranslatorLangOption.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
### ApiKeyAuth
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: Authorization
|
|
- **Location**: HTTP header
|
|
|
|
Note, each API key must be added to a map of `map[string]APIKey` where the key is: Authorization and passed in as the auth context for each request.
|
|
|
|
|
|
## Documentation for Utility Methods
|
|
|
|
Due to the fact that model structure members are all pointers, this package contains
|
|
a number of utility functions to easily obtain pointers to values of basic types.
|
|
Each of these functions takes a value of the given basic type and returns a pointer to it:
|
|
|
|
* `PtrBool`
|
|
* `PtrInt`
|
|
* `PtrInt32`
|
|
* `PtrInt64`
|
|
* `PtrFloat`
|
|
* `PtrFloat32`
|
|
* `PtrFloat64`
|
|
* `PtrString`
|
|
* `PtrTime`
|
|
|
|
## Author
|
|
|
|
|
|
|