Merge pull request #91 from shanghaikid/docs

update some docs for swagger

server/nest-cli.json

@@ -1,4 +1,7 @@
 {
   "collection": "@nestjs/schematics",
-  "sourceRoot": "src"
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "plugins": ["@nestjs/swagger"]
+  }
 }

server/src/collections/collections.controller.ts

@@ -9,9 +9,11 @@ import {
   UsePipes,
   ValidationPipe,
 } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 import { CollectionsService } from './collections.service';
 import { CreateCollection } from './dto';
 
+@ApiTags('collections')
 @Controller('collections')
 export class CollectionsController {
   constructor(private collectionsService: CollectionsService) {}

server/src/collections/dto.ts

@@ -7,22 +7,32 @@ import {
   ArrayNotEmpty,
 } from 'class-validator';
 import { FieldType } from '@zilliz/milvus-sdk-node-dev/dist/milvus/types/Collection'; // todo: need improve like export types in root file.
+import { DataType } from '@zilliz/milvus-sdk-node-dev/dist/milvus/types/Common';
 import { ApiProperty } from '@nestjs/swagger';
 
+
 export class CreateCollection {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection name'
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
   })
   readonly collection_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Generate ID automatically by milvus',
+    type: Boolean,
+  })
   @IsBoolean()
   @IsOptional()
   readonly autoID: boolean;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Field data type',
+    enum: DataType
+  })
   @IsArray()
   @ArrayNotEmpty()
   @IsNotEmpty({

server/src/main.ts

@@ -8,7 +8,7 @@ async function bootstrap() {
   });
 
   const config = new DocumentBuilder()
-    .setTitle('Milvus admin')
+    .setTitle('Milvus insight')
     .setVersion('1.0')
     .build();
   const document = SwaggerModule.createDocument(app, config);

server/src/milvus/dto.ts

@@ -2,7 +2,9 @@ import { ApiProperty } from '@nestjs/swagger';
 import { IsNotEmpty, IsString } from 'class-validator';
 
 export class ConnectMilvus {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus url'
+  })
   @IsString()
   @IsNotEmpty({
     message: 'address is empty',
@@ -11,7 +13,9 @@ export class ConnectMilvus {
 }
 
 export class CheckMilvus {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus url'
+  })
   @IsString()
   @IsNotEmpty({
     message: 'address is empty',

server/src/milvus/milvus.controller.ts

@@ -1,7 +1,10 @@
 import { Body, Controller, Get, Post, Query, UsePipes } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 import { ValidationPipe } from 'src/pipe/validation.pipe';
 import { CheckMilvus, ConnectMilvus } from './dto';
 import { MilvusService } from './milvus.service';
+
+@ApiTags('milvus')
 @Controller('milvus')
 export class MilvusController {
   constructor(private milvusService: MilvusService) {}

server/src/partitions/dto.ts

@@ -12,7 +12,9 @@ export enum ManageType {
   CREATE = 'create',
 }
 export class GetPartitionsInfo {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
@@ -21,34 +23,45 @@ export class GetPartitionsInfo {
 }
 
 export class ManagePartition {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
   })
   readonly collection_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus partition name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'partition_name is empty',
   })
   readonly partition_name: string;
 
-  @ApiProperty({ enum: ManageType })
+  @ApiProperty({ 
+    description: 'Type allow delete and create',
+    enum: ManageType
+  })
   @IsEnum(ManageType, { message: 'Type allow delete and create' })
   readonly type: ManageType;
 }
 
 export class LoadPartitions {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
   })
   readonly collection_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus partition name',
+  })
   @IsArray()
   @ArrayNotEmpty()
   @IsNotEmpty({

server/src/partitions/partitions.controller.ts

@@ -8,6 +8,7 @@ import {
   UsePipes,
   ValidationPipe,
 } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 import {
   GetPartitionsInfo,
   LoadPartitions,
@@ -16,6 +17,7 @@ import {
 } from './dto';
 import { PartitionsService } from './partitions.service';
 
+@ApiTags('partitions')
 @Controller('partitions')
 export class PartitionsController {
   constructor(private partitionsService: PartitionsService) {}

server/src/schema/dto.ts

@@ -24,14 +24,18 @@ export class ManageIndex {
   @IsEnum(ManageType, { message: 'Type allow delete and create' })
   readonly type: ManageType;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
   })
   readonly collection_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'field name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'field_name is empty',
@@ -47,49 +51,63 @@ export class ManageIndex {
 }
 
 export class DescribeIndex {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection description',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
   })
   readonly collection_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'field name',
+  })
   @IsString()
   @IsOptional()
   readonly field_name?: string;
 }
 
 export class GetIndexState {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
   })
   readonly collection_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'field name',
+  })
   @IsString()
   @IsOptional()
   readonly field_name?: string;
 }
 
 export class GetIndexProgress {
-  @ApiProperty()
+  @ApiProperty({
+    description: 'Milvus collection name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'collection_name is empty',
   })
   readonly collection_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'index name',
+  })
   @IsString()
   @IsNotEmpty({
     message: 'index_name is empty',
   })
   readonly index_name: string;
 
-  @ApiProperty()
+  @ApiProperty({
+    description: 'field name',
+  })
   @IsString()
   @IsOptional()
   readonly field_name?: string;

server/src/schema/schema.controller.ts

@@ -7,6 +7,7 @@ import {
   UsePipes,
   ValidationPipe,
 } from '@nestjs/common';
+import { ApiTags } from '@nestjs/swagger';
 import {
   DescribeIndex,
   GetIndexProgress,
@@ -16,6 +17,7 @@ import {
 } from './dto';
 import { SchemaService } from './schema.service';
 
+@ApiTags('schema')
 @Controller('schema')
 export class SchemaController {
   constructor(private schemaService: SchemaService) {}