QT/bigcapital
1
0
Fork 0
mirror of https://github.com/bigcapitalhq/bigcapital.git synced 2026-02-18 22:00:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add swagger docs

Browse Source
This commit is contained in:
Ahmed Bouhuolia
2025-06-16 15:53:00 +02:00
parent c4668d7d22
commit e057b4e2f0
22 changed files with 3532 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
packages/server/src/modules/ManualJournals/ManualJournals.controller.ts
View File

@@ -10,20 +10,34 @@ import {
Query,
} from '@nestjs/common';
import { ManualJournalsApplication } from './ManualJournalsApplication.service';
import { ApiOperation, ApiParam, ApiResponse, ApiTags } from '@nestjs/swagger';
import {
ApiExtraModels,
ApiOperation,
ApiParam,
ApiResponse,
ApiTags,
getSchemaPath,
} from '@nestjs/swagger';
import {
CreateManualJournalDto,
EditManualJournalDto,
} from './dtos/ManualJournal.dto';
import { IManualJournalsFilter } from './types/ManualJournals.types';
import { ManualJournalResponseDto } from './dtos/ManualJournalResponse.dto';
@Controller('manual-journals')
@ApiTags('Manual Journals')
@ApiExtraModels(ManualJournalResponseDto)
export class ManualJournalsController {
constructor(private manualJournalsApplication: ManualJournalsApplication) {}
@Post()
@ApiOperation({ summary: 'Create a new manual journal.' })
@ApiResponse({
status: 201,
description: 'The manual journal has been successfully created.',
schema: { $ref: getSchemaPath(ManualJournalResponseDto) },
})
public createManualJournal(@Body() manualJournalDTO: CreateManualJournalDto) {
return this.manualJournalsApplication.createManualJournal(manualJournalDTO);
}
@@ -33,6 +47,7 @@ export class ManualJournalsController {
@ApiResponse({
status: 200,
description: 'The manual journal has been successfully edited.',
schema: { $ref: getSchemaPath(ManualJournalResponseDto) },
})
@ApiResponse({ status: 404, description: 'The manual journal not found.' })
@ApiParam({
@@ -73,6 +88,9 @@ export class ManualJournalsController {
@ApiResponse({
status: 200,
description: 'The manual journal has been successfully published.',
schema: {
$ref: getSchemaPath(ManualJournalResponseDto),
},
})
@ApiResponse({ status: 404, description: 'The manual journal not found.' })
@ApiParam({
@@ -90,6 +108,9 @@ export class ManualJournalsController {
@ApiResponse({
status: 200,
description: 'The manual journal details have been successfully retrieved.',
schema: {
$ref: getSchemaPath(ManualJournalResponseDto),
},
})
@ApiResponse({ status: 404, description: 'The manual journal not found.' })
@ApiParam({
@@ -107,6 +128,12 @@ export class ManualJournalsController {
@ApiResponse({
status: 200,
description: 'The manual journal details have been successfully retrieved.',
schema: {
type: 'array',
items: {
$ref: getSchemaPath(ManualJournalResponseDto),
},
},
})
@ApiResponse({ status: 404, description: 'The manual journal not found.' })
public getManualJournals(@Query() filterDto: Partial<IManualJournalsFilter>) {