Skip to content
Inspironix APIs/
/
List ingredients

Kitchen Ingredients API (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://phronesis-inspironix.redocly.app/_mock/apis/kitchen-api/openapi
Development server
https://dev.api.example.com
Staging server
https://stg.api.example.com
Production server
https://phronesis-inspironix.redocly.app/{{OUR_SERVER}}

List ingredients

Request

Security
BearerAuth
curl -i -X GET \
  https://phronesis-inspironix.redocly.app/_mock/apis/kitchen-api/openapi/ingredients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of ingredients

Bodyapplication/json
objectstring
pageobject
itemsArray of objects
totalinteger
Response
application/json
{
  "object": "string",
  "page": {
    "endCursor": "string",
    "startCursor": "string",
    "hasNextPage": true,
    "hasPrevPage": true,
    "limit": 0,
    "total": 0
  },
  "items": [
    { … }
  ],
  "total": 0
}

Add a new ingredient

Request

Security
BearerAuth
Bodyapplication/jsonrequired
namestringrequired
quantitynumberrequired
unitstringrequired
useBeforestring(date-time)required
curl -i -X POST \
  https://phronesis-inspironix.redocly.app/_mock/apis/kitchen-api/openapi/ingredients \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "quantity": 0,
    "unit": "string",
    "useBefore": "2019-08-24T14:15:22Z"
  }'

Responses

Ingredient created successfully

Bodyapplication/json
idstring
objectstring
kitchenIdstring
namestring
quantitynumber
unitstring
useBeforestring(date-time)
createdAtstring(date-time)
Response
application/json
{
  "id": "string",
  "object": "string",
  "kitchenId": "string",
  "name": "string",
  "quantity": 0,
  "unit": "string",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Delete an ingredient by ID

Request

Security
BearerAuth
Path
idstringrequired
curl -i -X DELETE \
  'https://phronesis-inspironix.redocly.app/_mock/apis/kitchen-api/openapi/ingredients/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ingredient deleted successfully

Response
No content

Get an ingredient by ID

Request

Security
BearerAuth
Path
idstringrequired
curl -i -X GET \
  'https://phronesis-inspironix.redocly.app/_mock/apis/kitchen-api/openapi/ingredients/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Ingredient details

Bodyapplication/json
idstring
objectstring
kitchenIdstring
namestring
quantitynumber
unitstring
useBeforestring(date-time)
createdAtstring(date-time)
Response
application/json
{
  "id": "string",
  "object": "string",
  "kitchenId": "string",
  "name": "string",
  "quantity": 0,
  "unit": "string",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}