mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-16 04:40:32 +00:00
feat: add header swagger docs
This commit is contained in:
@@ -10,9 +10,11 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { APAgingSummaryQueryDto } from './APAgingSummaryQuery.dto';
|
||||
import { APAgingSummaryResponseExample } from './APAgingSummary.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('reports/payable-aging-summary')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class APAgingSummaryController {
|
||||
constructor(private readonly APAgingSummaryApp: APAgingSummaryApplication) {}
|
||||
|
||||
|
||||
@@ -11,9 +11,11 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { ARAgingSummaryQueryDto } from './ARAgingSummaryQuery.dto';
|
||||
import { ARAgingSummaryResponseExample } from './ARAgingSummary.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('reports/receivable-aging-summary')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class ARAgingSummaryController {
|
||||
constructor(private readonly ARAgingSummaryApp: ARAgingSummaryApplication) {}
|
||||
|
||||
|
||||
@@ -10,9 +10,11 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { BalanceSheetQueryDto } from './BalanceSheet.dto';
|
||||
import { BalanceSheetResponseExample } from './BalanceSheet.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/balance-sheet')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class BalanceSheetStatementController {
|
||||
constructor(private readonly balanceSheetApp: BalanceSheetApplication) {}
|
||||
|
||||
|
||||
@@ -10,9 +10,11 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { CashFlowStatementQueryDto } from './CashFlowStatementQuery.dto';
|
||||
import { CashflowStatementResponseExample } from './CashflowStatement.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('reports/cashflow-statement')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class CashflowController {
|
||||
constructor(private readonly cashflowSheetApp: CashflowSheetApplication) {}
|
||||
|
||||
|
||||
@@ -9,9 +9,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
|
||||
import { CustomerBalanceSummaryApplication } from './CustomerBalanceSummaryApplication';
|
||||
import { CustomerBalanceSummaryQueryDto } from './CustomerBalanceSummaryQuery.dto';
|
||||
import { AcceptType } from '@/constants/accept-type';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/customer-balance-summary')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class CustomerBalanceSummaryController {
|
||||
constructor(
|
||||
private readonly customerBalanceSummaryApp: CustomerBalanceSummaryApplication,
|
||||
|
||||
@@ -10,9 +10,11 @@ import { GeneralLedgerApplication } from './GeneralLedgerApplication';
|
||||
import { AcceptType } from '@/constants/accept-type';
|
||||
import { GeneralLedgerQueryDto } from './GeneralLedgerQuery.dto';
|
||||
import { GeneralLedgerResponseExample } from './GeneralLedger.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/general-ledger')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class GeneralLedgerController {
|
||||
constructor(
|
||||
private readonly generalLedgerApplication: GeneralLedgerApplication,
|
||||
|
||||
@@ -4,9 +4,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
|
||||
import { InventoryItemDetailsApplication } from './InventoryItemDetailsApplication';
|
||||
import { AcceptType } from '@/constants/accept-type';
|
||||
import { InventoryItemDetailsQueryDto } from './InventoryItemDetailsQuery.dto';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('reports/inventory-item-details')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class InventoryItemDetailsController {
|
||||
constructor(
|
||||
private readonly inventoryItemDetailsApp: InventoryItemDetailsApplication,
|
||||
|
||||
@@ -9,9 +9,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
|
||||
import { InventoryValuationSheetApplication } from './InventoryValuationSheetApplication';
|
||||
import { InventoryValuationQueryDto } from './InventoryValuationQuery.dto';
|
||||
import { AcceptType } from '@/constants/accept-type';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('reports/inventory-valuation')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class InventoryValuationController {
|
||||
constructor(
|
||||
private readonly inventoryValuationApp: InventoryValuationSheetApplication,
|
||||
|
||||
@@ -10,9 +10,11 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { JournalSheetQueryDto } from './JournalSheetQuery.dto';
|
||||
import { JournalSheetResponseExample } from './JournalSheet.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/journal')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class JournalSheetController {
|
||||
constructor(private readonly journalSheetApp: JournalSheetApplication) {}
|
||||
|
||||
|
||||
@@ -10,9 +10,11 @@ import {
|
||||
} from '@nestjs/swagger';
|
||||
import { ProfitLossSheetQueryDto } from './ProfitLossSheetQuery.dto';
|
||||
import { ProfitLossSheetResponseExample } from './ProfitLossSheet.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/profit-loss-sheet')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class ProfitLossSheetController {
|
||||
constructor(
|
||||
private readonly profitLossSheetApp: ProfitLossSheetApplication,
|
||||
|
||||
@@ -4,9 +4,11 @@ import { PurchasesByItemsApplication } from './PurchasesByItemsApplication';
|
||||
import { AcceptType } from '@/constants/accept-type';
|
||||
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
|
||||
import { PurchasesByItemsQueryDto } from './PurchasesByItemsQuery.dto';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/purchases-by-items')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class PurchasesByItemReportController {
|
||||
constructor(
|
||||
private readonly purchasesByItemsApp: PurchasesByItemsApplication,
|
||||
|
||||
@@ -12,9 +12,11 @@ import { SalesByItemsApplication } from './SalesByItemsApplication';
|
||||
import { Response } from 'express';
|
||||
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
|
||||
import { SalesByItemsQueryDto } from './SalesByItemsQuery.dto';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/sales-by-items')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class SalesByItemsController {
|
||||
constructor(private readonly salesByItemsApp: SalesByItemsApplication) {}
|
||||
|
||||
|
||||
@@ -9,9 +9,11 @@ import { Controller, Get, Headers, Query, Res } from '@nestjs/common';
|
||||
import { AcceptType } from '@/constants/accept-type';
|
||||
import { SalesTaxLiabilitySummaryApplication } from './SalesTaxLiabilitySummaryApplication';
|
||||
import { SalesTaxLiabilitySummaryQueryDto } from './dtos/SalesTaxLiabilityQuery.dto';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/sales-tax-liability-summary')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class SalesTaxLiabilitySummaryController {
|
||||
constructor(
|
||||
private readonly salesTaxLiabilitySummaryApp: SalesTaxLiabilitySummaryApplication,
|
||||
|
||||
@@ -5,9 +5,11 @@ import { TransactionsByCustomerApplication } from './TransactionsByCustomersAppl
|
||||
import { AcceptType } from '@/constants/accept-type';
|
||||
import { Response } from 'express';
|
||||
import { TransactionsByCustomerQueryDto } from './TransactionsByCustomerQuery.dto';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/transactions-by-customers')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class TransactionsByCustomerController {
|
||||
constructor(
|
||||
private readonly transactionsByCustomersApp: TransactionsByCustomerApplication,
|
||||
|
||||
@@ -5,9 +5,11 @@ import { Response } from 'express';
|
||||
import { TransactionsByVendorApplication } from './TransactionsByVendorApplication';
|
||||
import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
|
||||
import { TransactionsByVendorQueryDto } from './TransactionsByVendorQuery.dto';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/transactions-by-vendors')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class TransactionsByVendorController {
|
||||
constructor(
|
||||
private readonly transactionsByVendorsApp: TransactionsByVendorApplication,
|
||||
|
||||
@@ -11,9 +11,11 @@ import { AcceptType } from '@/constants/accept-type';
|
||||
import { TrialBalanceSheetApplication } from './TrialBalanceSheetApplication';
|
||||
import { TrialBalanceSheetQueryDto } from './TrialBalanceSheetQuery.dto';
|
||||
import { TrialBalanceSheetResponseExample } from './TrialBalanceSheet.swagger';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('reports/trial-balance-sheet')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class TrialBalanceSheetController {
|
||||
constructor(
|
||||
private readonly trialBalanceSheetApp: TrialBalanceSheetApplication,
|
||||
|
||||
@@ -10,9 +10,11 @@ import {
|
||||
ApiTags,
|
||||
} from '@nestjs/swagger';
|
||||
import { VendorBalanceSummaryQueryDto } from './VendorBalanceSummaryQuery.dto';
|
||||
import { ApiCommonHeaders } from '@/common/decorators/ApiCommonHeaders';
|
||||
|
||||
@Controller('/reports/vendor-balance-summary')
|
||||
@ApiTags('Reports')
|
||||
@ApiCommonHeaders()
|
||||
export class VendorBalanceSummaryController {
|
||||
constructor(
|
||||
private readonly vendorBalanceSummaryApp: VendorBalanceSummaryApplication,
|
||||
|
||||
Reference in New Issue
Block a user