fix: organization apis are accessible through api key #4619
Conversation
NV-3033 make organization-related apis public
Organisations APIs are excluded from swagger and can't be accessed using API key |
NV-1920 remove @ApiExcludeController from organisation controller
Remove ApiExcludeController from organisation controller so that organisation apis are shown in api documentation. Tasks:-
|
|
|
||
| @IsString() | ||
| @IsOptional() | ||
| logo?: string; |
There was a problem hiding this comment.
Do we need to add here @ApiPropertyOptional()?
| @@ -81,6 +93,11 @@ export class OrganizationController { | |||
| } | |||
|
|
|||
| @Get('/me') | |||
| @ExternalApiAccessible() | |||
| @ApiResponse(OrganizationResponseDto) | |||
There was a problem hiding this comment.
Should we add?
| @ApiResponse(OrganizationResponseDto) | |
| @ApiResponse(OrganizationResponseDto, 200) |
| @ApiOperation({ | ||
| summary: 'Update a member role to admin', | ||
| }) | ||
| @ApiParam({ name: 'memberId', type: String, required: true }) | ||
| async updateMemberRoles( |
There was a problem hiding this comment.
Do we need to add here?
@ApiResponse(MemberDto, 200)
| @ExternalApiAccessible() | ||
| @ApiOperation({ | ||
| summary: 'Fetch all members of current organizations', | ||
| }) | ||
| async getMember(@UserSession() user: IJwtPayload) { |
There was a problem hiding this comment.
Do we need to add here?
@ApiResponse(MemberDto, 200, true)
| @@ -130,19 +161,12 @@ export class OrganizationController { | |||
| ); | |||
| } | |||
|
|
|||
| @Post('/members/invite') | |||
There was a problem hiding this comment.
not sure what this endpoint was responsible of but i guess we don't need @post('/members/invite') that returns members. 👏
| @Put('/branding') | ||
| @ExternalApiAccessible() | ||
| @ApiResponse(OrganizationBrandingResponseDto) |
There was a problem hiding this comment.
Should be with 200?
| @ApiResponse(OrganizationBrandingResponseDto) | |
| @ApiResponse(OrganizationBrandingResponseDto, 200) |
| @Roles(MemberRoleEnum.ADMIN) | ||
| @ApiResponse(RenameOrganizationDto) |
There was a problem hiding this comment.
Should be with 200?
| @ApiResponse(RenameOrganizationDto) | |
| @ApiResponse(RenameOrganizationDto, 200) |
There was a problem hiding this comment.
@ApiResponse() has 200 as default status code
There was a problem hiding this comment.
I see, good to know :)
packages/node/README.md
Outdated
|
@djabarovgeorge Please look into this PR again 🙂 |
There was a problem hiding this comment.
Yeah looks good to me, left a couple of comments related to class-validator and nestjs/swagger decorators.
To be honest, I don't even know if we need class-validator decorators in the DTO because we don't validate them, it could be a good idea to add validation IMO but from what i know we still don't.
| invitationDate: Date; | ||
|
|
||
| @ApiProperty() | ||
| @IsDate() |
There was a problem hiding this comment.
| @IsDate() | |
| @IsDate() | |
| @ApiPropertyOptional() |
| answerDate?: Date; | ||
|
|
||
| @ApiProperty() | ||
| @IsDate() |
There was a problem hiding this comment.
| @IsDate() | |
| @IsString() |
| enum: MemberRoleEnum, | ||
| isArray: true, | ||
| }) | ||
| @IsArray() |
There was a problem hiding this comment.
| @IsArray() | |
| @IsEnum(MemberRoleEnum) |
| @ApiPropertyOptional({ | ||
| enum: { ...MemberStatusEnum }, | ||
| }) | ||
| @IsString() |
There was a problem hiding this comment.
| @IsString() | |
| @IsEnum(MemberStatusEnum) |
| import { UpdateBrandingDetailsDto } from './update-branding-details.dto'; | ||
|
|
||
| export class IPartnerConfigurationResponseDto { | ||
| @ApiPropertyOptional() |
There was a problem hiding this comment.
| @ApiPropertyOptional() | |
| @ApiPropertyOptional() | |
| @IsArray() | |
| @IsString({ each: true }) |
| @ApiProperty() | ||
| accessToken: string; | ||
|
|
||
| @ApiProperty() | ||
| configurationId: string; | ||
|
|
||
| @ApiPropertyOptional() | ||
| teamId: string; |
| enum: { ...PartnerTypeEnum }, | ||
| description: 'Partner Type Enum', | ||
| }) | ||
| @IsString() |
There was a problem hiding this comment.
| @IsString() | |
| @IsEnum(PartnerTypeEnum) |
| @IsObject() | ||
| branding: OrganizationBrandingResponseDto; | ||
|
|
||
| @ApiPropertyOptional() |
There was a problem hiding this comment.
| @ApiPropertyOptional() | |
| @ApiPropertyOptional() | |
| @IsObject() |
What change does this PR introduce?
@ApiExcludeController()and add@ExternalApiAccessible()decoratorOrganizationResponseDtoFixes NV-1920
Why was this change needed?
So that organizations' APIs can be accessed using API Key
Other information (Screenshots)