Skip to content

Commit bda45a3

Browse files
authored
Update HttpService.yaml
Added information for HTTP methods, what they are, and if they are currently supported by Roblox's HTTPService
1 parent cb04623 commit bda45a3

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

content/en-us/reference/engine/classes/HttpService.yaml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -456,6 +456,71 @@ methods:
456456
</tbody>
457457
</table>
458458
459+
#### HTTP Methods
460+
461+
The HTTP request methods specify the purpose of the request being made and what is expected if the request is successful.
462+
For instance: The [`GET`](https://developer.mozilla.org/docs/Web/HTTP/Methods/GET) request method tells the server at the requested address that a resource is being requested and if
463+
it succeeds, the resource at that address will be returned. Similarly, the [`HEAD`](https://developer.mozilla.org/docs/Web/HTTP/Methods/HEAD) request method does the same except the
464+
server knows to return a response without a `Body` element.
465+
466+
<table>
467+
<thead>
468+
<tr>
469+
<th>Method</th>
470+
<th>Description</th>
471+
<th>Supported</th>
472+
<th>Safe</th>
473+
</tr>
474+
</thead>
475+
<tbody>
476+
<tr>
477+
<td><b>[`GET`](https://developer.mozilla.org/docs/Web/HTTP/Methods/GET)</b></td>
478+
<td>The `GET` method requests the resource at the specified address. Does not support use of the `Body` parameter.</td>
479+
<td>Yes</td>
480+
</tr>
481+
<tr>
482+
<td><b>[`HEAD`](https://developer.mozilla.org/docs/Web/HTTP/Methods/HEAD)</b></td>
483+
<td>The `HEAD` method requests a response identical to a `GET` request, but with no response body. Does not support use of the `Body` parameter.</td>
484+
<td>Yes</td>
485+
</tr>
486+
<tr>
487+
<td><b>[`POST`](https://developer.mozilla.org/docs/Web/HTTP/Methods/POST)</b></td>
488+
<td>The `POST` method submits the supplied `Body` data to the requested address.</td>
489+
<td>Yes</td>
490+
</tr>
491+
<tr>
492+
<td><b>[`PUT`](https://developer.mozilla.org/docs/Web/HTTP/Methods/PUT)</b></td>
493+
<td>The `PUT` method replaces all current iterations of the resource specified within the supplied `Body` data.</td>
494+
<td>Yes</td>
495+
</tr>
496+
<tr>
497+
<td><b>[`DELETE`](https://developer.mozilla.org/docs/Web/HTTP/Methods/DELETE)</b></td>
498+
<td>The `DELETE` method deletes the resource specified in the supplied `Body` data at the requested address.</td>
499+
<td>Yes</td>
500+
</tr>
501+
<tr>
502+
<td><b>[`CONNECT`](https://developer.mozilla.org/docs/Web/HTTP/Methods/CONNECT)</b></td>
503+
<td>The `CONNECT` method establishes a tunnel to the requested server identified with the supplied `Body` data.</td>
504+
<td>No</td>
505+
</tr>
506+
<tr>
507+
<td><b>[`OPTIONS`](https://developer.mozilla.org/docs/Web/HTTP/Methods/OPTIONS)</b></td>
508+
<td>The `OPTIONS` method requests the permitted communication options for the supplied address.</td>
509+
<td>Yes</td>
510+
</tr>
511+
<tr>
512+
<td><b>[`TRACE`](https://developer.mozilla.org/docs/Web/HTTP/Methods/TRACE)</b></td>
513+
<td>The `TRACE` method performs a message loop-back test along the path to the resource specified in the supplied `Body` data.</td>
514+
<td>Yes</td>
515+
</tr>
516+
<tr>
517+
<td><b>[`PATCH`](https://developer.mozilla.org/docs/Web/HTTP/Methods/PATCH)</b></td>
518+
<td>The `PATCH` method applies partial changes to the resource specified in the supplied `Body` data at the requested address.</td>
519+
<td>Yes</td>
520+
</tr>
521+
</tbody>
522+
</table>
523+
459524
#### HTTP Headers
460525
461526
In the request dictionary, you can specify custom HTTP headers to use in

0 commit comments

Comments
 (0)