return API info

src/app.module.ts

@@ -3,6 +3,7 @@ import { RouterModule } from 'nest-router';
 import { routes } from './routes';
 import { ConfigModule } from './shared/config/config.module';
 import { LoggerModule } from './shared/logger/logger.module';
+import { InfoModule } from './info/info.module';
 import { BookmarkModule } from './bookmarks/bookmark.module';
 import { PermissionModule } from './permissions/permission.module';
 import { AssetModule } from './assets/asset.module';
@@ -16,6 +17,7 @@ import { AuthModule } from './auth/auth.module';
     AssetModule,
     LoggerModule,
     ConfigModule,
+    InfoModule,
     BookmarkModule,
     UserProfileModule,
     AuthModule,

src/info/dto/get-info.dto.ts

@@ -0,0 +1,27 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsString, IsUrl } from 'class-validator';
+
+export class GetInfoDto {
+  @ApiProperty({
+    example: '7.17',
+    description: 'Elasticsearch version',
+  })
+  @IsString()
+  elasticsearchVersion: string;
+
+  @ApiProperty({
+    example: '1.0.4',
+    description: 'Matching API Version',
+  })
+  @IsString()
+  APIversion: string;
+
+  @ApiProperty({
+    example: '1.0.4',
+    description: 'Matching API Version',
+  })
+  @IsUrl({
+    require_tld: false,
+  })
+  docs: string;
+}

src/info/info.controller.ts

@@ -0,0 +1,42 @@
+import { Get, Req, Controller } from '@nestjs/common';
+import { ApiOperation, ApiResponse, ApiTags } from '@nestjs/swagger';
+import { readFileSync } from 'fs';
+import path from 'path';
+import { ElasticService } from '../shared/elasticsearch/elastic.service';
+import { Public } from '../common/decorators/auth.decorator';
+import { Request } from '../common/helpers/request.interface';
+import { GetInfoDto } from './dto/get-info.dto';
+
+@ApiTags('Info')
+@Controller()
+export class InfoController {
+  constructor(private readonly elasticService: ElasticService) {}
+
+  @Get()
+  @ApiOperation({
+    description: 'Get API info',
+    summary: 'Public',
+  })
+  @ApiResponse({
+    status: 200,
+    description: 'Return API Info',
+  })
+  @Public()
+  async getInfo(@Req() req: Request<unknown>): Promise<GetInfoDto> {
+    const pathEndpoint = `${req.protocol}://${req.hostname}${req.client.localPort ? `:${req.client.localPort}` : ''}${
+      req.url
+    }`;
+    const packageJsonPath = path.join(__dirname, '../..', 'package.json');
+    const packageJsonString = readFileSync(packageJsonPath, 'utf8');
+    const packageJson = JSON.parse(packageJsonString) as { version: string };
+
+    const elsInfo = await this.elasticService.getInfo();
+
+    return {
+      APIversion: packageJson.version,
+      // prettier-ignore
+      elasticsearchVersion: (elsInfo.body as { version: { "number": string } }).version.number,
+      docs: `${pathEndpoint}api/v1/docs`,
+    };
+  }
+}

src/info/info.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { ElasticModule } from '../shared/elasticsearch/elastic.module';
+import { InfoController } from './info.controller';
+
+@Module({
+  imports: [ElasticModule],
+  providers: [],
+  controllers: [InfoController],
+  exports: [],
+})
+export class InfoModule {}

src/routes.ts

@@ -4,11 +4,13 @@ import { BookmarkModule } from './bookmarks/bookmark.module';
 import { AssetModule } from './assets/asset.module';
 import { UserProfileModule } from './user-profiles/user-profile.module';
 import { PermissionModule } from './permissions/permission.module';
+import { InfoModule } from './info/info.module';
 
 export const routes: Routes = [
   { path: '/api/v1/ugc/bookmarks', module: BookmarkModule },
   { path: '/api/v1/metadata/assets', module: AssetModule },
   { path: '/api/v1/metadata/profiles', module: UserProfileModule },
   { path: '/api/v1/auth', module: AuthModule },
   { path: '/api/v1/permissions', module: PermissionModule },
+  { path: '/', module: InfoModule },
 ];

src/shared/elasticsearch/elastic.service.ts

@@ -88,4 +88,8 @@ export class ElasticService {
       index,
     });
   }
+
+  async getInfo() {
+    return this.elasticsearchService.info();
+  }
 }