CodeMirror/appwrite
1
0
Fork 0
mirror of synced 2024-09-29 08:51:28 +13:00
Code Issues Projects Releases Wiki Activity

Update add-route.md

Browse source
This commit is contained in:
Tushar Dahiya 2022-10-07 09:30:58 +05:30 committed by GitHub
parent 676709e706
commit b271a98867
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/tutorials/add-route.md
View file

@ -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')