docs: add OpenAPI documentation

This commit is contained in:
2025-08-12 17:29:02 +02:00
parent cd91ac11f9
commit aab7ff1452
25 changed files with 2422 additions and 0 deletions

View File

@@ -0,0 +1,59 @@
get:
tags:
- Recipe
summary: "Find recipes"
operationId: "FindRecipes"
parameters:
- name: "category"
in: "query"
required: false
schema:
type: "string"
description: "Category name filter (equals, ignores case)"
- name: "recipe"
in: "query"
required: false
schema:
type: "string"
description: "Recipe name filter (contains, ignores case)"
- name: "limit"
in: "query"
required: true
schema:
type: "integer"
format: "int64"
minimum: 1
maximum: 100
description: "Maximum number of recipes to return"
- name: "offset"
in: "query"
required: true
schema:
type: "integer"
format: "int64"
minimum: 0
description: "Index into result set from where recipes will start to be returned"
responses:
200:
description: OK
content:
"application/json":
schema:
type: "array"
items:
$ref: "../schemas/Recipe.yaml"
examples:
dipsOut:
$ref: "../examples/DipsOut.yaml"
400:
description: Bad Request
content:
"application/json":
schema:
$ref: "../schemas/ProblemDetail.yaml"
404:
description: Not Found
content:
"application/json":
schema:
$ref: "../schemas/ProblemDetail.yaml"