Merge pull request #597 from panoratech/fix-routes-rest-compliance

feat: REST Compliance
panoratech · Aug 1, 2024 · fd94b72 · fd94b72
2 parents f4fcb5d + 11e9e99
commit fd94b72
Show file tree

Hide file tree

Showing 28 changed files with 75 additions and 80 deletions.
diff --git a/apps/webapp/src/hooks/create/useCreateApiKey.tsx b/apps/webapp/src/hooks/create/useCreateApiKey.tsx
@@ -11,7 +11,7 @@ export interface IApiKeyDto {
 // Adjusted useCreateApiKey hook to include a promise-returning function
 const useCreateApiKey = () => {
     const addApiKey = async (data: IApiKeyDto) => {
-        const response = await fetch(`${config.API_URL}/auth/generate-apikey`, {
+        const response = await fetch(`${config.API_URL}/auth/api_keys`, {
             method: 'POST',
             body: JSON.stringify(data),
             headers: {

diff --git a/apps/webapp/src/hooks/create/useCreateLinkedUser.tsx b/apps/webapp/src/hooks/create/useCreateLinkedUser.tsx
@@ -9,7 +9,7 @@ interface ILinkedUserDto {
 }
 const useCreateLinkedUser = () => {    
     const add = async (linkedUserData: ILinkedUserDto) => {
-        const response = await fetch(`${config.API_URL}/linked-users/internal`, {
+        const response = await fetch(`${config.API_URL}/linked_users/internal`, {
             method: 'POST',
             body: JSON.stringify(linkedUserData),
             headers: {

diff --git a/apps/webapp/src/hooks/create/useCreateMagicLink.tsx b/apps/webapp/src/hooks/create/useCreateMagicLink.tsx
@@ -11,7 +11,7 @@ interface ILinkDto {
 
 const useCreateMagicLink = () => {
     const add = async (data: ILinkDto) => {
-        const response = await fetch(`${config.API_URL}/magic-links`, {
+        const response = await fetch(`${config.API_URL}/magic_links`, {
             method: 'POST',
             body: JSON.stringify(data),
             headers: {

diff --git a/apps/webapp/src/hooks/create/useRefreshAccessToken.tsx b/apps/webapp/src/hooks/create/useRefreshAccessToken.tsx
@@ -8,7 +8,7 @@ interface IRefreshOutputDto {
 
 const useRefreshAccessToken = () => {
     const refreshAccessToken = async (projectId: string) => {
-        const response = await fetch(`${config.API_URL}/auth/refresh-token`, {
+        const response = await fetch(`${config.API_URL}/auth/refresh_tokens`, {
             method: 'POST',
             body: JSON.stringify({
                 projectId: projectId

diff --git a/apps/webapp/src/hooks/get/useApiKeys.tsx b/apps/webapp/src/hooks/get/useApiKeys.tsx
@@ -7,7 +7,7 @@ const useApiKeys = () => {
   return useQuery({
     queryKey: ['api-keys'], 
     queryFn: async (): Promise<ApiKey[]> => {
-      const response = await fetch(`${config.API_URL}/auth/api-keys`,
+      const response = await fetch(`${config.API_URL}/auth/api_keys`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useFieldMappings.tsx b/apps/webapp/src/hooks/get/useFieldMappings.tsx
@@ -7,7 +7,7 @@ const useFieldMappings = () => {
   return useQuery({
     queryKey: ['mappings'], 
     queryFn: async (): Promise<Attribute[]> => {
-      const response = await fetch(`${config.API_URL}/field-mappings/attribute`,
+      const response = await fetch(`${config.API_URL}/field_mappings/attributes`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useLinkedUsers.tsx b/apps/webapp/src/hooks/get/useLinkedUsers.tsx
@@ -7,7 +7,7 @@ const useLinkedUsers = () => {
   return useQuery({
     queryKey: ['linked-users'], 
     queryFn: async (): Promise<LinkedUser[]> => {
-      const response = await fetch(`${config.API_URL}/linked-users/internal`,
+      const response = await fetch(`${config.API_URL}/linked_users/internal`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useProviderProperties.tsx b/apps/webapp/src/hooks/get/useProviderProperties.tsx
@@ -6,7 +6,7 @@ const useProviderProperties = (linkedUserId: string, providerId: string, vertica
   return useQuery({
     queryKey: ['providerProperties', linkedUserId, providerId, vertical], 
     queryFn: async () => {
-      const response = await fetch(`${config.API_URL}/field-mappings/properties?linkedUserId=${linkedUserId}&providerId=${providerId}&vertical=${vertical}`,
+      const response = await fetch(`${config.API_URL}/field_mappings/properties?linkedUserId=${linkedUserId}&providerId=${providerId}&vertical=${vertical}`,
       {
         method: 'GET',
         headers: {

diff --git a/apps/webapp/src/hooks/get/useWebhooks.tsx b/apps/webapp/src/hooks/get/useWebhooks.tsx
@@ -8,7 +8,7 @@ const useWebhooks = () => {
     queryKey: ['webhooks'], 
     queryFn: async (): Promise<Webhook[]> => {
       console.log("Webhook mutation called")
-      const response = await fetch(`${config.API_URL}/webhook/internal`,
+      const response = await fetch(`${config.API_URL}/webhooks/internal`,
       {
         method: 'GET',
         headers: {

diff --git a/docs/api-reference/auth/create-api-key.mdx b/docs/api-reference/auth/create-api-key.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /auth/generate-apikey
+openapi: post /auth/api_keys
 ---
diff --git a/docs/api-reference/auth/retrieve-api-keys.mdx b/docs/api-reference/auth/retrieve-api-keys.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /auth/api-keys
+openapi: get /auth/api_keys
 ---
diff --git a/docs/api-reference/field-mapping/define-target-field.mdx b/docs/api-reference/field-mapping/define-target-field.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /field-mapping/define
+openapi: post /field_mappings/definitions
 ---
diff --git a/docs/api-reference/field-mapping/map-custom-field.mdx b/docs/api-reference/field-mapping/map-custom-field.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /field-mapping/map
+openapi: post /field_mappings/mappings
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-custom-properties.mdx b/docs/api-reference/field-mapping/retrieve-custom-properties.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/properties
+openapi: get /field_mappings/properties
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-field-mapping-entities.mdx b/docs/api-reference/field-mapping/retrieve-field-mapping-entities.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/entities
+openapi: get /field_mappings/entities
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-field-mappings-values.mdx b/docs/api-reference/field-mapping/retrieve-field-mappings-values.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/value
+openapi: get /field_mappings/values
 ---
diff --git a/docs/api-reference/field-mapping/retrieve-field-mappings.mdx b/docs/api-reference/field-mapping/retrieve-field-mappings.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /field-mapping/attribute
+openapi: get /field_mappings/attributes
 ---
diff --git a/docs/api-reference/magic-link/retrieve-magic-links.mdx b/docs/api-reference/magic-link/retrieve-magic-links.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: get /magic-link
+openapi: get /magic_links
 ---
diff --git a/docs/api-reference/projects/create-a-project.mdx b/docs/api-reference/projects/create-a-project.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: post /projects/create
+openapi: post /projects
 ---
diff --git a/docs/core-concepts/custom-fields.mdx b/docs/core-concepts/custom-fields.mdx
@@ -56,7 +56,7 @@ The following example creates a custom field mapping in two steps (**define and
 
 ```shell Create custom field
 curl --request POST \
-         --url https://api.panora.dev/field-mappings \
+         --url https://api.panora.dev/field_mappings \
          --header 'Authorization: Bearer <MY_API_KEY>' \
          --header 'Content-Type: application/json' \
          --data '{
@@ -76,7 +76,7 @@ The following example creates a custom field mapping in two steps (**define and
         <CodeGroup>
         ```shell Define custom field
         curl --request POST \
-             --url https://api.panora.dev/field-mappings/define \
+             --url https://api.panora.dev/field_mappings/definitions \
              --header 'Authorization: Bearer <MY_API_KEY>' \
              --header 'Content-Type: application/json' \
              --data '{
@@ -89,7 +89,7 @@ The following example creates a custom field mapping in two steps (**define and
 
         ```shell Map custom field
         curl --request POST \
-             --url https://api.panora.dev/field-mappings/map \
+             --url https://api.panora.dev/field_mappings/mappings \
              --header 'Authorization: Bearer <MY_API_KEY>' \
              --header 'Content-Type: application/json' \
              --data '{

diff --git a/packages/api/src/@core/@core-services/webhooks/panora-webhooks/webhook.controller.ts b/packages/api/src/@core/@core-services/webhooks/panora-webhooks/webhook.controller.ts
@@ -29,8 +29,8 @@ import {
   WebhookResponse,
 } from './dto/webhook.dto';
 import { WebhookService } from './webhook.service';
-@ApiTags('webhook')
-@Controller('webhook')
+@ApiTags('webhooks')
+@Controller('webhooks')
 export class WebhookController {
   constructor(
     private webhookService: WebhookService,
@@ -41,7 +41,7 @@ export class WebhookController {
 
   @ApiOperation({
     operationId: 'listWebhooks',
-    summary: 'List webhooks ',
+    summary: 'List webhooks',
   })
   @ApiGetArrayCustomResponse(WebhookResponse)
   @UseGuards(ApiKeyAuthGuard)

diff --git a/packages/api/src/@core/auth/auth.controller.ts b/packages/api/src/@core/auth/auth.controller.ts
@@ -47,7 +47,7 @@ export class AuthController {
 
   @ApiOperation({ operationId: 'requestPasswordReset', summary: 'Request Password Reset' })
   @ApiBody({ type: RequestPasswordResetDto })
-  @Post('request-password-reset')
+  @Post('password_reset_request')
   async requestPasswordReset(@Body() requestPasswordResetDto: RequestPasswordResetDto) {
     return this.authService.requestPasswordReset(requestPasswordResetDto);
   }
@@ -71,7 +71,7 @@ export class AuthController {
   @ApiOperation({ operationId: 'resetPassword', summary: 'Reset Password' })
   @ApiBody({ type: ResetPasswordDto })
   @ApiResponse({ status: 200, description: 'Password reset successfully' })
-  @Post('reset-password')
+  @Post('reset_password')
   async resetPassword(@Body() resetPasswordDto: ResetPasswordDto) {
     return this.authService.resetPassword(resetPasswordDto);
   }
@@ -86,15 +86,15 @@ export class AuthController {
   @ApiOperation({ operationId: 'getApiKeys', summary: 'Retrieve API Keys' })
   @ApiResponse({ status: 200 })
   @UseGuards(JwtAuthGuard)
-  @Get('api-keys')
+  @Get('api_keys')
   async getApiKeys(@Request() req: any) {
     const { id_project } = req.user;
     return this.authService.getApiKeys(id_project);
   }
 
   @ApiOperation({ operationId: 'deleteApiKey', summary: 'Delete API Keys' })
   @ApiResponse({ status: 201 })
-  @Delete('api-keys/:id')
+  @Delete('api_keys/:id')
   @UseGuards(JwtAuthGuard)
   async deleteApiKey(@Param('id') apiKeyId: string) {
     return await this.authService.deleteApiKey(apiKeyId);
@@ -104,7 +104,7 @@ export class AuthController {
   @ApiBody({ type: ApiKeyDto })
   @ApiResponse({ status: 201 })
   @UseGuards(JwtAuthGuard)
-  @Post('generate-apikey')
+  @Post()
   async generateApiKey(@Body() data: ApiKeyDto): Promise<{ api_key: string }> {
     return this.authService.generateApiKeyForUser(
       data.userId,
@@ -120,7 +120,7 @@ export class AuthController {
   @ApiBody({ type: RefreshDto })
   @ApiResponse({ status: 201 })
   @UseGuards(JwtAuthGuard)
-  @Post('refresh-token')
+  @Post('refresh_token')
   refreshAccessToken(@Request() req: any, @Body() body: RefreshDto) {
     const { projectId } = body;
     const { id_user, email, first_name, last_name } = req.user;

diff --git a/packages/api/src/@core/connections-strategies/connections-strategies.controller.ts b/packages/api/src/@core/connections-strategies/connections-strategies.controller.ts
@@ -23,9 +23,9 @@ import { UpdateCSDto } from './dto/update-cs.dto';
 import { ConnectionStrategyCredentials } from './dto/get-connection-cs-credentials.dto';
 import { JwtAuthGuard } from '@@core/auth/guards/jwt-auth.guard';
 
-@ApiTags('connections-strategies')
+@ApiTags('connection_strategies')
 @ApiExcludeController()
-@Controller('connections-strategies')
+@Controller('connection_strategies')
 export class ConnectionsStrategiesController {
   constructor(
     private logger: LoggerService,

diff --git a/packages/api/src/@core/field-mapping/field-mapping.controller.ts b/packages/api/src/@core/field-mapping/field-mapping.controller.ts
@@ -24,7 +24,7 @@ import {
 import { JwtAuthGuard } from '@@core/auth/guards/jwt-auth.guard';
 
 @ApiTags('fieldMappings')
-@Controller('field-mappings')
+@Controller('field_mappings')
 export class FieldMappingController {
   constructor(
     private readonly fieldMappingService: FieldMappingService,
@@ -51,7 +51,7 @@ export class FieldMappingController {
   })
   @ApiResponse({ status: 200 })
   @ApiExcludeEndpoint()
-  @Get('attribute')
+  @Get('attributes')
   @UseGuards(JwtAuthGuard)
   getAttributes(@Request() req: any) {
     const { id_project } = req.user;
@@ -64,14 +64,14 @@ export class FieldMappingController {
   })
   @ApiResponse({ status: 200 })
   @ApiExcludeEndpoint()
-  @Get('value')
+  @Get('values')
   @UseGuards(JwtAuthGuard)
   getValues() {
     return this.fieldMappingService.getValues();
   }
 
   @ApiOperation({
-    operationId: 'define',
+    operationId: 'definitions',
     summary: 'Define target Field',
   })
   @ApiBody({ type: DefineTargetFieldDto })
@@ -91,7 +91,7 @@ export class FieldMappingController {
   }
 
   @ApiOperation({
-    operationId: 'create',
+    operationId: 'createCustomField',
     summary: 'Create Custom Field',
   })
   @ApiBody({ type: CustomFieldCreateDto })

diff --git a/packages/api/src/@core/linked-users/linked-users.controller.ts b/packages/api/src/@core/linked-users/linked-users.controller.ts
@@ -25,7 +25,7 @@ import { JwtAuthGuard } from '@@core/auth/guards/jwt-auth.guard';
 import { ApiKeyAuthGuard } from '@@core/auth/guards/api-key.guard';
 
 @ApiTags('linkedUsers')
-@Controller('linked-users')
+@Controller('linked_users')
 export class LinkedUsersController {
   constructor(
     private readonly linkedUsersService: LinkedUsersService,
@@ -34,7 +34,7 @@ export class LinkedUsersController {
     this.logger.setContext(LinkedUsersController.name);
   }
 
-  @ApiOperation({ operationId: 'createLinkedUser', summary: 'Add Linked User' })
+  @ApiOperation({ operationId: 'createLinkedUser', summary: 'Create Linked Users' })
   @ApiBody({ type: CreateLinkedUserDto })
   @ApiResponse({ status: 201 })
   @UseGuards(ApiKeyAuthGuard)
@@ -68,7 +68,7 @@ export class LinkedUsersController {
 
   @ApiOperation({
     operationId: 'listLinkedUsers',
-    summary: 'Retrieve Linked Users',
+    summary: 'List Linked Users',
   })
   @ApiResponse({ status: 200 })
   @UseGuards(ApiKeyAuthGuard)
@@ -80,7 +80,7 @@ export class LinkedUsersController {
 
   @ApiOperation({
     operationId: 'retrieveLinkedUser',
-    summary: 'Retrieve a Linked User',
+    summary: 'Retrieve Linked Users',
   })
   @ApiQuery({ name: 'id', required: true, type: String })
   @ApiResponse({ status: 200 })

diff --git a/packages/api/src/@core/magic-link/magic-link.controller.ts b/packages/api/src/@core/magic-link/magic-link.controller.ts
@@ -11,9 +11,9 @@ import {
   ApiTags,
 } from '@nestjs/swagger';
 import { JwtAuthGuard } from '@@core/auth/guards/jwt-auth.guard';
-@ApiTags('magic-links')
+@ApiTags('magic_links')
 @ApiExcludeController()
-@Controller('magic-links')
+@Controller('magic_links')
 export class MagicLinkController {
   constructor(
     private readonly magicLinkService: MagicLinkService,
@@ -24,7 +24,7 @@ export class MagicLinkController {
 
   @ApiOperation({
     operationId: 'createMagicLink',
-    summary: 'Create a Magic Link',
+    summary: 'Create Magic Links',
   })
   @ApiBody({ type: CreateMagicLinkDto })
   @ApiResponse({ status: 201 })
@@ -36,7 +36,7 @@ export class MagicLinkController {
 
   @ApiOperation({
     operationId: 'getMagicLinks',
-    summary: 'Retrieve Magic Links',
+    summary: 'List Magic Links',
   })
   @ApiResponse({ status: 200 })
   @Get()
@@ -46,7 +46,7 @@ export class MagicLinkController {
 
   @ApiOperation({
     operationId: 'getMagicLink',
-    summary: 'Retrieve a Magic Link',
+    summary: 'Retrieve Magic Links',
   })
   @ApiQuery({ name: 'id', required: true, type: String })
   @ApiResponse({ status: 200 })

diff --git a/packages/api/src/@core/organisations/organisations.controller.ts b/packages/api/src/@core/organisations/organisations.controller.ts
@@ -27,7 +27,7 @@ export class OrganisationsController {
   })
   @Get()
   getOragnisations() {
-    return; //this.organizationsService.getOrganisations();
+    return; 
   }
 
   @ApiOperation({
@@ -36,8 +36,8 @@ export class OrganisationsController {
   })
   @ApiBody({ type: CreateOrganizationDto })
   @ApiResponse({ status: 201 })
-  @Post('create')
+  @Post()
   createOrg(@Body() orgCreateDto: CreateOrganizationDto) {
-    return; //this.organizationsService.createOrganization(orgCreateDto);
+    return; 
   }
 }