Adjustable api routing (#139)

* refactoring(architecture): available POST as alias for PATCH * release: services and web client * fix(client): correctly toggle API trough ENV
FraunhoferISST · Jan 24, 2022 · 291de52 · 291de52
1 parent fa90bc3
commit 291de52
Show file tree

Hide file tree

Showing 23 changed files with 254 additions and 100 deletions.
diff --git a/core/services/asset-management/apiDoc/openapi.yml b/core/services/asset-management/apiDoc/openapi.yml
@@ -178,6 +178,33 @@ paths:
           $ref: "#/components/responses/AssetAlreadyExistsError"
         "500":
           $ref: "#/components/responses/UnexpectedError"
+    post:
+      tags:
+        - assets
+      summary: Patch asset (alias for PATCH)
+      description: Use this method to do a partial update of the asset. In the request provided fields
+        will be merged with the existing asset object.
+      operationId: patchAsset
+      parameters:
+        - name: id
+          in: path
+          description: id of the asset
+          required: true
+          schema:
+            type: string
+      requestBody:
+        $ref: "#/components/requestBodies/AssetsPatch"
+      responses:
+        "200":
+          $ref: "#/components/responses/SuccessEmpty"
+        "406":
+          $ref: "#/components/responses/InvalidDataError"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "409":
+          $ref: "#/components/responses/AssetAlreadyExistsError"
+        "500":
+          $ref: "#/components/responses/UnexpectedError"
     delete:
       tags:
         - assets

diff --git a/core/services/asset-management/package.json b/core/services/asset-management/package.json
@@ -1,6 +1,6 @@
 {
   "name": "asset-management",
-  "version": "17.2.3",
+  "version": "17.2.4",
   "description": "",
   "main": "index.js",
   "scripts": {

diff --git a/core/services/asset-management/routes/assets.js b/core/services/asset-management/routes/assets.js
@@ -7,6 +7,7 @@ router.get("/", AssetsController.getAssets);
 router.get("/:id", AssetsController.getAsset);
 router.post("/", AssetsController.createAsset);
 router.patch("/:id", AssetsController.patchAsset);
+router.post("/:id", AssetsController.patchAsset);
 router.delete("/:id", AssetsController.deleteAsset);
 router.put("/:id/entities", AssetsController.linkEntity);
 router.get("/:id/entities", AssetsController.getLinkedEntities);

diff --git a/core/services/resource-management/apiDoc/openapi.yml b/core/services/resource-management/apiDoc/openapi.yml
@@ -175,6 +175,35 @@ paths:
           $ref: "#/components/responses/ResourceAlreadyExistsError"
         "500":
           $ref: "#/components/responses/UnexpectedError"
+    post:
+      tags:
+        - resources
+      summary: Post resource (alias for patch)
+      description: Use this method to do a partial update of the resource. In the request provided fields
+        will be merged with the existing resource object. Merge is always performed at the root level. Empty patches are
+        not accepted
+      operationId: patchResource
+      parameters:
+        - $ref: "#/components/parameters/useridParam"
+        - name: id
+          in: path
+          description: id of the resource
+          required: true
+          schema:
+            type: string
+      requestBody:
+        $ref: "#/components/requestBodies/ResourcesPatch"
+      responses:
+        "200":
+          $ref: "#/components/responses/SuccessEmpty"
+        "406":
+          $ref: "#/components/responses/InvalidDataError"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "409":
+          $ref: "#/components/responses/ResourceAlreadyExistsError"
+        "500":
+          $ref: "#/components/responses/UnexpectedError"
     delete:
       tags:
         - resources

diff --git a/core/services/resource-management/package.json b/core/services/resource-management/package.json
@@ -1,6 +1,6 @@
 {
   "name": "resource-management",
-  "version": "17.0.2",
+  "version": "17.0.3",
   "description": "Manages metadata of resources and publishes CRUD events to kafka",
   "repository": {
     "url": "https://gitlab.cc-asp.fraunhofer.de/diva/drm"

diff --git a/core/services/resource-management/routes/resources.js b/core/services/resource-management/routes/resources.js
@@ -7,6 +7,7 @@ router.get("/", ResourcesController.getResources);
 router.get("/:id", ResourcesController.getResource);
 router.post("/", ResourcesController.createResource);
 router.patch("/:id", ResourcesController.patchResource);
+router.post("/:id", ResourcesController.patchResource);
 router.delete("/:id", ResourcesController.deleteResource);
 
 module.exports = router;
diff --git a/core/services/review-management/apiDoc/openapi.yml b/core/services/review-management/apiDoc/openapi.yml
@@ -164,6 +164,32 @@ paths:
           $ref: "#/components/responses/NotFoundError"
         "5XX":
           $ref: "#/components/responses/UnexpectedError"
+    post:
+      tags:
+        - reviews
+      summary: Post review (alias for patch)
+      description: Use this method to do a partial update of the review. In the request provided fields
+        will be merged with the existing review object.
+      operationId: patchReview
+      parameters:
+        - $ref: "#/components/parameters/actorIdParam"
+        - name: id
+          in: path
+          description: id of the asset
+          required: true
+          schema:
+            type: string
+      requestBody:
+        $ref: "#/components/requestBodies/ReviewPatch"
+      responses:
+        "200":
+          $ref: "#/components/responses/SuccessEmpty"
+        "406":
+          $ref: "#/components/responses/InvalidDataError"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "5XX":
+          $ref: "#/components/responses/UnexpectedError"
 
     delete:
       tags:

diff --git a/core/services/review-management/package.json b/core/services/review-management/package.json
@@ -1,6 +1,6 @@
 {
   "name": "review-management",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Manages entities reviews",
   "repository": {
     "url": "https://gitlab.cc-asp.fraunhofer.de/diva/drm"

diff --git a/core/services/review-management/routes/reviews.js b/core/services/review-management/routes/reviews.js
@@ -8,6 +8,7 @@ router.post("/", reviewsController.createReview);
 router.get("/", reviewsController.getReviews);
 router.get("/:id", reviewsController.getReview);
 router.patch("/:id", reviewsController.patchReview);
+router.post("/:id", reviewsController.patchReview);
 router.delete("/:id", reviewsController.deleteReview);
 
 module.exports = router;
diff --git a/core/services/service-management/apiDoc/openapi.yml b/core/services/service-management/apiDoc/openapi.yml
@@ -177,6 +177,34 @@ paths:
           $ref: "#/components/responses/InvalidDataError"
         "500":
           $ref: "#/components/responses/UnexpectedError"
+    post:
+      tags:
+        - services
+      summary: Post service (alias for patch)
+      description: Use this method to do a partial update of the service. In the request provided fields
+        will be merged with the existing service object.
+      operationId: patchService
+      parameters:
+        - $ref: "#/components/parameters/actorIdParam"
+        - name: id
+          in: path
+          description: id of the service
+          required: true
+          schema:
+            type: string
+      requestBody:
+        $ref: "#/components/requestBodies/ServicesPatch"
+      responses:
+        "200":
+          $ref: "#/components/responses/SuccessEmpty"
+        "4XX":
+          $ref: "#/components/responses/RequestValidationError"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "406":
+          $ref: "#/components/responses/InvalidDataError"
+        "500":
+          $ref: "#/components/responses/UnexpectedError"
     delete:
       tags:
         - services

diff --git a/core/services/service-management/package.json b/core/services/service-management/package.json
@@ -1,6 +1,6 @@
 {
   "name": "service-management",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "",
   "main": "index.js",
   "scripts": {

diff --git a/core/services/service-management/routes/services.js b/core/services/service-management/routes/services.js
@@ -7,6 +7,7 @@ router.get("/", ServicesController.getServices);
 router.get("/:id", ServicesController.getService);
 router.post("/", ServicesController.createService);
 router.patch("/:id", ServicesController.patchService);
+router.post("/:id", ServicesController.patchService);
 router.delete("/:id", ServicesController.deleteService);
 
 module.exports = router;
diff --git a/core/services/user-management/apiDoc/openapi.yml b/core/services/user-management/apiDoc/openapi.yml
@@ -181,6 +181,28 @@ paths:
           $ref: "#/components/responses/UserAlreadyExistsError"
         "500":
           $ref: "#/components/responses/UnexpectedError"
+    post:
+      tags:
+        - users
+      summary: Post user (alias for PATCH)
+      description: Use this method to do a partial updated of the user document. In the request provided fields
+        will be merged with the existing user object.
+      operationId: patchUser
+      requestBody:
+        $ref: "#/components/requestBodies/UsersPatch"
+      responses:
+        "200":
+          $ref: "#/components/responses/SuccessEmpty"
+        "400":
+          $ref: "#/components/responses/RequestValidationError"
+        "406":
+          $ref: "#/components/responses/InvalidDataError"
+        "404":
+          $ref: "#/components/responses/NotFoundError"
+        "409":
+          $ref: "#/components/responses/UserAlreadyExistsError"
+        "500":
+          $ref: "#/components/responses/UnexpectedError"
     delete:
       tags:
         - users

diff --git a/core/services/user-management/package.json b/core/services/user-management/package.json
@@ -1,6 +1,6 @@
 {
   "name": "user-management",
-  "version": "5.0.3",
+  "version": "5.0.4",
   "description": "User management service with CRUD operations for users",
   "main": "index.js",
   "scripts": {

diff --git a/core/services/user-management/routes/users.js b/core/services/user-management/routes/users.js
@@ -9,6 +9,7 @@ router.get("/", usersController.getUsers);
 router.get("/:id", usersController.getUser);
 router.put("/:id", usersController.updateUser);
 router.patch("/:id", usersController.patchUser);
+router.post("/:id", usersController.patchUser);
 router.delete("/:id", usersController.deleteUser);
 
 module.exports = router;
diff --git a/core/web-client/.dockerignore b/core/web-client/.dockerignore
@@ -0,0 +1 @@
+.env*
diff --git a/core/web-client/.env.default b/core/web-client/.env.default
@@ -0,0 +1,13 @@
+# Web Client runtime
+#______________________
+# if using the nginx reverse proxy, make sure that this port is not reachable from external (set your firewall...)
+WEB_CLIENT_PORT=70
+# if using the nginx reverse proxy example configuration, set VUE_APP_API_GATEWAY_URL to e.g. "https://your-diva-domain.com/api"
+VUE_APP_API_GATEWAY_URL=http://localhost:8000
+VUE_APP_KEYCLOAK_URL=http://172.17.0.1:7000/auth
+VUE_APP_KEYCLOAK_REALM=diva-kc-realm
+VUE_APP_KEYCLOAK_CLIENT_ID=diva-kc-client
+# disable registration for users
+VUE_APP_REGISTER_AVAILABLE=true
+# prohibit usage of PATCH request
+VUE_APP_DISABLE_PATCH=false
diff --git a/core/web-client/entrypoint.sh b/core/web-client/entrypoint.sh
@@ -22,6 +22,9 @@ do
   echo "VUE_APP_REGISTER_AVAILABLE: ${VUE_APP_REGISTER_AVAILABLE}"
   sed -i 's|register_available|'$VUE_APP_REGISTER_AVAILABLE'|g' $file
 
+  echo "VUE_APP_DISABLE_PATCH: ${VUE_APP_DISABLE_PATCH}"
+  sed -i 's|patch_available|'$VUE_APP_DISABLE_PATCH'|g' $file
+
   echo "Hashing $file"
   hash=$(md5sum "$file" | cut -c1-8)
   echo "$hash"