mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-20 06:40:31 +00:00
feat: swagger document endpoints
This commit is contained in:
@@ -1,16 +1,25 @@
|
||||
import { ApiTags, ApiOperation, ApiResponse } from '@nestjs/swagger';
|
||||
import {
|
||||
ApiTags,
|
||||
ApiOperation,
|
||||
ApiResponse,
|
||||
getSchemaPath,
|
||||
ApiExtraModels,
|
||||
} from '@nestjs/swagger';
|
||||
import { Controller, Get } from '@nestjs/common';
|
||||
import { DashboardService } from './Dashboard.service';
|
||||
import { GetDashboardBootMetaResponseDto } from './dtos/GetDashboardBootMetaResponse.dto';
|
||||
|
||||
@ApiTags('Dashboard')
|
||||
@Controller('dashboard')
|
||||
@ApiExtraModels(GetDashboardBootMetaResponseDto)
|
||||
export class DashboardController {
|
||||
constructor(private readonly dashboardService: DashboardService) {}
|
||||
|
||||
@ApiOperation({ summary: 'Get dashboard boot metadata' })
|
||||
@ApiResponse({
|
||||
status: 200,
|
||||
description: 'Returns dashboard boot metadata including abilities, features, and cloud status',
|
||||
description: 'The dashboard details have been successfully retrieved.',
|
||||
schema: { $ref: getSchemaPath(GetDashboardBootMetaResponseDto) },
|
||||
})
|
||||
@Get('boot')
|
||||
getBootMeta() {
|
||||
|
||||
Reference in New Issue
Block a user