浏览代码

Create the openapi.yaml for docs.

Lee Morgan 2 月之前
父节点
当前提交
26918f240f
共有 1 个文件被更改,包括 38 次插入0 次删除
  1. 38 0
      docs/openapi.yaml

+ 38 - 0
docs/openapi.yaml

@@ -0,0 +1,38 @@
+openapi: 3.0.4
+info:
+  title: API Documentation | Homo
+  version: 1.0.0
+  description: API for Homo, home automation software
+
+servers:
+  - url: http://0.0.0.0:9123
+    description: Development/local server
+
+x-tagGroups:
+  - name: User
+    tags:
+      - User
+
+components:
+  schemas:
+    User:
+      $ref: "./components/schemas/user.yaml"
+  responses:
+    "400":
+      $ref: "./components/responses/400.yaml"
+    "401":
+      $ref: "./components/responses/401.yaml"
+    "403":
+      $ref: "./components/responses/403.yaml"
+    "404":
+      $ref: "./components/responses/404.yaml"
+    "500":
+      $ref: "./components/responses/500.yaml"
+  securitySchemes:
+    $ref: "./components/security.yaml"
+
+paths:
+  #User
+  /user:
+    post:
+      $ref: "./paths/user/create.yaml"