Merge branch 'main' into feature/swagger-ui

README.md

@@ -18,8 +18,10 @@ Darauf basierend haben wir unsere REST-API für den _AccountService_ designt:
 
 ## SOAP vs. REST vs. GraphQL
 
+Ein Repository mit Implementierungen für Spring Boot sowie ergänzend gRPC findest Du [hier](https://github.com/ueberfuhr/api-comparison).
+
 Kriterium| SOAP | REST | GraphQL
 -------- |-------- | -------- | --------
 HTTP     | nur Überträger (nur POST, nur 1 URL) | möglichst vollständig | nur Überträger (nur POST, nur 1 URL)
 Austauschformat | XML (SOAP XSD, W3C-Standards) | JSON o.a. (Content Negotiation) | JSON (Query Syntax in Request Body)
-Vorteil | Nutzen der W3C-XML-*-Standards | Kompatibilität mit HTTP-Netzwerk-Komponenten (Proxies, Firewalls,...), einfaches Ansprechen vom Frontend | Dynamische Datenstrukturen bei der Abfrage (Lazy Loading in der Implementierung), JSON erlaubt Aufrufe vom Frontend wie REST
+Vorteil | Nutzen der W3C-XML-*-Standards | Kompatibilität mit HTTP-Netzwerk-Komponenten (Proxies, Firewalls,...), einfaches Ansprechen vom Frontend | Dynamische Datenstrukturen bei der Abfrage (Lazy Loading in der Implementierung), JSON erlaubt Aufrufe vom Frontend wie REST

openapi.yml

@@ -19,6 +19,11 @@ paths:
       tags:
         - customers
       summary: Read all customers
+      parameters:
+        - name: state
+          in: query
+          schema:
+            $ref: "#/components/schemas/CustomerState"
       responses:
         '200':
           description: Customers were read successfully
@@ -93,6 +98,26 @@ paths:
           description: Customer is invalid
         '404':
           description: Customer could not be found
+    patch:
+      tags:
+        - customers
+      summary: Update the status of the customer
+      security:
+        - openId:
+            - writer_access
+      requestBody:
+        content:
+          application/merge-patch+json:
+            schema:
+              $ref: '#/components/schemas/CustomerPatch'
+        required: true
+      responses:
+        '204':
+          description: Customer state wassuccessfully updated
+        '400':
+          description: Request body is invalid
+        '404':
+          description: Customer could not be found
     delete:
       tags:
         - customers
@@ -245,6 +270,12 @@ paths:
           description: Customer could not be found
 components:
   schemas:
+    CustomerState:
+      type: string
+      enum:
+        - active
+        - locked
+        - disabled
     Customer:
       required:
         - birthdate
@@ -262,6 +293,13 @@ components:
         birthdate:
           type: string
           format: date
+        state:
+          $ref: "#/components/schemas/CustomerState"
+    CustomerPatch:
+      type: object
+      properties:
+        state:
+          $ref: "#/components/schemas/CustomerState"
     Address:
       required:
         - city
@@ -315,4 +353,4 @@ components:
   securitySchemes:
     openId:
       type: openIdConnect
-      openIdConnectUrl: https://<keycloak-server>/.well-known/openid-configuration
+      openIdConnectUrl: https://my-keycloak-server/.well-known/openid-configuration