summaryrefslogtreecommitdiff
path: root/backend
diff options
context:
space:
mode:
authorschencej <55326070+schencej@users.noreply.github.com>2019-12-10 17:31:57 -0500
committerGitHub <noreply@github.com>2019-12-10 17:31:57 -0500
commitdb8efeafb8e3a427cded4ffa1b8fdcda789cbdaa (patch)
treef1a10c6a2e092de028810bc842dc11bde2580a49 /backend
parent58043492cf8a12d3b73dbb8760e26ffce0e2dc41 (diff)
parent3fd5630cae141bf49537537315d23bdbf92f8493 (diff)
Merge branch 'master' into top_bar
Diffstat (limited to 'backend')
-rw-r--r--backend/readme.adoc13
-rw-r--r--backend/recipe.go5
2 files changed, 8 insertions, 10 deletions
diff --git a/backend/readme.adoc b/backend/readme.adoc
index b10ea07..bc3c50f 100644
--- a/backend/readme.adoc
+++ b/backend/readme.adoc
@@ -37,12 +37,11 @@ The current implementation expects (and returns) recipes in the form:
"name": "Ingredient 1 Name",
"amount": 1.0,
"unit": "Ingredient Units"
- "type_": ""
},
],
"steps": [
{
- "instructions": "Step Instructions/Description",
+ "instruction": "Step Instructions/Description",
"timer": 0
}
]
@@ -122,11 +121,11 @@ $ curl -X POST api.recipebuddy.xyz:8888/recipes -d '
{"name":"INGR 2","amount":1,"unit":"oz"}
],
"steps":[
- {"instructions":"Step 1: Do this first","timer":10}
+ {"instruction":"Step 1: Do this first","timer":10}
]
}'
-{"Status":{"Code":201,"Msg":"Recipe added successfully"},"Data":{"id":2,"name":"Test Recipe 2","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2"],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3"],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instructions":"Step 1: Do this first","timer":10}]}}
+{"Status":{"Code":201,"Msg":"Recipe added successfully"},"Data":{"id":2,"name":"Test Recipe 2","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2"],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3"],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instruction":"Step 1: Do this first","timer":10}]}}
----
Read
@@ -138,7 +137,7 @@ http://api.recipebuddy.xyz:8888/recipes/0[`/recipes/{id}`], the HTTP body is ign
----
$ curl -X GET api.recipebuddy.xyz:8888/recipes/1
-{"Status":{"Code":200,"Msg":"Successful"},"Data":{"id":1,"name":"Test Recipe","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2",""],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3",""],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instructions":"Step 1: Do this first","timer":10}]}}
+{"Status":{"Code":200,"Msg":"Successful"},"Data":{"id":1,"name":"Test Recipe","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2",""],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3",""],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instruction":"Step 1: Do this first","timer":10}]}}
----
To access a list of all recipe ids in the database send a `GET` request to
@@ -171,11 +170,11 @@ $ curl -X PUT localhost:8888/recipes/1 -d '
{ "name":"INGR 2", "amount":1, "unit":"oz" }
],
"steps":[
- { "instructions":"Step 1: Do this first", "timer":10 }
+ { "instruction":"Step 1: Do this first", "timer":10 }
]
}'
-{"Status":{"Code":201,"Msg":"Recipe added successfully"},"Data":{"id":1,"name":"Test Recipe 1","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2"],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3"],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instructions":"Step 1: Do this first","timer":10}]}}
+{"Status":{"Code":201,"Msg":"Recipe added successfully"},"Data":{"id":1,"name":"Test Recipe 1","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2"],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3"],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instruction":"Step 1: Do this first","timer":10}]}}
----
[WARNING]
diff --git a/backend/recipe.go b/backend/recipe.go
index a3191c3..59b7366 100644
--- a/backend/recipe.go
+++ b/backend/recipe.go
@@ -6,12 +6,11 @@ import "strings"
type Ingredient struct {
Name string `json:"name"`
Amount float64 `json:"amount"`
- Unit string `json:"units"`
- Type string `json:"type"`
+ Unit string `json:"unit"`
}
type Step struct {
- Desc string `json:"instructions"`
+ Desc string `json:"instruction"`
Time int `json:"timer"`
}