initial

2021-01-16 19:47:34 +01:00
commit 9a907c3a8e
8 changed files with 310 additions and 0 deletions
--- a/swagger.yaml
+++ b/swagger.yaml
@ -0,0 +1,102 @@
+swagger: '2.0'
+info:
+  title: Hausverwaltung
+  version: "0.1"
+
+paths:
+  /hv/objekte:
+    get:
+      tags: [ "Objekte" ]
+      operationId: Objekte.get_objekte
+      summary: Returns all Objekte
+      responses:
+        200:
+          description: Successful response.
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/Objekt'
+        404:
+          description: No Objekte available
+        500:
+          description: Some server error
+  /hv/objekt/{id}:
+    get:
+      tags: [ "Objekte" ]
+      operationId: Objekte.get_objekt
+      summary: Returns Objekt by id
+      parameters:
+        - name: id
+          in: path
+          type: integer
+          required: true
+      responses:
+        200:
+          description: Successful response.
+          schema:
+            $ref: '#/definitions/Objekt'
+        404:
+          description: Objekt not found
+        500:
+          description: Some server error
+  /hv/wohnungen:
+    get:
+      tags: [ "Wohnungen" ]
+      operationId: Wohnungen.get_wohnungen
+      summary: Returns all Wohnungen
+      responses:
+        200:
+          description: Successful response.
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/Wohnung'
+        404:
+          description: No Wohnung available
+        500:
+          description: Some server error
+  /hv/wohnung/{id}:
+    get:
+      tags: [ "Wohnungen" ]
+      operationId: Wohnungen.get_wohnung
+      summary: Returns Wohnung by id
+      parameters:
+        - name: id
+          in: path
+          type: integer
+          required: true
+      responses:
+        200:
+          description: Successful response.
+          schema:
+            $ref: '#/definitions/Wohnung'
+        404:
+          description: Wohnung not found
+        500:
+          description: Some server error
+
+definitions:
+  Objekt:
+    description: Objekt type
+    type: object
+    properties:
+      id: 
+        type: integer
+      shortname: 
+        type: string
+      flaeche:
+        type: number
+  Wohnung:
+    description: Wohnung type
+    type: object
+    properties:
+      id: 
+        type: integer
+      objekt_id: 
+        type: integer
+      wohnung: 
+        type: string
+      flaeche:
+        type: number
+      objekt:
+        type: string