From 664ddbc64166a4b63ef0cc29c3cdac8fa5fa56b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roberto=20Abdelkader=20Mart=C3=ADnez=20P=C3=A9rez?= Date: Wed, 20 Nov 2019 13:43:21 +0100 Subject: [PATCH] Resource tree documentation cleanup --- docs/source/theory/resource_tree.rst | 43 ++++++++++++++-------------- 1 file changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/source/theory/resource_tree.rst b/docs/source/theory/resource_tree.rst index 36ec0be..3200456 100644 --- a/docs/source/theory/resource_tree.rst +++ b/docs/source/theory/resource_tree.rst @@ -17,36 +17,35 @@ Overview .. 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) │ ├──── host Host part of the URL │ ├──── path Complete URL path (URL-unquoted) - │ ├──── matches Previously matched URL path parts - │ │ └──── - │ ├──── params URL parameters (after the "?" symbol) - │ │ └──── - │ ├──── headers HTTP request headers - │ │ └──── - │ ├──── cookies HTTP request cookie - │ │ └──── - │ ├──── form Form-urlencoded form fields (names only) + │ ├──── matches + │ │ └──── Previously matched URL path parts + │ ├──── params + │ │ └──── URL parameters (after the "?" symbol) + │ ├──── headers + │ │ └──── HTTP request headers + │ ├──── cookies + │ │ └──── HTTP request cookie + │ ├──── form │ │ └──── Value of the form field with name - │ ├──── files Files uploaded via multi-part form fields (names only) + │ ├──── files │ │ └──── - │ │ └──── filename Original file name - │ │ └──── content The file content + │ │ └──── filename Original file name of the file uploaded in the form field + │ │ └──── content The contents of the file uploaded in the form field │ └──── body HTTP request body │ - └─ response All information related to the HTTP request. Write-Only - ├──── status HTTP status code - ├──── headers HTTP response headers - │ └──── - ├──── cookies HTTP request cookie - │ └──── - ├──── body Response body. Mutually exclusive with response/stream - └──── stream Alias for /response/body + └─ response + ├──── status HTTP status code + ├──── headers + │ └──── HTTP response headers + ├──── cookies + │ └──── HTTP request cookie + └──── body Response body Resources ---------