forked from Valandur/webapi-client-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommand_api.py
More file actions
355 lines (292 loc) · 16.9 KB
/
command_api.py
File metadata and controls
355 lines (292 loc) · 16.9 KB
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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# coding: utf-8
"""
Web-API
Access Sponge powered Minecraft servers through a WebAPI # Introduction This is the documentation of the various API routes offered by the WebAPI plugin. This documentation assumes that you are familiar with the basic concepts of Web API's, such as `GET`, `PUT`, `POST` and `DELETE` methods, request `HEADERS` and `RESPONSE CODES` and `JSON` data. By default this documentation can be found at http:/localhost:8080 (while your minecraft server is running) and the various routes start with http:/localhost:8080/api/v5... As a quick test try reaching the route http:/localhost:8080/api/v5/info (remember that you can only access \\\"localhost\\\" routes on the server on which you are running minecraft). This route should show you basic information about your server, like the motd and player count. # List endpoints Lots of objects offer an endpoint to list all objects (e.g. `GET: /world` to get all worlds). These endpoints return only the properties marked 'required' by default, because the list might be quite large. If you want to return ALL data for a list endpoint add the query parameter `details`, (e.g. `GET: /world?details`). > Remember that in this case the data returned by the endpoint might be quite large. # Debugging endpoints Apart from the `?details` flag you can also pass some other flags for debugging purposes. Remember that you must include the first query parameter with `?`, and further ones with `&`: `details`: Includes details for list endpoints `accept=[json/xml]`: Manually set the accept content type. This is good for browser testing, **BUT DON'T USE THIS IN PRODUCTION, YOU CAN SUPPLY THE `Accepts` HEADER FOR THAT** `pretty`: Pretty prints the data, also good for debugging in the browser. An example request might look like this: `http://localhost:8080/api/v5/world?details&accpet=json&pretty&key=MY-API-KEY` # Additional data Certain endpoints (such as `/player`, `/entity` and `/tile-entity` have additional properties which are not documented here, because the data depends on the concrete object type (eg. `Sheep` have a wool color, others do not) and on the other plugins/mods that are running on your server which might add additional data. You can also find more information in the github docs (https:/github.com/Valandur/Web-API/tree/master/docs/DATA.md) # noqa: E501
OpenAPI spec version: @version@
Contact: inithilian@gmail.com
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from swagger_client.api_client import ApiClient
class CommandApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def get_command(self, cmd, **kwargs): # noqa: E501
"""Get a command # noqa: E501
Get detailed information about a command. **Required permissions:** - **cmd.one** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_command(cmd, async=True)
>>> result = thread.get()
:param async bool
:param str cmd: The id of the command (required)
:param bool details: Add to include additional details, omit or false otherwise
:param str accept: Override the 'Accept' request header (useful for debugging your requests)
:param bool pretty: Add to make the Web-API pretty print the response (useful for debugging your requests)
:return: Command
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async'):
return self.get_command_with_http_info(cmd, **kwargs) # noqa: E501
else:
(data) = self.get_command_with_http_info(cmd, **kwargs) # noqa: E501
return data
def get_command_with_http_info(self, cmd, **kwargs): # noqa: E501
"""Get a command # noqa: E501
Get detailed information about a command. **Required permissions:** - **cmd.one** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_command_with_http_info(cmd, async=True)
>>> result = thread.get()
:param async bool
:param str cmd: The id of the command (required)
:param bool details: Add to include additional details, omit or false otherwise
:param str accept: Override the 'Accept' request header (useful for debugging your requests)
:param bool pretty: Add to make the Web-API pretty print the response (useful for debugging your requests)
:return: Command
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['cmd', 'details', 'accept', 'pretty'] # noqa: E501
all_params.append('async')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method get_command" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'cmd' is set
if ('cmd' not in params or
params['cmd'] is None):
raise ValueError("Missing the required parameter `cmd` when calling `get_command`") # noqa: E501
collection_formats = {}
path_params = {}
if 'cmd' in params:
path_params['cmd'] = params['cmd'] # noqa: E501
query_params = []
if 'details' in params:
query_params.append(('details', params['details'])) # noqa: E501
if 'accept' in params:
query_params.append(('accept', params['accept'])) # noqa: E501
if 'pretty' in params:
query_params.append(('pretty', params['pretty'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['ApiKeyHeader', 'ApiKeyQuery'] # noqa: E501
return self.api_client.call_api(
'/cmd/{cmd}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='Command', # noqa: E501
auth_settings=auth_settings,
async=params.get('async'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def list_commands(self, **kwargs): # noqa: E501
"""List commands # noqa: E501
Gets a list of all the commands available on the server. **Required permissions:** - **cmd.list** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.list_commands(async=True)
>>> result = thread.get()
:param async bool
:param bool details: Add to include additional details, omit or false otherwise
:param str accept: Override the 'Accept' request header (useful for debugging your requests)
:param bool pretty: Add to make the Web-API pretty print the response (useful for debugging your requests)
:return: list[Command]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async'):
return self.list_commands_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.list_commands_with_http_info(**kwargs) # noqa: E501
return data
def list_commands_with_http_info(self, **kwargs): # noqa: E501
"""List commands # noqa: E501
Gets a list of all the commands available on the server. **Required permissions:** - **cmd.list** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.list_commands_with_http_info(async=True)
>>> result = thread.get()
:param async bool
:param bool details: Add to include additional details, omit or false otherwise
:param str accept: Override the 'Accept' request header (useful for debugging your requests)
:param bool pretty: Add to make the Web-API pretty print the response (useful for debugging your requests)
:return: list[Command]
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['details', 'accept', 'pretty'] # noqa: E501
all_params.append('async')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method list_commands" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'details' in params:
query_params.append(('details', params['details'])) # noqa: E501
if 'accept' in params:
query_params.append(('accept', params['accept'])) # noqa: E501
if 'pretty' in params:
query_params.append(('pretty', params['pretty'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['ApiKeyHeader', 'ApiKeyQuery'] # noqa: E501
return self.api_client.call_api(
'/cmd', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[Command]', # noqa: E501
auth_settings=auth_settings,
async=params.get('async'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def run_commands(self, **kwargs): # noqa: E501
"""Execute a command # noqa: E501
Execute a command on the server. (Almost the same as running it from the console). Pass an array of commands to execute them in succession, you can also just pass a list with only one command if that's all you want to execute. Returns a list with each response corresponding to a command. **Required permissions:** - **cmd.run** - **cmd.run.[command]** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.run_commands(async=True)
>>> result = thread.get()
:param async bool
:param list[ExecuteCommandRequest] body:
:param bool details: Add to include additional details, omit or false otherwise
:param str accept: Override the 'Accept' request header (useful for debugging your requests)
:param bool pretty: Add to make the Web-API pretty print the response (useful for debugging your requests)
:return: list[ExecuteCommandResponse]
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async'):
return self.run_commands_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.run_commands_with_http_info(**kwargs) # noqa: E501
return data
def run_commands_with_http_info(self, **kwargs): # noqa: E501
"""Execute a command # noqa: E501
Execute a command on the server. (Almost the same as running it from the console). Pass an array of commands to execute them in succession, you can also just pass a list with only one command if that's all you want to execute. Returns a list with each response corresponding to a command. **Required permissions:** - **cmd.run** - **cmd.run.[command]** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.run_commands_with_http_info(async=True)
>>> result = thread.get()
:param async bool
:param list[ExecuteCommandRequest] body:
:param bool details: Add to include additional details, omit or false otherwise
:param str accept: Override the 'Accept' request header (useful for debugging your requests)
:param bool pretty: Add to make the Web-API pretty print the response (useful for debugging your requests)
:return: list[ExecuteCommandResponse]
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['body', 'details', 'accept', 'pretty'] # noqa: E501
all_params.append('async')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method run_commands" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
if 'details' in params:
query_params.append(('details', params['details'])) # noqa: E501
if 'accept' in params:
query_params.append(('accept', params['accept'])) # noqa: E501
if 'pretty' in params:
query_params.append(('pretty', params['pretty'])) # noqa: E501
header_params = {}
form_params = []
local_var_files = {}
body_params = None
if 'body' in params:
body_params = params['body']
# HTTP header `Accept`
header_params['Accept'] = self.api_client.select_header_accept(
['application/json', 'application/xml']) # noqa: E501
# HTTP header `Content-Type`
header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501
['application/json', 'application/xml']) # noqa: E501
# Authentication setting
auth_settings = ['ApiKeyHeader', 'ApiKeyQuery'] # noqa: E501
return self.api_client.call_api(
'/cmd', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type='list[ExecuteCommandResponse]', # noqa: E501
auth_settings=auth_settings,
async=params.get('async'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)