feat(server): endpoints swagger docs

packages/server/src/modules/Organization/Organization.controller.ts

@@ -4,6 +4,9 @@ import {
   ApiResponse,
   ApiBody,
   ApiOkResponse,
+  ApiExtraModels,
+  getSchemaPath,
+  ApiParam,
 } from '@nestjs/swagger';
 import {
   Controller,
@@ -29,11 +32,13 @@ import {
   OrganizationBuildResponseExample,
   OrganizationBuiltResponseExample,
 } from './Organization.swagger';
+import { GetCurrentOrganizationResponseDto } from './dtos/GetCurrentOrganizationResponse.dto';
 
 @ApiTags('Organization')
 @Controller('organization')
 @IgnoreTenantInitializedRoute()
 @IgnoreTenantSeededRoute()
+@ApiExtraModels(GetCurrentOrganizationResponseDto)
 export class OrganizationController {
   constructor(
     private readonly buildOrganizationService: BuildOrganizationService,
@@ -68,6 +73,12 @@ export class OrganizationController {
   }
 
   @Get('build/:buildJobId')
+  @ApiParam({
+    name: 'buildJobId',
+    required: true,
+    type: Number,
+    description: 'The build job id',
+  })
   @HttpCode(200)
   @ApiOperation({ summary: 'Gets the organization build job details' })
   async buildJob(@Param('buildJobId') buildJobId: string) {
@@ -80,12 +91,15 @@ export class OrganizationController {
   @ApiResponse({
     status: 200,
     description: 'Returns the current organization',
+    schema: {
+      $ref: getSchemaPath(GetCurrentOrganizationResponseDto),
+    },
   })
   async currentOrganization() {
     const organization =
       await this.getCurrentOrgService.getCurrentOrganization();
 
-    return { organization };
+    return organization;
   }
 
   @Get('base-currency-mutate')

packages/server/src/modules/Organization/dtos/GetCurrentOrganizationResponse.dto.ts

@@ -0,0 +1,151 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+
+export class OrganizationMetadataResponseDto {
+  @ApiProperty({
+    description: 'Internal numeric ID of the metadata',
+    example: 1,
+  })
+  id: number;
+
+  @ApiProperty({
+    description: 'Tenant ID associated with the organization',
+    example: 101,
+  })
+  tenantId: number;
+
+  @ApiProperty({
+    description: 'Name of the organization',
+    example: 'Acme Inc.',
+  })
+  name: string;
+
+  @ApiPropertyOptional({
+    description: 'Industry of the organization',
+    example: 'Technology',
+  })
+  industry: string;
+
+  @ApiProperty({ description: 'Location of the organization', example: 'US' })
+  location: string;
+
+  @ApiProperty({
+    description: 'Base currency in ISO 4217 format',
+    example: 'USD',
+  })
+  baseCurrency: string;
+
+  @ApiProperty({
+    description: 'Language/locale of the organization',
+    example: 'en-US',
+  })
+  language: string;
+
+  @ApiProperty({
+    description: 'Timezone of the organization',
+    example: 'America/New_York',
+  })
+  timezone: string;
+
+  @ApiProperty({
+    description: 'Date format used by the organization',
+    example: 'MM/DD/YYYY',
+  })
+  dateFormat: string;
+
+  @ApiProperty({
+    description: 'Fiscal year of the organization',
+    example: 'January',
+  })
+  fiscalYear: string;
+
+  @ApiPropertyOptional({
+    description: 'Tax identification number',
+    example: '12-3456789',
+    nullable: true,
+  })
+  taxNumber: string;
+
+  @ApiPropertyOptional({
+    description: 'Primary brand color in hex format',
+    example: '#4285F4',
+    nullable: true,
+  })
+  primaryColor: string;
+
+  @ApiPropertyOptional({
+    description: 'Logo file key reference',
+    example: 'organizations/acme-logo-123456.png',
+    nullable: true,
+  })
+  logoKey: string;
+
+  @ApiPropertyOptional({
+    description: 'Organization address details',
+    example: '123 Main St, New York, NY',
+    nullable: true,
+  })
+  address: string;
+}
+
+export class GetCurrentOrganizationResponseDto {
+  @ApiProperty({
+    description: 'Internal numeric ID of the organization',
+    example: 1,
+  })
+  id: number;
+
+  @ApiProperty({
+    description: 'Unique string identifier for the organization',
+    example: 'org_123456',
+  })
+  organizationId: string;
+
+  @ApiProperty({
+    description: 'Date when the organization was initialized',
+    example: '2024-01-01T00:00:00.000Z',
+  })
+  initializedAt: Date;
+
+  @ApiProperty({
+    description: 'Date when the organization was seeded',
+    example: '2024-01-01T01:00:00.000Z',
+  })
+  seededAt: Date;
+
+  @ApiProperty({
+    description: 'Date when the organization was built',
+    example: '2024-01-01T02:00:00.000Z',
+  })
+  builtAt: Date;
+
+  @ApiPropertyOptional({
+    description: 'Database batch identifier, if any',
+    example: 'batch_001',
+    nullable: true,
+  })
+  databaseBatch: null | string;
+
+  @ApiProperty({
+    description: 'Organization metadata',
+    type: () => [OrganizationMetadataResponseDto],
+  })
+  metadata: OrganizationMetadataResponseDto;
+
+  @ApiProperty({
+    description: 'Whether the organization is ready',
+    example: true,
+  })
+  isReady: boolean;
+
+  @ApiProperty({
+    description: 'Whether a build process is currently running',
+    example: false,
+  })
+  isBuildRunning: boolean;
+
+  @ApiProperty({
+    description: 'Whether an upgrade process is currently running',
+    example: false,
+  })
+  isUpgradeRunning: boolean;
+}