@travetto/openapi 3.1.4 → 3.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/openapi",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "OpenAPI integration support for the Travetto framework",
   "keywords": [
     "rest",
@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@travetto/config": "^3.1.2",
-    "@travetto/rest": "^3.1.2",
+    "@travetto/rest": "^3.1.3",
     "@travetto/schema": "^3.1.2",
     "@travetto/yaml": "^3.1.1",
     "openapi3-ts": "^3.1.2"

package/src/controller.ts

@@ -1,4 +1,4 @@
-import { Controller, Get, SetHeaders } from '@travetto/rest';
+import { Controller, Get, SetHeaders, Undocumented } from '@travetto/rest';
 import { Inject } from '@travetto/di';
 import { YamlUtil } from '@travetto/yaml';
 
@@ -7,6 +7,7 @@ import { OpenApiService } from './service';
 /**
  * Basic controller for surfacing the api spec
  */
+@Undocumented()
 @Controller('/')
 export class OpenApiController {
 

package/src/spec-generate.ts

@@ -11,7 +11,6 @@ import { SchemaRegistry, FieldConfig } from '@travetto/schema';
 import { AllViewⲐ } from '@travetto/schema/src/internal/types';
 
 import { ApiSpecConfig } from './config';
-import { OpenApiController } from './controller';
 
 const DEFINITION = '#/components/schemas';
 
@@ -354,29 +353,20 @@ export class SpecGenerator {
     };
   }
 
-  /**
-   * Process each controller
-   */
-  processController(cls: Class): void {
-    const ctrl = ControllerRegistry.get(cls);
-
-    this.#tags.push({
-      name: this.#getTypeTag(ctrl.class),
-      description: ctrl.description || ctrl.title
-    });
-
-    for (const ep of ctrl.endpoints) {
-      this.processEndpoint(ctrl, ep);
-    }
-  }
-
   /**
    * Generate full specification
    */
   generate(config: Partial<ApiSpecConfig> = {}): GeneratedSpec {
 
     for (const cls of ControllerRegistry.getClasses()) {
-      for (const ep of ControllerRegistry.get(cls).endpoints) {
+      const controller = ControllerRegistry.get(cls);
+      if (controller.documented === false) {
+        continue;
+      }
+      for (const ep of controller.endpoints) {
+        if (ep.documented === false) {
+          continue;
+        }
         if (ep.requestType) {
           this.#processSchema(ep.requestType.type);
         }
@@ -391,8 +381,20 @@ export class SpecGenerator {
 
     if (!config.skipRoutes) {
       for (const cls of ControllerRegistry.getClasses()) {
-        if (cls.Ⲑid !== OpenApiController.Ⲑid) {
-          this.processController(cls);
+        const controller = ControllerRegistry.get(cls);
+        if (controller.documented === false) {
+          continue;
+        }
+        this.#tags.push({
+          name: this.#getTypeTag(controller.class),
+          description: controller.description || controller.title
+        });
+
+        for (const ep of controller.endpoints) {
+          if (ep.documented === false) {
+            continue;
+          }
+          this.processEndpoint(controller, ep);
         }
       }
     }