init commit

2025-02-13 11:29:07 +01:00
commit dd619df7a2
78 changed files with 5266 additions and 0 deletions
@@ -0,0 +1,102 @@
+openapi: 3.0.3
+info:
+  description: Announcing patchnotes for KanzleiApp
+  title: announcementService
+  version: 1.0.0
+servers:
+- url: /
+paths:
+  /patchnotes:
+    get:
+      description: returns list of all unseen Patch notes from the user
+      operationId: get_patchnotes
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/patch_notes'
+                type: array
+          description: returns list of all unseen Patch notes from the user
+        "404":
+          description: no Patch notes found
+        "500":
+          description: "Internal Server error, Failed to get Patch Notes"
+      tags:
+      - Patchnotes
+      x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
+    post:
+      description: creates new Patch notes
+      operationId: post_patchnotes
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/patch_notes'
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/patch_notes'
+                type: array
+          description: game created
+      tags:
+      - Patchnotes
+      x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
+  /patchnotes/{patchID}:
+    delete:
+      description: deletes one Patch note
+      operationId: patch_note_delete
+      parameters:
+      - explode: false
+        in: path
+        name: patchID
+        required: true
+        schema:
+          format: uuid
+          type: string
+        style: simple
+      responses:
+        "200":
+          description: patch successfully deleted
+        "404":
+          description: patch not found
+        "500":
+          description: "Internal Server Error, Patch not deleted"
+      tags:
+      - Patchnotes
+      x-openapi-router-controller: openapi_server.controllers.patchnotes_controller
+components:
+  schemas:
+    patch_notes:
+      example:
+        patchID: 29e80bcc-5981-4a52-99e1-373442dea9b9
+        title: Patch note 1
+        changes: changes
+        date: date
+      properties:
+        patchID:
+          format: uuid
+          title: patchID
+          type: string
+        title:
+          title: title
+          type: string
+        changes:
+          title: changes
+          type: string
+        date:
+          title: date
+          type: string
+      title: patch_notes
+    user:
+      example:
+        lastNoteChecked: f00fa08d-0cd8-4c05-9409-5e75aa2d4f68
+      properties:
+        lastNoteChecked:
+          format: uuid
+          title: lastNoteChecked
+          type: string