Recipes

Route Guide

Getting Recipes

Get all recipes in a paginated manner

GET domain.api/api/v1/recipes/:skip/:limit

Provides an array of JSON Objects

Path Parameters

Name	Type	Description
:skip*	Integer	Number of records to skip from the beginning of the list of recipes.
:limit*	Integer	Number of records, after the skipped records, to return from the list of recipes.

200: OK List of recipes

{
  "code": 200,
  "data": [...]
}

500: Internal Server Error Internal Error

{ 
    "code": 500, 
    "msg": "Could not retrive data from data store"
}

Get recipe by id

GET domain.api/api/v1/recipes/:id

Provides a JSON Object

Path Parameters

Name	Type	Description
:id*	String	ID of the recipe

200: OK JSON Recipe Object

{
    "_id": "...",
    "name": "...",
    "author": "...",
    "cooking_time": 0,
    "diet": "...",
    "img_url": "...",
    "ingredients": [
        {
            "name": "...",
            "steps": [1, 2],
            "category": "other | veggies | meat | dairy"
        },
        ...
    ],
    "steps": [
        "...",
        "...",
        "..."
    ],
    "allergies": [
        "...",
        "..."
    ],
    "intro": "...",
    "desc": "...",
    "health_score": 5,
    "health_reason": "...",
    "userId": "..."
}

500: Internal Server Error Internal Error

404: Not Found Recipe does not exist

{ 

Get all recipes published by the authenticated user

GET domain.api/api/v1/recipes/:skip/:limit

Provides an array of JSON Objects

Path Parameters

Name	Type	Description
:skip*	Integer	Number of records to skip from the beginning of the list of recipes.
:limit*	Integer	Number of records, after the skipped records, to return from the list of recipes.

Headers

Name	Type	Description
Authorization*	Bearer Token	Bearer Token supplied by Clerk after user has authenticated.

200: OK List of recipes

{
  "code": 200,
  "data": [...]
}

500: Internal Server Error Internal Error

{ 
    "code": 500, 
    "msg": "Could not retrive data from data store"
}

401: Unauthorized Not Authenticated

Publishing Recipes

Publish recipe content

POST domain.api/api/v1/recipes

Requires JSON Body

Returns JSON Object

Headers

Name	Type	Description
Authorization*	Bearer Token	Bearer Token supplied by Clerk after user has authenticated.
Content-Type*	application/json

Request Body

Name	Type	Description
name*	String	Name/title of the recipe.
cookingTime*	Number	Time (mins) required to make this recipe.
steps*	String Array	Array of steps to make the recipe.
submission_id	String	Existing submission id, assigned upon an image upload. The submission will be continued on the same id and the uploaded image will be attached to the recipe (if the recipe submission is accepted). AI will not generate an image.

200: OK Processed as Spam Submission

{
  "code": 200,
  "spam": true,
  "msg": "[Reason for spam categorisation]"
}

500: Internal Server Error Internal Error

{ 
    "code": 500, 
    "msg": "Could not retrive data from data store"
}

401: Unauthorized Not Authenticated

201: Created Submission Accepted

{
  "code": 201,
  "spam": false,
  "submission_id": "..."
}

Initialise a recipe submission with an image upload and await content.

POST domain.api/api/v1/recipes/images/upload

Returns a JSON Object

Must be followed up with a request to publish recipe content within 48 hours or image will be deleted.

Do not include a Content-Type header.

Headers

Name	Type	Description
Authorization*	Bearer Token	Bearer Token supplied by Clerk after user has authenticated.

Request Body

Name	Type	Description
image*	Binary	Image File

201: Created Uploaded and Awaiting Recipe Submission

{
    "code": 201
    "submission_id": "..."
}

500: Internal Server Error Internal Error

406: Not Acceptable Not an Image or file larger than 10MB

{ 
    "code": 406,
    "msg": "UNEXPECTED FILE: Please ensure the file is an image file & less than 10MB."
}

Deleting Recipes

Delete recipe by id

DELETE domain.api/api/v1/recipes/:id

Provides a JSON Object

Path Parameters

Name	Type	Description
:id*	String	ID of the recipe

200: OK Deleted

{
    "code": 200
    "msg": "Deleted item with _id ..."
}

500: Internal Server Error Internal Error

404: Not Found Recipe does not exist

{ 
    "code": 404,
    "msg": "Could not delete item, please try again later."
}

Editing Recipes

Modify recipe content

PUT domain.api/api/v1/recipes

Returns JSON Object if successful

Headers

Name	Type	Description
Authorization*	Bearer Token	Bearer Token supplied by Clerk after user has authenticated.
Content-Type*	application/json

Request Body

Name	Type	Description
name*	String	Name/title of the recipe.
cookingTime*	Number	Time (mins) required to make this recipe.
steps*	String Array	Array of steps to make the recipe.
intro*	String	Introduction of the recipe.
desc*	String	Description of the recipe.
ingredients*	Object Array	Array of objects describing ingredients used (identical to the ingredient array in Recipe Object)

200: OK Processed as Spam Submission

{
  "code": 200,
  "spam": true,
  "msg": "[Reason for spam categorisation]"
}

500: Internal Server Error Internal Error

{ 
    "code": 500, 
    "msg": "Could not retrive data from data store"
}

401: Unauthorized Not Authenticated

201: Created Submission Processed

{
  "code": 201,
  "spam": false
}

Upload and replace image on an existing recipe

PUT domain.api/api/v1/recipes/images/upload

Returns a JSON Object

Headers

Name	Type	Description
Authorization*	Bearer Token	Bearer Token supplied by Clerk after user has authenticated.

Request Body

Name	Type	Description
image*	Binary	Image File

200: OK Uploaded and Replaced

{
    "code": 200
}

500: Internal Server Error Internal Error

406: Not Acceptable Not an Image or File larger than 10MB

{ 
    "code": 404,
    "msg": "Could not delete item, please try again later."
}

401: Unauthorized Not logged in or this recipe does not belong to user.