Kharec/goyco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update readme

Browse Source
This commit is contained in:
Sandro CURY CAZZANIGA
2026-01-10 23:03:07 +01:00
parent e2804ca07e
commit c1746eb346
1 changed files with 29 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@@ -203,25 +203,44 @@ It'll be more readable and easier to parse.
- `POST /api/auth/register` - Register new user - `POST /api/auth/register` - Register new user
- `POST /api/auth/login` - Login user - `POST /api/auth/login` - Login user
- `GET /api/auth/confirm` - Confirm email - `GET /api/auth/confirm` - Confirm email address
- `POST /api/auth/logout` - Logout user - `POST /api/auth/resend-verification` - Resend verification email
- `POST /api/auth/forgot-password` - Request password reset
- `POST /api/auth/reset-password` - Reset password
- `GET /api/auth/me` - Get current user profile (protected)
- `POST /api/auth/logout` - Logout user (protected)
- `POST /api/auth/refresh` - Refresh access token (rotates refresh token) - `POST /api/auth/refresh` - Refresh access token (rotates refresh token)
- `POST /api/auth/revoke` - Revoke a refresh token - `POST /api/auth/revoke` - Revoke a refresh token (protected)
- `POST /api/auth/revoke-all` - Revoke all refresh tokens for the current user - `POST /api/auth/revoke-all` - Revoke all refresh tokens for the current user (protected)
- `PUT /api/auth/email` - Update email address (protected)
- `PUT /api/auth/username` - Update username (protected)
- `PUT /api/auth/password` - Update password (protected)
- `DELETE /api/auth/account` - Request account deletion (protected)
- `POST /api/auth/account/confirm` - Confirm account deletion
#### Posts #### Posts
- `GET /api/posts` - List posts - `GET /api/posts` - List posts
- `POST /api/posts` - Create post - `GET /api/posts/search` - Search posts
- `GET /api/posts/title` - Fetch title from URL
- `GET /api/posts/{id}` - Get specific post - `GET /api/posts/{id}` - Get specific post
- `PUT /api/posts/{id}` - Update post - `POST /api/posts` - Create post (protected)
- `DELETE /api/posts/{id}` - Delete post - `PUT /api/posts/{id}` - Update post (protected)
- `DELETE /api/posts/{id}` - Delete post (protected)
#### Voting #### Voting
- `POST /api/posts/{id}/vote` - Cast vote - `POST /api/posts/{id}/vote` - Cast vote (protected)
- `DELETE /api/posts/{id}/vote` - Remove vote - `DELETE /api/posts/{id}/vote` - Remove vote (protected)
- `GET /api/posts/{id}/votes` - Get post votes - `GET /api/posts/{id}/vote` - Get current user's vote (protected)
- `GET /api/posts/{id}/votes` - Get all votes for post
#### Users
- `GET /api/users` - List all users (protected)
- `POST /api/users` - Create new user (protected)
- `GET /api/users/{id}` - Get specific user
- `GET /api/users/{id}/posts` - Get user's posts (protected)
## CLI Commands ## CLI Commands