Browse Source

Add doc for RequestParameters parameters

Bastien Sevajol 6 years ago
parent
commit
6b67cd8da4
1 changed files with 25 additions and 5 deletions
  1. 25 5
      hapic/processor.py

+ 25 - 5
hapic/processor.py View File

@@ -18,13 +18,33 @@ class RequestParameters(object):
18 18
         files_parameters: dict,
19 19
     ):
20 20
         """
21
-        :param path_parameters:
21
+        :param path_parameters: Parameters found in path, example:
22
+            (for '/users/<user_id>') '/users/42' =>{'user_id': '42'}
23
+
24
+        :param query_parameters: Parameters found in query, example:
25
+            '/foo?group_id=1&group_id=2&deleted=false' => MultiDict(
26
+                (
27
+                    ('group_id', '1'),
28
+                    ('group_id', '2'),
29
+                    ('deleted', 'false'),
30
+                )
31
+            )
32
+
33
+        :param body_parameters: Body content in dict format, example:
34
+            JSON body '{"user": {"name":"bob"}}' => {'user': {'name':'bob'}}
35
+
36
+        :param form_parameters: Form parameters, example:
37
+            <input type="text" name="name" value="bob"/> => {'name': 'bob'}
22 38
 
23
-        TODO Documenter + example pour chaque
24
-        ex: /api/user/<user_id> -> {'user_id': 'abc'}
25
-        ex: /api/user/<user_id> -> {'user_id': 'abc'}
26
-        ?resource_id=abc&resource_id=def ->
39
+        :param header_parameters: headers in dict format, example:
40
+            Connection: keep-alive
41
+            Content-Type: text/plain => {
42
+                                            'Connection': 'keep-alive',
43
+                                            'Content-Type': 'text/plain',
44
+                                        }
27 45
 
46
+        :param files_parameters: TODO BS 20171113: Specify type of file
47
+        storage ?
28 48
         """
29 49
         assert isinstance(query_parameters, MultiDict)
30 50
         assert isinstance(form_parameters, MultiDict)