HTTP (API) - Revision history

MKlegoman357: fixed formatting

2015-08-01T20:35:58Z

fixed formatting

SquidDev: Add http.checkURL method

2015-08-01T19:49:31Z

Add http.checkURL method

MKlegoman357: Recreated the table using {{API table}} template, Removed the caution

2014-06-06T09:02:46Z

Recreated the table using {{API table}} template, Removed the caution

AgentE382 at 21:46, 5 June 2014

2014-06-05T21:46:27Z

Shazz at 20:16, 20 April 2014

2014-04-20T20:16:27Z

Shazz at 19:52, 20 April 2014

2014-04-20T19:52:27Z

Graypup: It's not mod_ComputerCraft.cfg, it's ComputerCraft.cfg!

2014-04-14T04:05:56Z

It's not mod_ComputerCraft.cfg, it's ComputerCraft.cfg!

Oeed: Added link to tutorial on how to enable the HTTP API

2014-03-26T08:01:47Z

Added link to tutorial on how to enable the HTTP API

Hawk777: Document synchrony and asynchrony

2013-05-05T23:10:35Z

Document synchrony and asynchrony

Hawk777: Tidying, add return value column, add getResponseCode documentation

2013-05-05T22:59:44Z

Tidying, add return value column, add getResponseCode documentation

@@ Line 27: / Line 27: @@
 {{API table/row
 |[[http.checkURL]]({{type|string}} url)
-|{{type|boolean}} sucess, {{type|string}} message
+|{{type|boolean}} success [<nowiki />, {{type|string}} error]
-|Checks if a url is valid and is whitelisted
+|Checks if a URL is valid and is included in the HTTP whitelist.
-|odd}}
+|}}
 }}
@@ Line 49: / Line 49: @@
 {{Example
 |desc=Sends a request to http://example.com/ with the custom headers.
-|code=<nowiki>local headers = {
+|code=local headers = {
-  ["User-Agent"] = "A custom user-agent!", -- Overrides the default User-Agent.
+   [ "User-Agent" ] = "A custom user-agent!", ''-- Overrides the default User-Agent.''
-  ["Hi"] = "Hello" -- A non-standard custom header field.
+   [ "Hi" ] = "Hello" ''-- A non-standard custom header field.''
-−
+ }
-http.get("http://example.com/", headers)</nowiki>
 }}
 [[Category:APIs]]

@@ Line 23: / Line 23: @@
 |{{type|table}} handle
 |Sends a HTTP POST request to a website, synchronously.
 |odd}}

@@ Line 5: / Line 5: @@
 The HTTP API allows interfacing with websites and downloading from them.
-<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
+{{API table|HTTP|image=Grid disk.png|2=
-<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
-[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
-HTTP (API)
-</td></tr>
-<tr><td style="width: 100px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+{{API table/row
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[http.request]]({{type|string}} url [, {{type|string}} postData [, {{type|table}} headers]])</td>
+|[[http.get]]({{type|string}} url [, {{type|table}} headers])
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a HTTP request to a website, asynchronously.</td></tr>
+|{{type|table}} handle
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{type|table}} handle</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[http.get]]({{type|string}} url [, {{type|table}} headers])</td>
+|[[http.post]]({{type|string}} url, {{type|string}} postData [, {{type|table}} headers])
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a HTTP GET request to a website, synchronously.</td></tr>
+|{{type|table}} handle
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{type|table}} handle</td>
+}}
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[http.post]]({{type|string}} url, {{type|string}} postData [, {{type|table}} headers])</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sends a HTTP POST request to a website, synchronously.</td></tr>
-</table>
 [[http.request]] is used to send a HTTP request that completes asynchronously and generates an event (one of [[Http success (event)|http_success]] or [[Http failure (event)|http_failure]]). [[http.get]] and [[http.post]] execute [[http.request]] and block until the operation completes.
@@ Line 48: / Line 49: @@
 http.get("http://example.com/", headers)</nowiki>
 }}
 [[Category:APIs]]

@@ Line 48: / Line 48: @@
 http.get("http://example.com/", headers)</nowiki>
 }}
 [[Category:APIs]]

@@ Line 36: / Line 36: @@
 |api=HTTP
 |desc=Returns the numerical [https://en.wikipedia.org/wiki/List_of_HTTP_status_codes HTTP response code] sent by the server
 }}
 [[Category:APIs]]

@@ Line 1: / Line 1: @@
 :{|class="wikitable"
-| '''The HTTP API must be enabled in mod_ComputerCraft.cfg before being used. To enable it see [http://www.computercraft.info/forums2/index.php?/topic/17533-how-to-enable-the-http-api/ this tutorial].'''
+| '''The HTTP API must be enabled in ComputerCraft.cfg before being used. To enable it see [http://www.computercraft.info/forums2/index.php?/topic/17533-how-to-enable-the-http-api/ this tutorial].'''
 |}