Skip to content

Commit 5ddf45e

Browse files
committed
update api docs
1 parent db00521 commit 5ddf45e

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/api/overview.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,15 @@ sidebar_position: 1
44

55
# Overview
66

7-
:::info
7+
We are working on improving the documentation and adding more details.
88

9-
This page is under development and needs more clarification.
9+
## Bruno Collection
1010

11-
:::
11+
We have a Bruno[^1] collection so developers can get a better understanding of the API. Find it [here](https://github.com/linkwarden/bruno-collection).
12+
13+
## API Endpoints
14+
15+
(Work in progress)
1216

1317
| Method | Route | Description |
1418
| -------------------- | --------------------------------------- | -------------------------------------------------------------- |
@@ -29,3 +33,5 @@ This page is under development and needs more clarification.
2933
| GET \| POST | /api/v1/collections | Get/post collections for a specific user. |
3034
| PUT \| DELETE | /api/v1/collections/:id | Manage a single collection. |
3135
| GET | /api/v1/avatar/:id | Get profile photo. |
36+
37+
[^1]: [Bruno](https://github.com/usebruno/bruno) is a lightweight, open-source alternative to Postman.

0 commit comments

Comments
 (0)