Skip to content

Commit 16dce16

Browse files
committed
Applied requested changes
1 parent 4d0216a commit 16dce16

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

docs/pages/developing-extensions/Custom-web-routes.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
</div><br>
1414

1515
# Creating custom web routes
16-
<h4 class="fw-light">Add your own web routes accessible from everywhere within blueprint.</h4><br/>
16+
<h4 class="fw-light">Add your own web routes accessible from everywhere within Blueprint.</h4><br/>
1717

1818
This guide provides a step-by-step overview on how to define custom web routes using a dedicated controller within a Blueprint extension.<br/><br/>
1919

@@ -34,12 +34,24 @@ requests:
3434
```
3535
3636
- `app`: Points to the folder containing your controller classes.
37-
- `web`: Defines the file responsible for registering your web routes.
37+
- `routers:web`: Defines the file responsible for registering your web routes.
3838

3939
<div class="alert mt-2 rounded-4 border" role="alert">
4040
<i class="bi bi-journal-text mb-1 float-start fs-4"></i>
4141
<div class="ps-3 ms-3">For more details on configuration, refer to the <a href="?page=documentation/confyml">conf.yml documentation</a>.</div>
42-
</div><br/>
42+
</div>
43+
44+
Depending on your use case, you may also define routes using `routers:application` or `routers:client`. Unlike `web` routes, which are publicly accessible, even to unauthenticated users, these route types are protected:
45+
46+
- `client`: Can only be accessed by logged in user and via API key.
47+
- `application`: Can only be accessed via API key. Exact permissions can be defined.
48+
49+
Each route also has a different url prefix:
50+
51+
- `application`: `/api/application/extensions/{identifier}`
52+
- `client`: `/api/client/extensions/{identifier}`
53+
- `web`: `/extensions/{identifier}`
54+
4355

4456
### **Creating a controller**
4557

0 commit comments

Comments
 (0)