feat: REST Naming convention

panoratech · Jul 29, 2024 · f17012a · f17012a
1 parent b7ef10f
commit f17012a
Show file tree

Hide file tree

Showing 4 changed files with 223 additions and 223 deletions.
diff --git a/packages/api/scripts/commonObject.sh b/packages/api/scripts/commonObject.sh
@@ -333,8 +333,8 @@ private connectionUtils: ConnectionUtils
 
   @ApiOperation({
     operationId: 'get${ObjectCap}',
-    summary: 'Retrieve a ${ObjectCap}',
-    description: 'Retrieve a ${objectType} from any connected ${VerticalCap} software',
+    summary: 'Retrieve ${ObjectCap}',
+    description: 'Retrieve ${objectType} from any connected ${VerticalCap} software',
   })
   @ApiParam({
     name: 'id',
@@ -360,8 +360,8 @@ private connectionUtils: ConnectionUtils
 
   @ApiOperation({
     operationId: 'add${ObjectCap}',
-    summary: 'Create a ${ObjectCap}',
-    description: 'Create a ${objectType} in any supported ${VerticalCap} software',
+    summary: 'Create ${ObjectCap}',
+    description: 'Create ${objectType} in any supported ${VerticalCap} software',
   })
    @ApiHeader({
     name: 'x-connection-token',

diff --git a/packages/api/src/accounting/account/account.controller.ts b/packages/api/src/accounting/account/account.controller.ts
@@ -128,7 +128,7 @@ export class AccountController {
 
   @ApiOperation({
     operationId: 'createAccountingAccount',
-     Accounts',
+    summary: 'Accounts',
     description: 'Create accounts in any supported Accounting software',
   })
   @ApiHeader({

diff --git a/packages/api/src/ats/eeocs/eeocs.controller.ts b/packages/api/src/ats/eeocs/eeocs.controller.ts
@@ -80,7 +80,7 @@ export class EeocsController {
 
   @ApiOperation({
     operationId: 'retrieveAtsEeocs', // Updated operationId
-    summary: 'Retrieve a Eeocs',
+    summary: 'Retrieve Eeocs',
     description: 'Retrieve a eeocs from any connected Ats software',
   })
   @ApiParam({