Search
K
🌭 Hotdog stand

List available condiments

Returns a list of available condiments.

get
https://hotdog.example.com/api/v1/condiments

Query Parameters

limitinteger(int32)

Maximum number of items to return

Default:20

>= 1<= 100

offsetinteger(int32)

Number of items to skip for pagination

Default:0

>= 0

Response

200 application/json

Successful operation

dataarray[object]

Example:{"id":"3e5f7b9a-1c3e-4b0a-8b3a-4b8a5b5a7b5a","name":"Mustard","description":"Yellow mustard","price":0.5}

Show Child Parameters
metaobject
Show Child Parameters
get/condiments
 
200 application/json

Menu

Operations related to retrieving menu items

List available menu items

Returns a list of available menu items.

get
https://hotdog.example.com/api/v1/menu

Query Parameters

limitinteger(int32)

Maximum number of items to return

Default:20

>= 1<= 100

offsetinteger(int32)

Number of items to skip for pagination

Default:0

>= 0

Response

200 application/json

Successful operation

dataarray[object]

Example:{"id":"a1b2c3d4-e5f6-7890-1234-567890abcdef","name":"Hot Dog","description":"Classic hot dog on a bun","price":5}

Show Child Parameters
metaobject
Show Child Parameters
get/menu
 
200 application/json

Order

object
idstring(uuid)

Unique identifier for the order

itemsarray[object]

Example:{"item_name":"Hot Dog","quantity":1,"condiments":["mustard","ketchup"]}

Show Child Parameters
statusstring

Status of the order

Allowed values:pendingconfirmedcancelledcompleted

total_amountnumber(float)

Total amount of the order

Example

OrderItem

object
item_namestring

Name of the item

quantityinteger

Quantity of the item

condimentsarray[string]

List of condiments for the item

Example