diff options
| author | Federico Igne <git@federicoigne.com> | 2022-08-24 21:58:10 +0100 |
|---|---|---|
| committer | Federico Igne <git@federicoigne.com> | 2022-08-24 21:58:10 +0100 |
| commit | 933b241417d6630fab842a3ef00f767f569fbdf9 (patch) | |
| tree | 701eb8d1b39932b3dacf0d277bc262a6262b1d5a /README.md | |
| parent | 67d554ce2b3a1177f970d90e86fef26d5e5def88 (diff) | |
| download | joyce-933b241417d6630fab842a3ef00f767f569fbdf9.tar.gz joyce-933b241417d6630fab842a3ef00f767f569fbdf9.zip | |
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 8 |
1 files changed, 4 insertions, 4 deletions
| @@ -261,7 +261,7 @@ pub async fn post_notes(pool: web::Data<Pool>, req: web::Json<Vec<NoteRequest>>) | |||
| 261 | } | 261 | } |
| 262 | ``` | 262 | ``` |
| 263 | 263 | ||
| 264 | ## GET /tag/{tags} | 264 | ## GET /tags/{tags} |
| 265 | 265 | ||
| 266 | Notes can be retrieved by (sets of) tags. | 266 | Notes can be retrieved by (sets of) tags. |
| 267 | One or more tags separated by `+` can be passed to the request and `joyce` will retrieve those notes marked with **all** the provided tags. | 267 | One or more tags separated by `+` can be passed to the request and `joyce` will retrieve those notes marked with **all** the provided tags. |
| @@ -271,7 +271,7 @@ The function takes 2 parameters (the connection pool to the underlying SQLite da | |||
| 271 | Passing an empty collection of tags results in an error. | 271 | Passing an empty collection of tags results in an error. |
| 272 | 272 | ||
| 273 | ```{#req_get_tags .rust} | 273 | ```{#req_get_tags .rust} |
| 274 | #[get("/tag/{tags}")] | 274 | #[get("/tags/{tags}")] |
| 275 | pub async fn get_tags(pool: web::Data<Pool>, tags: web::Path<String>) -> HttpResponse { | 275 | pub async fn get_tags(pool: web::Data<Pool>, tags: web::Path<String>) -> HttpResponse { |
| 276 | <<get_connection>> | 276 | <<get_connection>> |
| 277 | let tags = tags.split('+').map(|t| t.to_string()).collect::<Vec<_>>(); | 277 | let tags = tags.split('+').map(|t| t.to_string()).collect::<Vec<_>>(); |
| @@ -515,10 +515,10 @@ Communication with SQLite is grouped under the `db` module. | |||
| 515 | <<db_operations>> | 515 | <<db_operations>> |
| 516 | ``` | 516 | ``` |
| 517 | 517 | ||
| 518 | # TODOs | 518 | # TODO: road to v1.0.0 |
| 519 | 519 | ||
| 520 | - Better error handling | 520 | - Better error handling |
| 521 | - Logging | 521 | - Better logging |
| 522 | - add examples with cURL | 522 | - add examples with cURL |
| 523 | 523 | ||
| 524 | ## Open questions | 524 | ## Open questions |
