diff --git a/README.md b/README.md index a84acf4..ba26385 100644 --- a/README.md +++ b/README.md @@ -39,4 +39,72 @@ Hereโ€™s a cleaner and more informative version of your README section: * ๐Ÿ‘ค **Username:** `alexis` * ๐Ÿ”‘ **Password:** `password` ---- \ No newline at end of file +--- + +## ๐Ÿ—‚๏ธ API Endpoints Overview + +All routes are prefixed with `/api/private` and require a **Bearer token**. + +### ๐Ÿ‘ค User + +| Method | Endpoint | Description | +| ------ | -------- | ----------------------------- | +| GET | `/me` | Get current user's profile | +| PUT | `/me` | Update current user's profile | + +### ๐Ÿ–ผ๏ธ Galleries + +| Method | Endpoint | Description | +| ------ | ----------------------- | --------------------------------- | +| GET | `/galleries` | List all accessible galleries | +| GET | `/galleries/mine` | List galleries owned by the user | +| POST | `/gallery` | Create a new gallery | +| GET | `/gallery/{gallery_id}` | Get details of a specific gallery | +| PUT | `/gallery/{gallery_id}` | Update a gallery (owner only) | + +### ๐Ÿ‘ฅ Members + +| Method | Endpoint | Description | +| ------ | ------------------------------- | ------------------------- | +| GET | `/gallery/{gallery_id}/members` | List members of a gallery | + +### ๐Ÿ“ฉ Invitations + +| Method | Endpoint | Description | +| ------ | ----------------------------------- | --------------------------- | +| POST | `/gallery/{gallery_id}/invite` | Invite user to a gallery | +| PUT | `/invitations/{gallery_id}/respond` | Accept or reject invitation | +| GET | `/invitations/received` | List received invitations | + +### ๐Ÿ–ผ๏ธ Artworks + +| Method | Endpoint | Description | +| ------ | -------------------------------- | ----------------------------------- | +| GET | `/gallery/{gallery_id}/artworks` | List artworks in a gallery | +| POST | `/gallery/{gallery_id}/artwork` | Add artwork to gallery (owner only) | +| GET | `/artwork/{artwork_id}` | Get details of an artwork | +| PUT | `/artwork/{artwork_id}` | Update an artwork (creator only) | +| GET | `/artworks/mine` | List artworks created by the user | + +### ๐Ÿ“ Gallery Reviews + +| Method | Endpoint | Description | +| ------ | ------------------------------- | ------------------------------------- | +| GET | `/gallery/{gallery_id}/reviews` | List reviews for a gallery | +| POST | `/gallery/{gallery_id}/review` | Submit a review for a gallery | +| PUT | `/galleries/review/{review_id}` | Update a gallery review (author only) | +| GET | `/galleries/reviews/given` | Reviews written by the user | +| GET | `/galleries/reviews/received` | Reviews received on userโ€™s galleries | + +### ๐Ÿ“ Artwork Reviews + +| Method | Endpoint | Description | +| ------ | ------------------------------- | -------------------------------------- | +| GET | `/artwork/{artwork_id}/reviews` | List reviews for an artwork | +| POST | `/artwork/{artwork_id}/review` | Submit a review for an artwork | +| PUT | `/artworks/review/{review_id}` | Update an artwork review (author only) | +| GET | `/artworks/reviews/given` | Reviews written by the user | +| GET | `/artworks/reviews/received` | Reviews received on userโ€™s artworks | + +--- +