mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-17 05:10:31 +00:00
refaqctor: document openapi endpoints
This commit is contained in:
@@ -9,14 +9,17 @@ import {
|
||||
} from '@nestjs/common';
|
||||
import { ExcludeBankTransactionsApplication } from './ExcludeBankTransactionsApplication';
|
||||
import { ExcludedBankTransactionsQuery } from './types/BankTransactionsExclude.types';
|
||||
import { ApiOperation, ApiTags } from '@nestjs/swagger';
|
||||
|
||||
@Controller('banking/transactions')
|
||||
@ApiTags('banking-transactions')
|
||||
export class BankingTransactionsExcludeController {
|
||||
constructor(
|
||||
private readonly excludeBankTransactionsApplication: ExcludeBankTransactionsApplication,
|
||||
) {}
|
||||
|
||||
@Get()
|
||||
@ApiOperation({ summary: 'Retrieves the excluded bank transactions.' })
|
||||
public getExcludedBankTransactions(
|
||||
@Query() query: ExcludedBankTransactionsQuery,
|
||||
) {
|
||||
@@ -26,6 +29,7 @@ export class BankingTransactionsExcludeController {
|
||||
}
|
||||
|
||||
@Post(':id/exclude')
|
||||
@ApiOperation({ summary: 'Exclude the given bank transaction.' })
|
||||
public excludeBankTransaction(@Param('id') id: string) {
|
||||
return this.excludeBankTransactionsApplication.excludeBankTransaction(
|
||||
Number(id),
|
||||
@@ -33,6 +37,7 @@ export class BankingTransactionsExcludeController {
|
||||
}
|
||||
|
||||
@Delete(':id/exclude')
|
||||
@ApiOperation({ summary: 'Unexclude the given bank transaction.' })
|
||||
public unexcludeBankTransaction(@Param('id') id: string) {
|
||||
return this.excludeBankTransactionsApplication.unexcludeBankTransaction(
|
||||
Number(id),
|
||||
@@ -40,11 +45,13 @@ export class BankingTransactionsExcludeController {
|
||||
}
|
||||
|
||||
@Post('bulk/exclude')
|
||||
@ApiOperation({ summary: 'Exclude the given bank transactions.' })
|
||||
public excludeBankTransactions(@Body('ids') ids: number[]) {
|
||||
return this.excludeBankTransactionsApplication.excludeBankTransactions(ids);
|
||||
}
|
||||
|
||||
@Delete('bulk/exclude')
|
||||
@ApiOperation({ summary: 'Unexclude the given bank transactions.' })
|
||||
public unexcludeBankTransactions(@Body('ids') ids: number[]) {
|
||||
return this.excludeBankTransactionsApplication.unexcludeBankTransactions(
|
||||
ids,
|
||||
|
||||
Reference in New Issue
Block a user