From 933b241417d6630fab842a3ef00f767f569fbdf9 Mon Sep 17 00:00:00 2001 From: Federico Igne Date: Wed, 24 Aug 2022 21:58:10 +0100 Subject: fix(rest-api): move GET /tag/{tags} to GET /tags/{tags} --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 5ef21a8..e066031 100644 --- a/README.md +++ b/README.md @@ -261,7 +261,7 @@ pub async fn post_notes(pool: web::Data, req: web::Json>) } ``` -## GET /tag/{tags} +## GET /tags/{tags} Notes can be retrieved by (sets of) tags. 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 Passing an empty collection of tags results in an error. ```{#req_get_tags .rust} -#[get("/tag/{tags}")] +#[get("/tags/{tags}")] pub async fn get_tags(pool: web::Data, tags: web::Path) -> HttpResponse { <> let tags = tags.split('+').map(|t| t.to_string()).collect::>(); @@ -515,10 +515,10 @@ Communication with SQLite is grouped under the `db` module. <> ``` -# TODOs +# TODO: road to v1.0.0 - Better error handling -- Logging +- Better logging - add examples with cURL ## Open questions -- cgit v1.2.3