From b271a988676afbf3b479ec3dd6e37e9ba2b921d7 Mon Sep 17 00:00:00 2001 From: Tushar Dahiya Date: Fri, 7 Oct 2022 09:30:58 +0530 Subject: [PATCH 1/2] Update add-route.md --- docs/tutorials/add-route.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/tutorials/add-route.md b/docs/tutorials/add-route.md index 6b1bf7e7cf..9278c2e806 100644 --- a/docs/tutorials/add-route.md +++ b/docs/tutorials/add-route.md @@ -34,10 +34,10 @@ App::init() ### 4. The Labels Mechanism -Labels are very strait forward and easy to use and understand, but in the same time are very robust. +Labels are very straightforward and easy to use and understand, but at the same time are very robust. Labels are passed from the controllers route and used to pick up key-value pairs to be handled in a centralized place along the road. -Labels can be used to pass a pattern in order to be replaced in the other end. +Labels can be used to pass a pattern in order to be replaced on the other end. Appwrite uses different labels to achieve different things, for example: #### Scope @@ -64,7 +64,7 @@ App::post('/v1/account/create') #### SDK * sdk.auth - Array of authentication types is passed in order to impose different authentication methods in different situations. * sdk.namespace - Refers to the route namespace. -* sdk.method - Refers to the sdk method that needs to called. +* sdk.method - Refers to the sdk method that needs to be called. * sdk.description - Description of the route,using markdown format. * sdk.sdk.response.code - Refers to the route http response status code expected. * sdk.auth.response.model - Refers the route http response expected. @@ -106,7 +106,7 @@ App::post('/v1/storage/buckets/:bucketId/files') ``` #### Events -* event - A pattern that is associated with the route in behalf of realtime messaging. +* event - A pattern that is associated with the route in behalf of real time messaging. Placeholders marked as `[]` are parsed and replaced with their real values. ```php @@ -157,7 +157,7 @@ some code... ``` ### 6. Action -Action populates the actual routes code and has to be very clear and understandable. A good route stay simple and doesn't contain complex logic. An action is where we describe our business need in code, and combine different libraries to work together and tell our story. +Action populates the actual route code and has to be very clear and understandable. A good route stays simple and doesn't contain complex logic. An action is where we describe our business needs in code, and combine different libraries to work together and tell our story. ```php App::post('/v1/account/sessions/anonymous') From 765dca4a3ee4adf30855c5037cf9922a231cdc0e Mon Sep 17 00:00:00 2001 From: Tushar Dahiya Date: Sun, 9 Oct 2022 16:55:17 +0530 Subject: [PATCH 2/2] Update add-route.md --- docs/tutorials/add-route.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials/add-route.md b/docs/tutorials/add-route.md index 9278c2e806..1699ded6b3 100644 --- a/docs/tutorials/add-route.md +++ b/docs/tutorials/add-route.md @@ -106,7 +106,7 @@ App::post('/v1/storage/buckets/:bucketId/files') ``` #### Events -* event - A pattern that is associated with the route in behalf of real time messaging. +* event - A pattern that is associated with the route in behalf of realtime messaging. Placeholders marked as `[]` are parsed and replaced with their real values. ```php