aboutsummaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt72
1 files changed, 14 insertions, 58 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 0fe524035..adaaf6180 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -5549,72 +5549,28 @@ Schematics
HTTP Requests
-------------
-* `minetest.get_http_api()`
- * returns `HTTPApiTable` containing http functions.
- * The returned table contains the functions `fetch_sync`, `fetch_async` and
+
+* `minetest.request_http_api()`:
+ * returns `HTTPApiTable` containing http functions if the calling mod has
+ been granted access by being listed in the `secure.http_mods` or
+ `secure.trusted_mods` setting, otherwise returns `nil`.
+ * The returned table contains the functions `fetch`, `fetch_async` and
`fetch_async_get` described below.
+ * Only works at init time and must be called from the mod's main scope
+ (not from a function).
* Function only exists if minetest server was built with cURL support.
-* `HTTPApiTable.fetch_sync(HTTPRequest req)`: returns HTTPRequestResult
- * Performs given request synchronously
+ * **DO NOT ALLOW ANY OTHER MODS TO ACCESS THE RETURNED TABLE, STORE IT IN
+ A LOCAL VARIABLE!**
+* `HTTPApiTable.fetch(HTTPRequest req, callback)`
+ * Performs given request asynchronously and calls callback upon completion
+ * callback: `function(HTTPRequestResult res)`
+ * Use this HTTP function if you are unsure, the others are for advanced use
* `HTTPApiTable.fetch_async(HTTPRequest req)`: returns handle
* Performs given request asynchronously and returns handle for
`HTTPApiTable.fetch_async_get`
* `HTTPApiTable.fetch_async_get(handle)`: returns HTTPRequestResult
* Return response data for given asynchronous HTTP request
-### `HTTPRequest` definition
-
-Used by `HTTPApiTable.fetch` and `HTTPApiTable.fetch_async`.
-
- {
- url = "http://example.org",
-
- timeout = 10,
- -- Timeout for connection in seconds. Default is 3 seconds.
-
- post_data = "Raw POST request data string" OR {field1 = "data1", field2 = "data2"},
- -- Optional, if specified a POST request with post_data is performed.
- -- Accepts both a string and a table. If a table is specified, encodes
- -- table as x-www-form-urlencoded key-value pairs.
- -- If post_data is not specified, a GET request is performed instead.
-
- user_agent = "ExampleUserAgent",
- -- Optional, if specified replaces the default minetest user agent with
- -- given string
-
- extra_headers = { "Accept-Language: en-us", "Accept-Charset: utf-8" },
- -- Optional, if specified adds additional headers to the HTTP request.
- -- You must make sure that the header strings follow HTTP specification
- -- ("Key: Value").
-
- multipart = boolean
- -- Optional, if true performs a multipart HTTP request.
- -- Default is false.
- }
-
-### `HTTPRequestResult` definition
-
-Passed to `HTTPApiTable.fetch` callback. Returned by
-`HTTPApiTable.fetch_async_get`.
-
- {
- completed = true,
- -- If true, the request has finished (either succeeded, failed or timed
- -- out)
-
- succeeded = true,
- -- If true, the request was successful
-
- timeout = false,
- -- If true, the request timed out
-
- code = 200,
- -- HTTP status code
-
- data = "response"
- }
-
-
Storage API
-----------