feat: add header swagger docs

This commit is contained in:
Ahmed Bouhuolia
2025-07-02 17:42:17 +02:00
parent b2d61160dd
commit 456a9e1ad9
65 changed files with 172 additions and 48 deletions

View File

@@ -8,7 +8,13 @@ import {
Request,
UseGuards,
} from '@nestjs/common';
import { ApiTags, ApiOperation, ApiBody, ApiParam } from '@nestjs/swagger';
import {
ApiTags,
ApiOperation,
ApiBody,
ApiParam,
ApiExcludeController,
} from '@nestjs/swagger';
import { PublicRoute } from './guards/jwt.guard';
import { AuthenticationApplication } from './AuthApplication.sevice';
import { AuthSignupDto } from './dtos/AuthSignup.dto';
@@ -20,6 +26,7 @@ import { SystemUser } from '../System/models/SystemUser';
@Controller('/auth')
@ApiTags('Auth')
@ApiExcludeController()
@PublicRoute()
export class AuthController {
constructor(

View File

@@ -1,8 +1,12 @@
import { Controller, Post, Param, Get, Put } from '@nestjs/common';
import { GenerateApiKey } from './commands/GenerateApiKey.service';
import { GetApiKeysService } from './queries/GetApiKeys.service';
import { ApiExcludeController, ApiTags } from '@nestjs/swagger';
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
@Controller('api-keys')
@ApiTags('Api keys')
@ApiCommonHeaders()
export class AuthApiKeysController {
constructor(
private readonly getApiKeysService: GetApiKeysService,

View File

@@ -1,4 +1,9 @@
import { ApiBody, ApiOperation, ApiTags } from '@nestjs/swagger';
import {
ApiBody,
ApiExcludeController,
ApiOperation,
ApiTags,
} from '@nestjs/swagger';
import { GetAuthenticatedAccount } from './queries/GetAuthedAccount.service';
import { Controller, Get, Post } from '@nestjs/common';
import { IgnoreTenantSeededRoute } from '../Tenancy/EnsureTenantIsSeeded.guards';
@@ -9,6 +14,7 @@ import { IgnoreUserVerifiedRoute } from './guards/EnsureUserVerified.guard';
@Controller('/auth')
@ApiTags('Auth')
@ApiExcludeController()
@IgnoreTenantSeededRoute()
@IgnoreTenantInitializedRoute()
@IgnoreUserVerifiedRoute()