Resource tree documentation cleanup

This commit is contained in:
Roberto Abdelkader Martínez Pérez
2019-11-20 13:43:21 +01:00
parent b7efb3f109
commit 664ddbc641
+21 -22
View File
@@ -17,36 +17,35 @@ Overview
.. code-block:: plain .. code-block:: plain
/ The root of the resource paths tree /
├─ request All information related to the HTTP request. Read-Only ├─ request
│ ├──── method Used HTTP Method (GET, POST) │ ├──── method Used HTTP Method (GET, POST)
│ ├──── host Host part of the URL │ ├──── host Host part of the URL
│ ├──── path Complete URL path (URL-unquoted) │ ├──── path Complete URL path (URL-unquoted)
│ ├──── matches Previously matched URL path parts │ ├──── matches
│ │ └──── <name> │ │ └──── <name> Previously matched URL path parts
│ ├──── params URL parameters (after the "?" symbol) │ ├──── params
│ │ └──── <name> │ │ └──── <name> URL parameters (after the "?" symbol)
│ ├──── headers HTTP request headers │ ├──── headers
│ │ └──── <name> │ │ └──── <name> HTTP request headers
│ ├──── cookies HTTP request cookie │ ├──── cookies
│ │ └──── <name> │ │ └──── <name> HTTP request cookie
│ ├──── form Form-urlencoded form fields (names only) │ ├──── form
│ │ └──── <name> Value of the form field with name <name> │ │ └──── <name> Value of the form field with name <name>
│ ├──── files Files uploaded via multi-part form fields (names only) │ ├──── files
│ │ └──── <name> │ │ └──── <name>
│ │ └──── filename Original file name │ │ └──── filename Original file name of the file uploaded in the form field <name>
│ │ └──── content The file content │ │ └──── content The contents of the file uploaded in the form field <name>
│ └──── body HTTP request body │ └──── body HTTP request body
└─ response All information related to the HTTP request. Write-Only └─ response
├──── status HTTP status code ├──── status HTTP status code
├──── headers HTTP response headers ├──── headers
│ └──── <name> │ └──── <name> HTTP response headers
├──── cookies HTTP request cookie ├──── cookies
│ └──── <name> │ └──── <name> HTTP request cookie
──── body Response body. Mutually exclusive with response/stream ──── body Response body
└──── stream Alias for /response/body
Resources Resources
--------- ---------