262 lines
6.2 KiB
Markdown
262 lines
6.2 KiB
Markdown
# \SiteAPI
|
|
|
|
All URIs are relative to *http://localhost*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**AnswerApiV1SiteinfoGet**](SiteAPI.md#AnswerApiV1SiteinfoGet) | **Get** /answer/api/v1/siteinfo | get site info
|
|
[**AnswerApiV1SiteinfoLegalGet**](SiteAPI.md#AnswerApiV1SiteinfoLegalGet) | **Get** /answer/api/v1/siteinfo/legal | get site legal info
|
|
[**CustomCssGet**](SiteAPI.md#CustomCssGet) | **Get** /custom.css | get site robots information
|
|
[**RobotsTxtGet**](SiteAPI.md#RobotsTxtGet) | **Get** /robots.txt | get site robots information
|
|
|
|
|
|
|
|
## AnswerApiV1SiteinfoGet
|
|
|
|
> AnswerApiV1SiteinfoGet200Response AnswerApiV1SiteinfoGet(ctx).Execute()
|
|
|
|
get site info
|
|
|
|
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "git.ncc.cx/package/openapi-go-answer"
|
|
)
|
|
|
|
func main() {
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.SiteAPI.AnswerApiV1SiteinfoGet(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.AnswerApiV1SiteinfoGet``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `AnswerApiV1SiteinfoGet`: AnswerApiV1SiteinfoGet200Response
|
|
fmt.Fprintf(os.Stdout, "Response from `SiteAPI.AnswerApiV1SiteinfoGet`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiAnswerApiV1SiteinfoGetRequest struct via the builder pattern
|
|
|
|
|
|
### Return type
|
|
|
|
[**AnswerApiV1SiteinfoGet200Response**](AnswerApiV1SiteinfoGet200Response.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### 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)
|
|
|
|
|
|
## AnswerApiV1SiteinfoLegalGet
|
|
|
|
> AnswerApiV1SiteinfoLegalGet200Response AnswerApiV1SiteinfoLegalGet(ctx).InfoType(infoType).Execute()
|
|
|
|
get site legal info
|
|
|
|
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "git.ncc.cx/package/openapi-go-answer"
|
|
)
|
|
|
|
func main() {
|
|
infoType := "infoType_example" // string | legal information type
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.SiteAPI.AnswerApiV1SiteinfoLegalGet(context.Background()).InfoType(infoType).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.AnswerApiV1SiteinfoLegalGet``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `AnswerApiV1SiteinfoLegalGet`: AnswerApiV1SiteinfoLegalGet200Response
|
|
fmt.Fprintf(os.Stdout, "Response from `SiteAPI.AnswerApiV1SiteinfoLegalGet`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiAnswerApiV1SiteinfoLegalGetRequest struct via the builder pattern
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**infoType** | **string** | legal information type |
|
|
|
|
### Return type
|
|
|
|
[**AnswerApiV1SiteinfoLegalGet200Response**](AnswerApiV1SiteinfoLegalGet200Response.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### 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)
|
|
|
|
|
|
## CustomCssGet
|
|
|
|
> string CustomCssGet(ctx).Execute()
|
|
|
|
get site robots information
|
|
|
|
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "git.ncc.cx/package/openapi-go-answer"
|
|
)
|
|
|
|
func main() {
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.SiteAPI.CustomCssGet(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.CustomCssGet``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `CustomCssGet`: string
|
|
fmt.Fprintf(os.Stdout, "Response from `SiteAPI.CustomCssGet`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiCustomCssGetRequest struct via the builder pattern
|
|
|
|
|
|
### Return type
|
|
|
|
**string**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### 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)
|
|
|
|
|
|
## RobotsTxtGet
|
|
|
|
> string RobotsTxtGet(ctx).Execute()
|
|
|
|
get site robots information
|
|
|
|
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "git.ncc.cx/package/openapi-go-answer"
|
|
)
|
|
|
|
func main() {
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.SiteAPI.RobotsTxtGet(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `SiteAPI.RobotsTxtGet``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `RobotsTxtGet`: string
|
|
fmt.Fprintf(os.Stdout, "Response from `SiteAPI.RobotsTxtGet`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiRobotsTxtGetRequest struct via the builder pattern
|
|
|
|
|
|
### Return type
|
|
|
|
**string**
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### 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)
|
|
|