Update the api desc (#933)

Author: irfanpena

cortex-js/package.json

@@ -37,6 +37,7 @@
     "build:dev:linux": "chmod +x ./dist/src/command.js"
   },
   "dependencies": {
+    "@cortexso/cortex.js": "^0.1.3",
     "@huggingface/gguf": "^0.1.5",
     "@huggingface/hub": "^0.15.1",
     "@nestjs/axios": "^3.0.2",
@@ -55,7 +56,6 @@
     "class-validator": "^0.14.1",
     "cli-progress": "^3.12.0",
     "cortex-cpp": "0.4.34",
-    "@cortexso/cortex.js": "^0.1.3",
     "cpu-instructions": "^0.0.11",
     "decompress": "^4.2.1",
     "js-yaml": "^4.1.0",

cortex-js/src/app.ts

@@ -57,26 +57,14 @@ export const getApp = async () => {
       'Embeddings',
       'Endpoint for creating and retrieving embedding vectors from text inputs using specified models.',
     )
-    .addTag(
-      'Status',
-      "Endpoint for actively querying the health status of the Cortex's API server.",
-    )
-    .addTag(
-      'Processes',
-      'Endpoint for terminating the Cortex API server processes.',
-    )
-    .addTag(
-      'Events',
-      'Endpoints for observing Cortex statuses through event notifications.',
-    )
-    .addTag(
-      'Configurations',
-      "Endpoints for customizing the Cortex's configurations.",
-    )
     .addTag(
       'Engines',
       'Endpoints for managing the available engines within Cortex.',
     )
+    .addTag(
+      'System',
+      'Endpoints for stopping the Cortex API server, checking its status, and fetching system events.',
+    )
     .addServer('http://localhost:1337')
     .build();
   const document = SwaggerModule.createDocument(app, config);

cortex-js/src/infrastructure/controllers/engines.controller.ts

@@ -92,7 +92,7 @@ export class EnginesController {
     type: CommonResponseDto,
   })
   @ApiOperation({
-    summary: 'Update the engine',
+    summary: 'Update an engine',
     description: 'Updates the engine with configurations.',
   })
   @ApiParam({

cortex-js/src/infrastructure/controllers/models.controller.ts

@@ -120,9 +120,9 @@ export class ModelsController {
     type: CommonResponseDto,
   })
   @ApiOperation({
-    summary: 'Download a remote model',
+    summary: 'Pull a model',
     description:
-      'Pulls a remote model template from cortex hub or huggingface and downloads it.',
+      'Pulls a model from cortex hub or huggingface and downloads it.',
   })
   @ApiParam({
     name: 'modelId',

cortex-js/src/infrastructure/controllers/system.controller.ts

@@ -42,8 +42,8 @@ export class SystemController {
   ) {}
 
   @ApiOperation({
-    summary: 'Terminate api server',
-    description: 'Terminates the Cortex API endpoint server for the detached mode.',
+    summary: 'Stop api server',
+    description: 'Stops the Cortex API endpoint server for the detached mode.',
   })
   @Delete()
   async delete() {