Skip to content

Kitchen API (1.0.0)

Download OpenAPI description
kitchen.json
kitchen.yaml
Languages
Servers
Mock server

https://phronesis-creativara.redocly.app/_mock/products/api-hub/kitchen/

https://{tenant}/

Create an ingredient.

Request

Security
jwt
Bodyapplication/jsonrequired
kitchenIdstringrequired
namestringrequired
quantitynumberrequired
unitstringrequired
useBeforestring(date)
curl -i -X POST \
  https://phronesis-creativara.redocly.app/_mock/products/api-hub/kitchen/ingredients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "kitchenId": "altman-family",
    "name": "broccoli",
    "quantity": 1.5,
    "unit": "cups",
    "useBefore": "2019-08-24T14:15:22Z"
  }'

Responses

Created.

Bodyapplication/json
idstring(uuid)read-only
objectstringread-only
createdAtstringread-only
kitchenIdstringrequired
namestringrequired
quantitynumberrequired
unitstringrequired
useBeforestring(date)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "ingredient",
  "kitchenId": "altman-family",
  "name": "broccoli",
  "quantity": 1.5,
  "unit": "cups",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Get ingredient list.

Request

Security
jwt
curl -i -X GET \
  https://phronesis-creativara.redocly.app/_mock/products/api-hub/kitchen/ingredients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ingreditent list

Bodyapplication/json
objectstring
pageobject
itemsArray of objects(IngredientResponse)
totalinteger
Response
application/json
{
  "object": "list",
  "page": {
    "endCursor": "ZG9uJ3QgZGVjb2RlIG1l",
    "startCursor": "ZG9uJ3QgZGVjb2RlIG1l",
    "hasNextPage": false,
    "hasPrevPage": false,
    "limit": 10,
    "total": 0
  },
  "items": [
    { … }
  ],
  "total": 1
}

Get ingredientId

Request

Security
jwt
Path
ingredientIdstring
curl -i -X GET \
  'https://phronesis-creativara.redocly.app/_mock/products/api-hub/kitchen/ingredients/{ingredientId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ingredient info

Bodyapplication/json
idstring(uuid)read-only
objectstringread-only
createdAtstringread-only
kitchenIdstringrequired
namestringrequired
quantitynumberrequired
unitstringrequired
useBeforestring(date)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "ingredient",
  "kitchenId": "altman-family",
  "name": "broccoli",
  "quantity": 1.5,
  "unit": "cups",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}