forked from Valandur/webapi-client-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmap_api.py
More file actions
161 lines (132 loc) · 8.74 KB
/
map_api.py
File metadata and controls
161 lines (132 loc) · 8.74 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
# 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 MapApi(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_map(self, world, x, z, **kwargs): # noqa: E501
"""Get a map tile # noqa: E501
Returns an image representing the biomes of the blocks within the specified tile **Required permissions:** - **map.map** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_map(world, x, z, async=True)
>>> result = thread.get()
:param async bool
:param str world: The world to get the map tile from (required)
:param int x: The x-coordinate of the tile (is multiplied by the TILE_SIZE) (required)
:param int z: The z-coordinate of the tile (is multiplied by the TILE_SIZE) (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: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async'):
return self.get_map_with_http_info(world, x, z, **kwargs) # noqa: E501
else:
(data) = self.get_map_with_http_info(world, x, z, **kwargs) # noqa: E501
return data
def get_map_with_http_info(self, world, x, z, **kwargs): # noqa: E501
"""Get a map tile # noqa: E501
Returns an image representing the biomes of the blocks within the specified tile **Required permissions:** - **map.map** # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async=True
>>> thread = api.get_map_with_http_info(world, x, z, async=True)
>>> result = thread.get()
:param async bool
:param str world: The world to get the map tile from (required)
:param int x: The x-coordinate of the tile (is multiplied by the TILE_SIZE) (required)
:param int z: The z-coordinate of the tile (is multiplied by the TILE_SIZE) (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: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = ['world', 'x', 'z', '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_map" % key
)
params[key] = val
del params['kwargs']
# verify the required parameter 'world' is set
if ('world' not in params or
params['world'] is None):
raise ValueError("Missing the required parameter `world` when calling `get_map`") # noqa: E501
# verify the required parameter 'x' is set
if ('x' not in params or
params['x'] is None):
raise ValueError("Missing the required parameter `x` when calling `get_map`") # noqa: E501
# verify the required parameter 'z' is set
if ('z' not in params or
params['z'] is None):
raise ValueError("Missing the required parameter `z` when calling `get_map`") # noqa: E501
collection_formats = {}
path_params = {}
if 'world' in params:
path_params['world'] = params['world'] # noqa: E501
if 'x' in params:
path_params['x'] = params['x'] # noqa: E501
if 'z' in params:
path_params['z'] = params['z'] # 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(
['image/png']) # 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(
'/map/{world}/{x}/{z}', 'GET',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # 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)