@vida-global/core 2.3.5 → 2.3.6

package/lib/server/openApi/apiDocGenerator.js

@@ -216,7 +216,7 @@ class ApiDocGenerator {
 
 
     get endpoint() {
-        return this.#action.path.replace(/:([^/]+)/g, '{$1}');
+        return this.#action.path.replace(/:([^/?]+)\??/g, '{$1}');
     }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vida-global/core",
-    "version": "2.3.5",
+    "version": "2.3.6",
     "description": "Core libraries for supporting Vida development",
     "author": "",
     "license": "ISC",

package/test/server/apiDocGenerator.test.js

@@ -70,6 +70,15 @@ describe('ApiDocGenerator', () => {
             expect(generator.endpoint).toEqual(formattedUrl);
         });
 
+        it ('removes the Express optional marker from a path parameter', () => {
+            const requiredName = Faker.Text.randomString();
+            const optionalName = Faker.Text.randomString();
+            const action = { path: `/things/:${requiredName}/:${optionalName}?` };
+            const generator = new ApiDocGenerator(action, ControllerClass);
+
+            expect(generator.endpoint).toEqual(`/things/{${requiredName}}/{${optionalName}}`);
+        });
+
         it ('returns the path unchanged when there are no params', () => {
             const path      = `/${Faker.Text.randomString()}/${Faker.Text.randomString()}`;
             const action    = { path };
@@ -157,6 +166,25 @@ describe('ApiDocGenerator', () => {
             expect(generator.pathParams.id.required).toBe(true);
         });
 
+        it ('uses the validator definition for an optional Express path parameter', () => {
+            const parameterName = Faker.Text.randomString();
+            const description   = Faker.Text.randomString();
+            const action = { action: 'getRecord', method: 'GET', path: `/things/:${parameterName}?` };
+            ControllerClass.parametersForAction.mockReturnValue({
+                [parameterName]: { isString: true, optional: true, description },
+            });
+            const generator = new ApiDocGenerator(action, ControllerClass);
+
+            expect(generator.pathParams[parameterName]).toEqual({
+                name:        parameterName,
+                in:          'path',
+                required:    true,
+                description,
+                schema:      { type: 'string' },
+            });
+            expect(generator.pathParams[`${parameterName}?`]).toBeUndefined();
+        });
+
         it ('excludes parameters that are not in the path', () => {
             const action = { action: 'getRecord', method: 'GET', path: '/user/:id' };
             ControllerClass.parametersForAction.mockReturnValue({
@@ -214,6 +242,17 @@ describe('ApiDocGenerator', () => {
             expect(Object.keys(generator.queryParams)).toEqual(['detail']);
         });
 
+        it ('does not duplicate an optional Express path parameter as a query parameter', () => {
+            const parameterName = Faker.Text.randomString();
+            const action = { action: 'getRecord', method: 'GET', path: `/things/:${parameterName}?` };
+            ControllerClass.parametersForAction.mockReturnValue({
+                [parameterName]: { isString: true, optional: true },
+            });
+            const generator = new ApiDocGenerator(action, ControllerClass);
+
+            expect(generator.queryParams[parameterName]).toBeUndefined();
+        });
+
     });