Skip to content
API Catalog/Train Travel API/Ingredients

Kitchen API (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://vlad.redocly.xyz/_mock/apis/kitchen/openapi
API server for kitchenApi
https://{tenant}.redoc.ly

Ingredients

Manage your kitchen ingredients

Operations

Get all ingredients

Request

Security
jwt
curl -i -X GET \
  https://vlad.redocly.xyz/_mock/apis/kitchen/openapi/ingredients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Response for getting all ingredients

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

Add new ingredients

Request

Security
jwt
Bodyapplication/jsonrequired
kitchenIdstringrequired
Example: "altman-family"
namestringrequired
Example: "broccoli"
quantitynumberrequired
Example: 2
unitstringrequired
Example: "cups"
useBeforestring(date-time)required
Example: "2019-08-24T14:15:22Z"
curl -i -X POST \
  https://vlad.redocly.xyz/_mock/apis/kitchen/openapi/ingredients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "kitchenId": "altman-family",
    "name": "broccoli",
    "quantity": 2,
    "unit": "cups",
    "useBefore": "2019-08-24T14:15:22Z"
  }'

Responses

Response for adding new ingredient

Bodyapplication/json
idstring(uuid)
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
objectstring
Example: "ingredient"
kitchenIdstring
Example: "altman-family"
namestring
Example: "broccoli"
quantitynumber
Example: 2
unitstring
Example: "cups"
useBeforestring(date-time)
Example: "2019-08-24T14:15:22Z"
createdAtstring(date-time)
Example: "2019-08-24T14:15:22Z"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "ingredient",
  "kitchenId": "altman-family",
  "name": "broccoli",
  "quantity": 2,
  "unit": "cups",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Get single ingredient

Request

Security
jwt
Path
idstringrequired

ID of the ingredient

curl -i -X GET \
  'https://vlad.redocly.xyz/_mock/apis/kitchen/openapi/ingredients/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Response for getting a single ingredient

Bodyapplication/json
idstring(uuid)
Example: "497f6eca-6276-4993-bfeb-53cbbbba6f08"
objectstring
Example: "ingredient"
kitchenIdstring
Example: "altman-family"
namestring
Example: "broccoli"
quantitynumber
Example: 2
unitstring
Example: "cups"
useBeforestring(date-time)
Example: "2019-08-24T14:15:22Z"
createdAtstring(date-time)
Example: "2019-08-24T14:15:22Z"
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "ingredient",
  "kitchenId": "altman-family",
  "name": "broccoli",
  "quantity": 2,
  "unit": "cups",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}