From b6e493db53823dbd864953b9aed48dbaad8799d2 Mon Sep 17 00:00:00 2001 From: Kris Koishigawa Date: Fri, 18 Sep 2020 18:07:33 +0900 Subject: [PATCH] fix: sync README.md user stories with pr #39311 --- README.md | 20 ++++---------------- 1 file changed, 4 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index be3ee35..3183e33 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,7 @@ ### User Stories -1. I can POST a URL to `[project_url]/api/shorturl/new` and I will receive a shortened URL in the JSON response. Example : `{"original_url":"www.google.com","short_url":1}` -2. If I pass an invalid URL that doesn't follow the valid `http(s)://www.example.com(/more/routes)` format, the JSON response will contain an error like `{"error":"invalid URL"}`. *HINT*: to be sure that the submitted url points to a valid site you can use the function `dns.lookup(host, cb)` from the `dns` core module. -3. When I visit the shortened URL, it will redirect me to my original link. - - -#### Creation Example: - -POST [project_url]/api/shorturl/new - body (urlencoded) : url=https://www.google.com - -#### Usage: - -[this_project_url]/api/shorturl/3 - -#### Will redirect to: - -https://www.freecodecamp.org/forum/ \ No newline at end of file +1. You should provide your own project, not the example URL. +2. You can POST a URL to `/api/shorturl/new` and get a JSON response with the property names `original_url` and `short_url` and the expected values for each. +3. When you visit `/api/shorturl/`, you will be redirected to the original URL. +4. If you pass an invalid URL that doesn't follow the valid `http://www.example.com` format, the JSON response will contain `{ 'error': 'invalid url' }`.