tobias-haenel/recipe-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add OpenAPI documentation

Browse Source
This commit is contained in:
Tobias Hänel
2025-08-12 17:29:02 +02:00
parent cd91ac11f9
commit aab7ff1452
25 changed files with 2422 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
openapi/examples/AccountIn.yaml Normal file
View File

@@ -0,0 +1,6 @@
summary: Account registration
value:
{
"email": "ada@example.com",
"password": "FBR5h0L1ENA3edctgDIEnxSvFdR0",
}

45
openapi/examples/DipsOut.yaml Normal file
View File

@@ -0,0 +1,45 @@
summary: Dip category search
value:
[
{
"id": 3,
"name": "Muhammara",
"description": "Muhammara is a vibrant and flavorful dip or spread from the Middle East, particularly popular in Syrian and Turkish cuisine. It's made primarily from roasted red bell peppers, walnuts, breadcrumbs, and pomegranate molasses.",
"changedAt": "2025-08-08T16:24:44.673034Z",
"categories": [ "Dip" ],
"ingredients":
[
"Pomegranate molasses",
"Red bell peppers",
"Bread crumbs",
"Cumin",
"Chili flakes",
"Garlic",
"Walnuts",
"Lemon juice",
],
"steps":
[
"Roast whole bell peppers in an oven or air fryer and wait until blackened on the outside.",
"Put the peppers in a bowl cover them with to let steam and cool down",
"Remove core seeds, and skins",
"Combine all the ingredients in a food processor.",
"Process until mostly smooth but with a little texture remaining.",
"Taste and adjust flavor as needed (lemon for acidity, pomegranate molasses for sweetness)",
],
},
{
"id": 2,
"name": "Hummus",
"description": "Hummus, is a Levantine dip, spread, or savory dish made from cooked, mashed chickpeas blended with tahini, lemon juice, and garlic.",
"changedAt": "2025-08-08T16:24:44.579213Z",
"categories": [ "Dip" ],
"ingredients": [ "Chickpeas", "Tahini", "Lemon juice", "Garlic" ],
"steps":
[
"Combine chickpeas, tahini, lemon juice, garlic, and salt in a food processor.",
"Blend until smooth, slowly adding cold water until you reach a creamy consistency.",
"Taste and adjust seasoning if needed.",
],
},
]

15
openapi/examples/HummusV1In.yaml Normal file
View File

@@ -0,0 +1,15 @@
summary: Hummus recipe
value:
{
"name": "Hummus",
"description": "Hummus, is a Levantine dip, spread, or savory dish made from cooked, mashed chickpeas blended with tahini, lemon juice, and garlic.",
"categories": [ "Dip", "Spread" ],
"ingredients":
[ "Chickpeas", "Tahini", "Olive oil", "Lemon juice", "Garlic" ],
"steps":
[
"Combine chickpeas, tahini, olive oil, lemon juice, garlic, and salt in a food processor.",
"Blend until smooth, slowly adding cold water until you reach a creamy consistency.",
"Taste and adjust seasoning if needed.",
],
}

17
openapi/examples/HummusV1Out.yaml Normal file
View File

@@ -0,0 +1,17 @@
summary: Hummus recipe
value:
{
"id": 1729,
"name": "Hummus",
"description": "Hummus, is a Levantine dip, spread, or savory dish made from cooked, mashed chickpeas blended with tahini, lemon juice, and garlic.",
"changedAt": "2025-08-08T15:35:10.294411Z",
"categories": [ "Dip", "Spread" ],
"ingredients":
[ "Chickpeas", "Tahini", "Olive oil", "Lemon juice", "Garlic" ],
"steps":
[
"Combine chickpeas, tahini, olive oil, lemon juice, garlic, and salt in a food processor.",
"Blend until smooth, slowly adding cold water until you reach a creamy consistency.",
"Taste and adjust seasoning if needed.",
],
}

14
openapi/examples/HummusV2In.yaml Normal file
View File

@@ -0,0 +1,14 @@
summary: Hummus recipe update
value:
{
"name": "Hummus",
"description": "Hummus, is a Levantine dip, spread, or savory dish made from cooked, mashed chickpeas blended with tahini, lemon juice, and garlic.",
"categories": [ "Dip", "Spread" ],
"ingredients": [ "Chickpeas", "Tahini", "Lemon juice", "Garlic" ],
"steps":
[
"Combine chickpeas, tahini, lemon juice, garlic, and salt in a food processor.",
"Blend until smooth, slowly adding cold water until you reach a creamy consistency.",
"Taste and adjust seasoning if needed.",
],
}

16
openapi/examples/HummusV2Out.yaml Normal file
View File

@@ -0,0 +1,16 @@
summary: Hummus recipe update
value:
{
"id": 1729,
"name": "Hummus",
"description": "Hummus, is a Levantine dip, spread, or savory dish made from cooked, mashed chickpeas blended with tahini, lemon juice, and garlic.",
"changedAt": "2025-08-09T12:48:32.134821Z",
"categories": [ "Dip", "Spread" ],
"ingredients": [ "Chickpeas", "Tahini", "Lemon juice", "Garlic" ],
"steps":
[
"Combine chickpeas, tahini, lemon juice, garlic, and salt in a food processor.",
"Blend until smooth, slowly adding cold water until you reach a creamy consistency.",
"Taste and adjust seasoning if needed.",
],
}