Przeglądaj źródła

Create schema for home docs

Lee Morgan 2 miesięcy temu
rodzic
commit
2a820f4022

+ 17 - 0
docs/components/schemas/home.yaml

@@ -0,0 +1,17 @@
+type: object
+properties:
+  id:
+    type: string
+    format: uuid
+    description: Unique ID of the home (v7)
+    example: 019e12d7-a9a0-7817-bcb8-564bf2aced87
+  name:
+    type: string
+    description: User created name of the home
+    example: summer_home
+  created_at:
+    type: string
+    format: date
+    description: Date the home was created
+    example: 2026-05-10T17:05:04.464Z
+

+ 1 - 1
docs/components/schemas/user.yaml

@@ -3,7 +3,7 @@ properties:
   id:
     type: string
     format: uuid
-    description: Unique ID of the user
+    description: Unique ID of the user (v7)
     example: 019e03fe-c7e3-7c48-8f06-724cba55176b
   name:
     type: string

+ 2 - 0
docs/openapi.yaml

@@ -17,6 +17,8 @@ components:
   schemas:
     User:
       $ref: "./components/schemas/user.yaml"
+    Home:
+      $ref: "./components/schemas/home.yaml"
   responses:
     "400":
       $ref: "./components/responses/400.yaml"