💚 Added a correct swagger for sdk publishing

packages/api/src/@core/@core-services/webhooks/panora-webhooks/webhook.controller.ts

@@ -125,7 +125,7 @@ export class WebhookController {
   }
 
   @ApiOperation({
-    operationId: 'createWebhookMetadata',
+    operationId: 'createWebhook',
     summary: 'Add webhook metadata',
   })
   @ApiBody({ type: WebhookDto })
@@ -138,7 +138,7 @@ export class WebhookController {
   }
 
   @ApiOperation({
-    operationId: 'createWebhookMetadata',
+    operationId: 'createWebhook',
     summary: 'Add webhook metadata',
   })
   @ApiBody({ type: WebhookDto })

packages/api/src/@core/field-mapping/field-mapping.controller.ts

@@ -14,10 +14,16 @@ import {
   DefineTargetFieldDto,
   MapFieldToProviderDto,
 } from './dto/create-custom-field.dto';
-import { ApiResponse, ApiTags, ApiBody, ApiOperation } from '@nestjs/swagger';
+import {
+  ApiResponse,
+  ApiTags,
+  ApiBody,
+  ApiOperation,
+  ApiExcludeEndpoint,
+} from '@nestjs/swagger';
 import { JwtAuthGuard } from '@@core/auth/guards/jwt-auth.guard';
 
-@ApiTags('field-mappings')
+@ApiTags('fieldMappings')
 @Controller('field-mappings')
 export class FieldMappingController {
   constructor(
@@ -33,6 +39,7 @@ export class FieldMappingController {
   })
   @ApiResponse({ status: 200 })
   @UseGuards(JwtAuthGuard)
+  @ApiExcludeEndpoint()
   @Get('entities')
   getEntities() {
     return this.fieldMappingService.getEntities();
@@ -43,6 +50,7 @@ export class FieldMappingController {
     summary: 'Retrieve field mappings',
   })
   @ApiResponse({ status: 200 })
+  @ApiExcludeEndpoint()
   @Get('attribute')
   @UseGuards(JwtAuthGuard)
   getAttributes(@Request() req: any) {
@@ -55,14 +63,15 @@ export class FieldMappingController {
     summary: 'Retrieve field mappings values',
   })
   @ApiResponse({ status: 200 })
+  @ApiExcludeEndpoint()
   @Get('value')
   @UseGuards(JwtAuthGuard)
   getValues() {
     return this.fieldMappingService.getValues();
   }
 
   @ApiOperation({
-    operationId: 'defineTargetField',
+    operationId: 'define',
     summary: 'Define target Field',
   })
   @ApiBody({ type: DefineTargetFieldDto })
@@ -82,7 +91,7 @@ export class FieldMappingController {
   }
 
   @ApiOperation({
-    operationId: 'createCustomField',
+    operationId: 'create',
     summary: 'Create Custom Field',
   })
   @ApiBody({ type: CustomFieldCreateDto })
@@ -94,7 +103,7 @@ export class FieldMappingController {
     return this.fieldMappingService.createCustomField(data, id_project);
   }
 
-  @ApiOperation({ operationId: 'mapField', summary: 'Map Custom Field' })
+  @ApiOperation({ operationId: 'map', summary: 'Map Custom Field' })
   @ApiBody({ type: MapFieldToProviderDto })
   @ApiResponse({ status: 201 })
   @UseGuards(JwtAuthGuard)
@@ -108,6 +117,7 @@ export class FieldMappingController {
     summary: 'Retrieve Custom Properties',
   })
   @ApiResponse({ status: 200 })
