Skip to content

Commit

Permalink
docs: update class Request documentation (sparckles#834)
Browse files Browse the repository at this point in the history
  • Loading branch information
sansyrox authored Jun 3, 2024
1 parent cb30bab commit 46430fe
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,13 @@ identity (Optional[Identity]): The identity of the client
class Request:
"""
query_params: QueryParams
headers: dict[str, str]
headers: Headers
path_params: dict[str, str]
body: Union[str, bytes]
method: str
url: Url
form_data: dict[str, str]
files: dict[str, bytes]
ip_addr: Optional[str]
identity: Optional[Identity]
"""
Expand All @@ -70,11 +72,13 @@ identity (Optional[Identity]): The identity of the client
class Request:
"""
query_params: QueryParams
headers: dict[str, str]
headers: Headers
path_params: dict[str, str]
body: Union[str, bytes]
method: str
url: Url
form_data: dict[str, str]
files: dict[str, bytes]
ip_addr: Optional[str]
identity: Optional[Identity]
"""
Expand Down
1 change: 1 addition & 0 deletions robyn/robyn.pyi
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,7 @@ class Request:
headers Headers: The headers of the request. e.g. Headers({"Content-Type": "application/json"})
path_params (dict[str, str]): The parameters of the request. e.g. /user/:id -> {"id": "123"}
body (Union[str, bytes]): The body of the request. If the request is a JSON, it will be a dict.
method (str): The method of the request. e.g. GET, POST, PUT etc.
url (Url): The url of the request. e.g. https://localhost/user
form_data (dict[str, str]): The form data of the request. e.g. {"name": "John"}
files (dict[str, bytes]): The files of the request. e.g. {"file": b"file"}
Expand Down

0 comments on commit 46430fe

Please sign in to comment.