foxclient 6.1.0

Warning: Please add a custom user agent header to your requests. This would help us fighting against DDoS attacks in future, while keeping your application's access to the API. In future, this may be a mandatory requirement. To reduce the system load, the API endpoints are rate limited. The default limit is 30 requests per minute. Contact admin@orangefox.tech if you need a higher limit. The requests may be logged for analytics and development purposes.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

# \WikiApi

All URIs are relative to *https://api.orangefox.download*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_asset**](WikiApi.md#get_asset) | **GET** /wiki/{site}/assets/{path} | GET /wiki/{site}/assets/{path} - Serve asset bytes.
[**get_page**](WikiApi.md#get_page) | **GET** /wiki/{site}/pages/{path} | GET /wiki/{site}/pages/{path} - Fetch one published page.
[**get_site**](WikiApi.md#get_site) | **GET** /wiki/sites/{slug} | GET /wiki/sites/{slug} - Fetch one wiki site.
[**list_pages**](WikiApi.md#list_pages) | **GET** /wiki/{site}/pages | GET /wiki/{site}/pages - List every published page in a site.
[**list_sites**](WikiApi.md#list_sites) | **GET** /wiki/sites | GET /wiki/sites - List wiki sites.



## get_asset

> get_asset(site, path)
GET /wiki/{site}/assets/{path} - Serve asset bytes.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**site** | **String** | Site slug | [required] |
**path** | **String** | Asset path, e.g. images/waving.png | [required] |

### Return type

 (empty response body)

### 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)


## get_page

> models::WikiPageResponse get_page(site, path)
GET /wiki/{site}/pages/{path} - Fetch one published page.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**site** | **String** | Site slug | [required] |
**path** | **String** | Page path, e.g. Installation/Windows | [required] |

### Return type

[**models::WikiPageResponse**](WikiPageResponse.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)


## get_site

> models::WikiSiteResponse get_site(slug)
GET /wiki/sites/{slug} - Fetch one wiki site.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**slug** | **String** | Site slug | [required] |

### Return type

[**models::WikiSiteResponse**](WikiSiteResponse.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)


## list_pages

> models::ListResponseWikiPageShortResponse list_pages(site, skip, limit)
GET /wiki/{site}/pages - List every published page in a site.

FoxWiki builds its whole navigation tree from one call to this, so it returns the complete flat set (paged at the standard 1000 ceiling) rather than one folder's children.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**site** | **String** | Site slug | [required] |
**skip** | Option<**i64**> |  |  |
**limit** | Option<**i64**> |  |  |

### Return type

[**models::ListResponseWikiPageShortResponse**](ListResponse_WikiPageShortResponse.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)


## list_sites

> models::ListResponseWikiSiteResponse list_sites(skip, limit)
GET /wiki/sites - List wiki sites.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**skip** | Option<**i64**> |  |  |
**limit** | Option<**i64**> |  |  |

### Return type

[**models::ListResponseWikiSiteResponse**](ListResponse_WikiSiteResponse.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)