add post and put for saved areas to enable one by one edits

Author: bubelov

docs/rest/v4/README.md

@@ -11,8 +11,7 @@ The latest and recommended version of the BTCMap API, offering improved performa
 - **[Events](events.md)** - Fetch events.
 - **[Invoices](invoices.md)** - Check invoice status for boosts, comments and other paywalled features.
 - **[Users](users.md)** - Get authenticated user information.  
-### Planned
-- **[Areas](areas.md)** - Fetch areas.
+- **[Areas](areas.md)** - Fetch areas and manage saved areas.
 ### Proposed
 - Need something extra? Let us know!
 

docs/rest/v4/areas.md

@@ -4,8 +4,111 @@ This document describes the endpoints for interacting with areas in REST API v4.
 
 ## Available Endpoints
 
-- [Search](#search)
-- [Get Area](#get-area)
+- [Get Saved Areas](#get-saved-areas)
+- [Set Saved Areas](#set-saved-areas)
+- [Add Saved Area](#add-saved-area)
+- [Delete Saved Area](#delete-saved-area)
+
+### Get Saved Areas
+
+Returns the authenticated user's saved areas.
+
+```bash
+curl https://api.btcmap.org/v4/areas/saved
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Examples
+
+```json
+[
+  {
+    "id": 123,
+    "name": "Grand Paris",
+    "type": "community",
+    "url_alias": "grand-paris",
+    "icon": "https://static.btcmap.org/images/communities/grand-paris.jpg",
+    "website_url": "https://btcmap.org/community/grand-paris"
+  }
+]
+```
+
+### Set Saved Areas
+
+Replaces the authenticated user's saved areas list.
+
+```bash
+curl -X PUT https://api.btcmap.org/v4/areas/saved \
+  -H "Authorization: Bearer {token}" \
+  -d '[123, 456, 789]'
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Request Body
+
+| Type | Example | Description |
+|------|---------|-------------|
+| Array of Numbers | `[123, 456]` | Array of area IDs to save. |
+
+#### Response
+
+Returns the updated list of saved area IDs.
+
+```json
+[123, 456, 789]
+```
+
+### Add Saved Area
+
+Adds a single area to the authenticated user's saved areas.
+
+```bash
+curl -X POST https://api.btcmap.org/v4/areas/saved \
+  -H "Authorization: Bearer {token}" \
+  -d 123
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Request Body
+
+| Type | Example | Description |
+|------|---------|-------------|
+| Number | `123` | Area ID to add. |
+
+#### Response
+
+Returns the updated list of saved area IDs. If the area is already saved, the list is unchanged.
+
+```json
+[123, 456, 789]
+```
+
+### Delete Saved Area
+
+Removes a single area from the authenticated user's saved areas.
+
+```bash
+curl -X DELETE https://api.btcmap.org/v4/areas/saved/123
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Path Parameters
+
+| Parameter | Type | Example | Description |
+|-----------|------|---------|-------------|
+| `id` | Number | `123` | **Required**. Area ID to remove. |
+
+#### Response
+
+Returns the updated list of saved area IDs.
+
+```json
+[456, 789]
+```
 
 ### Search
 

docs/rest/v4/places.md

@@ -8,6 +8,10 @@ This document describes the endpoints for interacting with places in REST API v4
 - [Search](#search)
 - [Fetch Place](#fetch-place)
 - [Fetch Place Comments](#fetch-place-comments)
+- [Get Saved Places](#get-saved-places)
+- [Set Saved Places](#set-saved-places)
+- [Add Saved Place](#add-saved-place)
+- [Delete Saved Place](#delete-saved-place)
 
 ### Chronological Sync
 
@@ -346,3 +350,102 @@ curl GET https://api.btcmap.org/v4/places/120/areas?type=community
   }
 ]
 ```
+
+### Get Saved Places
+
+Returns the authenticated user's saved places.
+
+```bash
+curl https://api.btcmap.org/v4/places/saved
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Examples
+
+```json
+[
+  {
+    "id": 4829,
+    "lat": 53.2689435,
+    "lon": 9.8538715,
+    "name": "Der Schafstall"
+  }
+]
+```
+
+### Set Saved Places
+
+Replaces the authenticated user's saved places list.
+
+```bash
+curl -X PUT https://api.btcmap.org/v4/places/saved \
+  -H "Authorization: Bearer {token}" \
+  -d '[123, 456, 789]'
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Request Body
+
+| Type | Example | Description |
+|------|---------|-------------|
+| Array of Numbers | `[123, 456]` | Array of place IDs to save. |
+
+#### Response
+
+Returns the updated list of saved place IDs.
+
+```json
+[123, 456, 789]
+```
+
+### Add Saved Place
+
+Adds a single place to the authenticated user's saved places.
+
+```bash
+curl -X POST https://api.btcmap.org/v4/places/saved \
+  -H "Authorization: Bearer {token}" \
+  -d 123
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Request Body
+
+| Type | Example | Description |
+|------|---------|-------------|
+| Number | `123` | Place ID to add. |
+
+#### Response
+
+Returns the updated list of saved place IDs. If the place is already saved, the list is unchanged.
+
+```json
+[123, 456, 789]
+```
+
+### Delete Saved Place
+
+Removes a single place from the authenticated user's saved places.
+
+```bash
+curl -X DELETE https://api.btcmap.org/v4/places/saved/123
+```
+
+**Requires authentication.** See [Users API](users.md) for details.
+
+#### Path Parameters
+
+| Parameter | Type | Example | Description |
+|-----------|------|---------|-------------|
+| `id` | Number | `123` | **Required**. Place ID to remove. |
+
+#### Response
+
+Returns the updated list of saved place IDs.
+
+```json
+[456, 789]
+```

src/main.rs

@@ -182,9 +182,11 @@ async fn main() -> Result<()> {
                         scope("areas")
                             .service(rest::v4::areas::get_saved)
                             .service(rest::v4::areas::put_saved)
+                            .service(rest::v4::areas::post_saved)
+                            .service(rest::v4::areas::delete_saved)
                             .service(rest::v4::areas::get_by_id_top_editors)
-                            .service(rest::v4::areas::get)
-                            .service(rest::v4::areas::get_by_id),
+                            .service(rest::v4::areas::get_by_id)
+                            .service(rest::v4::areas::get),
                     )
                     .service(scope("dashboard").service(rest::v4::dashboard::get))
                     .service(scope("top-editors").service(rest::v4::top_editors::get))

src/rest/v4/areas.rs

@@ -8,7 +8,7 @@ use crate::rest::v4::top_editors::{
 };
 use crate::service;
 use crate::Error;
-use actix_web::{get, put, web::Data, web::Json, web::Path, web::Query};
+use actix_web::{delete, get, post, put, web::Data, web::Json, web::Path, web::Query};
 use serde::{Deserialize, Serialize};
 use time::OffsetDateTime;
 
@@ -198,6 +198,31 @@ pub async fn put_saved(auth: Auth, args: Json<Vec<i64>>, pool: Data<MainPool>) -
     Ok(actix_web::web::Json(args.into_inner()))
 }
 
+#[post("/saved")]
+pub async fn post_saved(auth: Auth, args: Json<i64>, pool: Data<MainPool>) -> Res<Vec<i64>> {
+    let user = auth.user.ok_or(RestApiError::unauthorized())?;
+    let mut saved_areas = user.saved_areas.clone();
+    if !saved_areas.contains(&args) {
+        saved_areas.push(args.into_inner());
+    }
+    db::main::user::queries::set_saved_areas(user.id, &saved_areas, &pool)
+        .await
+        .map_err(|_| RestApiError::database())?;
+    Ok(actix_web::web::Json(saved_areas))
+}
+
+#[delete("/saved/{id}")]
+pub async fn delete_saved(auth: Auth, path: Path<i64>, pool: Data<MainPool>) -> Res<Vec<i64>> {
+    let user = auth.user.ok_or(RestApiError::unauthorized())?;
+    let id = path.into_inner();
+    let mut saved_areas = user.saved_areas.clone();
+    saved_areas.retain(|x| *x != id);
+    db::main::user::queries::set_saved_areas(user.id, &saved_areas, &pool)
+        .await
+        .map_err(|_| RestApiError::database())?;
+    Ok(actix_web::web::Json(saved_areas))
+}
+
 #[derive(Deserialize)]
 pub struct GetTopEditorsForAreaArgs {
     period_start: Option<String>,