Skip to content

Add API reference with example requests and responses - Fixes #29 #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
viralynn wants to merge 2 commits into
base: main
Choose a base branch
from
+855 −0
Open

Add API reference with example requests and responses - Fixes #29 #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
154fbe2
Add API reference with example requests and responses
viralynn Oct 7, 2026
66ea984
Add a section on the order to run the examples
viralynn Oct 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ flutter test
| PATCH | `/api/doubts/{id}/solved` | Mark an in-progress doubt as solved |
| PATCH | `/api/doubts/{id}/skipped` | Mark an in-progress doubt as skipped |

For request and response examples, see the [API reference](docs/api.md).

Errors are returned as JSON:

```
Expand Down
Loading