fix(bpmn-service): changed basePath (#383)

changed basePath from '/workflow' to '/workflows' BREAKING CHANGE: changed basePath from '/workflow' to '/workflows' gh-382
sourcefuse · Oct 20, 2021 · d6e1dce · d6e1dce
1 parent e87892a
commit d6e1dce
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 27 deletions.
diff --git a/services/bpmn-service/openapi.json b/services/bpmn-service/openapi.json
@@ -9,7 +9,7 @@
     }
   },
   "paths": {
-    "/workflow/{id}/execute": {
+    "/workflows/{id}/execute": {
       "post": {
         "x-controller-name": "WorkflowController",
         "x-operation-name": "startWorkflow",
@@ -49,7 +49,7 @@
         "operationId": "WorkflowController.startWorkflow"
       }
     },
-    "/workflow/{id}/version/{version}": {
+    "/workflows/{id}/version/{version}": {
       "delete": {
         "x-controller-name": "WorkflowController",
         "x-operation-name": "deleteVersionById",
@@ -87,7 +87,7 @@
         "operationId": "WorkflowController.deleteVersionById"
       }
     },
-    "/workflow/{id}": {
+    "/workflows/{id}": {
       "patch": {
         "x-controller-name": "WorkflowController",
         "x-operation-name": "updateById",
@@ -182,7 +182,7 @@
         "operationId": "WorkflowController.deleteById"
       }
     },
-    "/workflow": {
+    "/workflows": {
       "post": {
         "x-controller-name": "WorkflowController",
         "x-operation-name": "create",

diff --git a/services/bpmn-service/openapi.md b/services/bpmn-service/openapi.md
@@ -48,7 +48,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}/execute',
+fetch('/workflows/{id}/execute',
 {
   method: 'POST',
   body: inputBody,
@@ -73,7 +73,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}/execute',
+fetch('/workflows/{id}/execute',
 {
   method: 'POST',
   body: JSON.stringify(inputBody),
@@ -87,7 +87,7 @@ fetch('/workflow/{id}/execute',
 
 ```
 
-`POST /workflow/{id}/execute`
+`POST /workflows/{id}/execute`
 
 > Body parameter
 
@@ -128,7 +128,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}/version/{version}',
+fetch('/workflows/{id}/version/{version}',
 {
   method: 'DELETE',
 
@@ -149,7 +149,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}/version/{version}',
+fetch('/workflows/{id}/version/{version}',
 {
   method: 'DELETE',
 
@@ -163,7 +163,7 @@ fetch('/workflow/{id}/version/{version}',
 
 ```
 
-`DELETE /workflow/{id}/version/{version}`
+`DELETE /workflows/{id}/version/{version}`
 
 <h3 id="workflowcontroller.deleteversionbyid-parameters">Parameters</h3>
 
@@ -201,7 +201,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}',
+fetch('/workflows/{id}',
 {
   method: 'PATCH',
   body: inputBody,
@@ -228,7 +228,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}',
+fetch('/workflows/{id}',
 {
   method: 'PATCH',
   body: JSON.stringify(inputBody),
@@ -242,7 +242,7 @@ fetch('/workflow/{id}',
 
 ```
 
-`PATCH /workflow/{id}`
+`PATCH /workflows/{id}`
 
 > Body parameter
 
@@ -285,7 +285,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}',
+fetch('/workflows/{id}',
 {
   method: 'GET',
 
@@ -306,7 +306,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}',
+fetch('/workflows/{id}',
 {
   method: 'GET',
 
@@ -320,7 +320,7 @@ fetch('/workflow/{id}',
 
 ```
 
-`GET /workflow/{id}`
+`GET /workflows/{id}`
 
 <h3 id="workflowcontroller.count-parameters">Parameters</h3>
 
@@ -351,7 +351,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}',
+fetch('/workflows/{id}',
 {
   method: 'DELETE',
 
@@ -372,7 +372,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow/{id}',
+fetch('/workflows/{id}',
 {
   method: 'DELETE',
 
@@ -386,7 +386,7 @@ fetch('/workflow/{id}',
 
 ```
 
-`DELETE /workflow/{id}`
+`DELETE /workflows/{id}`
 
 <h3 id="workflowcontroller.deletebyid-parameters">Parameters</h3>
 
@@ -424,7 +424,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow',
+fetch('/workflows',
 {
   method: 'POST',
   body: inputBody,
@@ -452,7 +452,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow',
+fetch('/workflows',
 {
   method: 'POST',
   body: JSON.stringify(inputBody),
@@ -466,7 +466,7 @@ fetch('/workflow',
 
 ```
 
-`POST /workflow`
+`POST /workflows`
 
 > Body parameter
 
@@ -532,7 +532,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow',
+fetch('/workflows',
 {
   method: 'GET',
 
@@ -554,7 +554,7 @@ const headers = {
   'Authorization':'Bearer {access-token}'
 };
 
-fetch('/workflow',
+fetch('/workflows',
 {
   method: 'GET',
 
@@ -568,7 +568,7 @@ fetch('/workflow',
 
 ```
 
-`GET /workflow`
+`GET /workflows`
 
 <h3 id="workflowcontroller.find-parameters">Parameters</h3>
 

diff --git a/services/bpmn-service/src/__tests__/acceptance/workflow.controller.acceptance.ts b/services/bpmn-service/src/__tests__/acceptance/workflow.controller.acceptance.ts
@@ -16,7 +16,7 @@ describe('Workflow Controller', () => {
   let mockBpmnEngine: MockEngine;
   let workflowRepo: WorkflowRepository;
   let workflowVersionRepo: WorkflowVersionRepository;
-  const basePath = '/workflow';
+  const basePath = '/workflows';
   const pass = 'test_password';
   const testUser = {
     id: 1,

diff --git a/services/bpmn-service/src/controllers/workflow.controller.ts b/services/bpmn-service/src/controllers/workflow.controller.ts
@@ -32,7 +32,7 @@ import {
   WorkerImplementationFn,
   WorkerMap,
 } from '../types';
-const basePath = '/workflow';
+const basePath = '/workflows';
 
 export class WorkflowController {
   constructor(