+  @ApiExcludeEndpoint()
   @UseGuards(JwtAuthGuard)
   @Get('properties')
   getCustomProperties(

packages/api/src/@core/linked-users/linked-users.controller.ts

@@ -22,7 +22,7 @@ import {
 } from '@nestjs/swagger';
 import { JwtAuthGuard } from '@@core/auth/guards/jwt-auth.guard';
 
-@ApiTags('linked-users')
+@ApiTags('linkedUsers')
 @Controller('linked-users')
 export class LinkedUsersController {
   constructor(
@@ -32,7 +32,7 @@ export class LinkedUsersController {
     this.logger.setContext(LinkedUsersController.name);
   }
 
-  @ApiOperation({ operationId: 'addLinkedUser', summary: 'Add Linked User' })
+  @ApiOperation({ operationId: 'createLinkedUser', summary: 'Add Linked User' })
   @ApiBody({ type: CreateLinkedUserDto })
   @ApiResponse({ status: 201 })
   @UseGuards(JwtAuthGuard)
@@ -42,7 +42,7 @@ export class LinkedUsersController {
   }
 
   @ApiOperation({
-    operationId: 'addBatchLinkedUsers',
+    operationId: 'importBatch',
     summary: 'Add Batch Linked Users',
   })
   @ApiBody({ type: CreateBatchLinkedUserDto })
@@ -54,7 +54,7 @@ export class LinkedUsersController {
   }
 
   @ApiOperation({
-    operationId: 'fetchLinkedUsers',
+    operationId: 'listLinkedUsers',
     summary: 'Retrieve Linked Users',
   })
   @ApiResponse({ status: 200 })
@@ -66,7 +66,7 @@ export class LinkedUsersController {
   }
 
   @ApiOperation({
-    operationId: 'getLinkedUser',
+    operationId: 'retrieveLinkedUser',
     summary: 'Retrieve a Linked User',
   })
   @ApiQuery({ name: 'id', required: true, type: String })
@@ -79,7 +79,7 @@ export class LinkedUsersController {
   }
 
   @ApiOperation({
-    operationId: 'linkedUserFromRemoteId',
+    operationId: 'remoteId',
     summary: 'Retrieve a Linked User From A Remote Id',
   })
   @ApiQuery({ name: 'remoteId', required: true, type: String })

packages/api/src/@core/passthrough/passthrough.controller.ts

@@ -22,7 +22,7 @@ export class PassthroughController {
   }
 
   @ApiOperation({
-    operationId: 'passthroughRequest',
+    operationId: 'request',
     summary: 'Make a passthrough request',
   })
   @ApiQuery({ name: 'integrationId', required: true, type: String })

packages/api/src/ats/activity/activity.controller.ts

@@ -4,7 +4,6 @@ import {
   Body,
   Query,
   Get,
-  Patch,
   Param,
   Headers,
   UseGuards,

packages/api/src/main.ts

@@ -14,6 +14,31 @@ import { useContainer } from 'class-validator';
 import * as cors from 'cors';
 import * as yaml from 'js-yaml';
 
+function addSpeakeasyGroup(document: any) {
+  for (const path in document.paths) {
+    const pathParts = path.split('/').filter((part) => part);
+    let groupName;
+
+    if (pathParts[0] === 'webhook') {
+      groupName = 'webhook';
+    } else if (pathParts[0] === 'sync') {
+      groupName = 'sync';
+    } else if (pathParts[0] === 'linked-users') {
+      groupName = 'linkedUsers';
+    } else if (pathParts[0] === 'field-mappings') {
+      groupName = 'fieldMappings';
+    } else if (pathParts.length >= 2) {
+      groupName = `${pathParts[0].toLowerCase()}.${pathParts[1].toLowerCase()}`;
+    }
+
+    if (groupName) {
+      for (const method in document.paths[path]) {
+        document.paths[path][method]['x-speakeasy-group'] = groupName;
+      }
+    }
+  }
+}
+
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
   const config = new DocumentBuilder()
@@ -28,7 +53,17 @@ async function bootstrap() {
     })
     .build();
   const document = SwaggerModule.createDocument(app, config);
-
+  // Dynamically add extended specs
+  const extendedSpecs = {
+    'x-speakeasy-name-override': [
+      { operationId: '^retrieve.*', methodNameOverride: 'retrieve' },
+      { operationId: '^list.*', methodNameOverride: 'list' },
+      { operationId: '^create.*', methodNameOverride: 'create' },
+    ],
+  };
+  document['x-speakeasy-name-override'] =
+    extendedSpecs['x-speakeasy-name-override']; // Add extended specs
+  addSpeakeasyGroup(document);
   useContainer(app.select(AppModule), { fallbackOnErrors: true });
 
   SwaggerModule.setup('docs', app, document);

packages/api/swagger/overlay.yaml

@@ -0,0 +1,19 @@
+overlay: 1.0.0
+info:
+  title: Add x-speakeasy-name-override to endpoints
+  version: 0.0.1
+actions:
+  - target: "$.paths[*][get,post,put,delete]"
+    description: Add x-speakeasy-name-override to all endpoint methods
+    update:
+      x-speakeasy-name-override:
+        $eval: |
+          if (current.operationId.startsWith('list')) {
+            return 'list';
+          } else if (current.operationId.startsWith('retrieve')) {
+            return 'retrieve';
+          } else if (current.operationId.startsWith('create')) {
+            return 'create';
+          } else {
+            return current.operationId;
+          }