API showdown
/
Train Travel API
/
Kitchen
/
ingriedients
/
Get an ingriedient

Kitchen API (1.0.0)

This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about

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

https://innovario.apishowdown.com/_mock/catalog/api-showdown/api-hub/kitchen/openapi/

https://{server1}/v1/

ingredients

Everything about your Ingredients

ingriedients

Operations

List of ingriedients

Request

List of ingriedients used in kitchen.

curl -i -X GET \
  https://innovario.apishowdown.com/_mock/catalog/api-showdown/api-hub/kitchen/openapi/ingredients \
  -H 'authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
objectstringrequired
Value"list"
pageobject(page)required
page.​endCursorstringrequired

Identifier of last ingridient in results.

Example: "ZG9uJ3QgZGVjb2RlIG1l"
page.​startCursorstringrequired

Identifier of first ingredient in results.

Example: "ZG9uJ3QgZGVjb2RlIG1l"
page.​hasNextPagebooleanrequired

Determinates if results have next page.

Example: true
page.​hasPrevPagebooleanrequired

Determinates if results have previous page.

Example: false
page.​limitnumberrequired

Number of items return in single page.

Example: 100
page.​totalnumberrequired

Number of items in total.

Example: 100
totalnumberrequired

Number of items in total.

Example: 100
itemsArray of objects(ingredient)required
items[].​idstring(uuid)read-onlyrequired

Identifier of ingredient.

items[].​objectstringread-onlyrequired
Value"ingredient"
items[].​kitchenIdstringrequired
Example: "altman-family"
items[].​namestringrequired

Name of ingredient.

Example: "broccoli"
items[].​quantitynumberrequired

Quantity of the ingredient.

Example: 10
items[].​unitstringrequired

Unit of the ingredient.

Example: "cups"
items[].​useBeforestring(date-time)required

Expiration date of the ingredient.

items[].​createdAtstring(date-time)read-onlyrequired

Production date of the ingredient.

Response
application/json
{
  "object": "list",
  "page": {
    "endCursor": "ZG9uJ3QgZGVjb2RlIG1l",
    "startCursor": "ZG9uJ3QgZGVjb2RlIG1l",
    "hasNextPage": true,
    "hasPrevPage": false,
    "limit": 100,
    "total": 100
  },
  "total": 100,
  "items": [
    { … }
  ]
}

Add ingriedient

Request

Add ingriedient to kitchen.

Bodyapplication/json
kitchenIdstringrequired
Example: "altman-family"
namestringrequired

Name of ingredient.

Example: "broccoli"
quantitynumberrequired

Quantity of the ingredient.

Example: 10
unitstringrequired

Unit of the ingredient.

Example: "cups"
useBeforestring(date-time)required

Expiration date of the ingredient.

curl -i -X POST \
  https://innovario.apishowdown.com/_mock/catalog/api-showdown/api-hub/kitchen/openapi/ingredients \
  -H 'Content-Type: application/json' \
  -H 'authorization: YOUR_API_KEY_HERE' \
  -d '{
    "kitchenId": "altman-family",
    "name": "broccoli",
    "quantity": 10,
    "unit": "cups",
    "useBefore": "2019-08-24T14:15:22Z"
  }'

Responses

Ingridient added.

Bodyapplication/json
idstring(uuid)read-onlyrequired

Identifier of ingredient.

objectstringread-onlyrequired
Value"ingredient"
kitchenIdstringrequired
Example: "altman-family"
namestringrequired

Name of ingredient.

Example: "broccoli"
quantitynumberrequired

Quantity of the ingredient.

Example: 10
unitstringrequired

Unit of the ingredient.

Example: "cups"
useBeforestring(date-time)required

Expiration date of the ingredient.

createdAtstring(date-time)read-onlyrequired

Production date of the ingredient.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "ingredient",
  "kitchenId": "altman-family",
  "name": "broccoli",
  "quantity": 10,
  "unit": "cups",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Get an ingriedient

Request

Get details about an ingredient.

Path
idstring(uuid)
curl -i -X GET \
  'https://innovario.apishowdown.com/_mock/catalog/api-showdown/api-hub/kitchen/openapi/ingredients/{id}' \
  -H 'authorization: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
idstring(uuid)read-onlyrequired

Identifier of ingredient.

objectstringread-onlyrequired
Value"ingredient"
kitchenIdstringrequired
Example: "altman-family"
namestringrequired

Name of ingredient.

Example: "broccoli"
quantitynumberrequired

Quantity of the ingredient.

Example: 10
unitstringrequired

Unit of the ingredient.

Example: "cups"
useBeforestring(date-time)required

Expiration date of the ingredient.

createdAtstring(date-time)read-onlyrequired

Production date of the ingredient.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "ingredient",
  "kitchenId": "altman-family",
  "name": "broccoli",
  "quantity": 10,
  "unit": "cups",
  "useBefore": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}