Retrieve a list of dishes

Retrieve a list of dishes and the dish details.

The client app will display the name, description, and price and will use the category to determine where to display the dish in the menu. The server will check the dish’s ingredient_id to ensure essential ingredients are in stock (if not in stock, the dish will be disabled in the client app).

The KDS will use the station, preparation_time, and ingredients array when prioritizing and prepping the dish.

GET /dishes

Retrieve a list of dishes

cURL

curl --request GET \
  --url https://reimagined-journey-g45xxv4v6gwhvrrr-80.app.github.dev/dishes

200

{
  "results": [
    {
      "id": "674d0bf5c28b69001f8e03a1",
      "created_at": "2024-04-22T10:00:00Z",
      "name": "Risotto alla Milanese",
      "description": "A description of the resource.",
      "category": "Main Course",
      "image_name": "burger",
      "ingredients": [
        {
          "ingredient_id": "66294b2a4475a41f3e709bc5",
          "is_essential": true
        },
        {
          "ingredient_id": "66294b2a4475a41f3e709bc6",
          "is_essential": true
        },
        {
          "ingredient_id": "66294b2a4475a41f3e709bc7",
          "is_essential": false
        }
      ],
      "preparation_time": 999,
      "price": 999,
      "station": "hot"
    }
  ],
  "total_results": 20
}

Query Parameters

sort · string

Sort the list in the response by a specific property. Used with the order parameter.

order · string

Set the sort order to asc for ascending or desc for descending. Must be used with the sort parameter.

fields · string

Restrict which properties are returned in the response.

filter · string

Filter the response to include only items that have properties equal to the specified value.

Example:

"created_at.gt~2024-05-07|price.lte~19.99"

limit · integer

Limit the number of objects in the response.

Required range: x <= 30

offset · integer

Offsets the start of the list by the set value. Defaults to 0.

Example:

0

Response

200

application/json

Request successful

results · object[]

Show child attributes

total_results · integer

The total number of objects in the results array that were returned in the response.

Example:

20