docs: add OpenAPI documentation

2025-08-12 17:29:02 +02:00
parent cd91ac11f9
commit aab7ff1452
25 changed files with 2422 additions and 0 deletions
--- a/openapi/paths/recipe-new.yaml
+++ b/openapi/paths/recipe-new.yaml
@@ -0,0 +1,50 @@
+post:
+  tags:
+    - Recipe
+  summary: "Add a recipe"
+  operationId: "addRecipe"
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: "../schemas/Recipe.yaml"
+        examples:
+          recipeIn:
+            $ref: "../examples/HummusV1In.yaml"
+    required: true
+  responses:
+    200:
+      description: OK
+      content:
+        "application/json":
+          schema:
+            $ref: "../schemas/Recipe.yaml"
+          examples:
+            recipeOut:
+              $ref: "../examples/HummusV1Out.yaml"
+    400:
+      description: Bad Request
+      content:
+        "application/json":
+          schema:
+            $ref: "../schemas/ProblemDetail.yaml"
+    401:
+      description: Unauthorized
+      content:
+        "application/json":
+          schema:
+            $ref: "../schemas/ProblemDetail.yaml"
+    403:
+      description: Forbidden
+      content:
+        "application/json":
+          schema:
+            $ref: "../schemas/ProblemDetail.yaml"
+    404:
+      description: Not Found
+      content:
+        "application/json":
+          schema:
+            $ref: "../schemas/ProblemDetail.yaml"
+  security:
+    - httpBasic: [ ]