@travetto/openapi 3.1.3 → 3.1.5

package/README.md

@@ -69,7 +69,7 @@ export class ApiHostConfig {
   /**
    * OpenAPI Version
    */
-  openapi = '3.1.0';
+  openapi = '3.0.0';
 }
 
 /**
@@ -95,10 +95,10 @@ export class ApiSpecConfig {
   exposeAllSchemas: boolean = false;
 
   async postConstruct(): Promise<void> {
-    this.output = path.resolve(this.output);
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {
+      this.output = path.resolve(RootIndex.mainModule.sourcePath, this.output);
       this.persist ??= GlobalEnv.dynamic;
     }
     if (this.persist) {
@@ -152,10 +152,9 @@ Options:
 
 Available Presets
 ----------------------------------
-* @travetto/angular10 -- typescript-angular supportsES6=true,ngVersion=10.0
-* @travetto/angular11 -- typescript-angular supportsES6=true,ngVersion=11.0
-* @travetto/angular12 -- typescript-angular supportsES6=true,ngVersion=11.0
-* @travetto/fetch -- typescript-fetch
+* @travetto/angular14 -- typescript-angular supportsES6=true,stringEnums=true,ngVersion=14.0,fileNaming=kebab-case
+* @travetto/angular15 -- typescript-angular supportsES6=true,stringEnums=true,ngVersion=15.0,fileNaming=kebab-case
+* @travetto/fetch -- typescript-fetch stringEnums=true
 ```
 
 This tool relies upon a custom build of [OpenAPI client generation tools](https://github.com/OpenAPITools/openapi-generator), which supports watching.  This allows for fast responsive client generation as the shape of the API changes.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/openapi",
-  "version": "3.1.3",
+  "version": "3.1.5",
   "description": "OpenAPI integration support for the Travetto framework",
   "keywords": [
     "rest",
@@ -26,14 +26,14 @@
     "directory": "module/openapi"
   },
   "dependencies": {
-    "@travetto/config": "^3.1.1",
-    "@travetto/rest": "^3.1.1",
-    "@travetto/schema": "^3.1.1",
+    "@travetto/config": "^3.1.2",
+    "@travetto/rest": "^3.1.3",
+    "@travetto/schema": "^3.1.2",
     "@travetto/yaml": "^3.1.1",
     "openapi3-ts": "^3.1.2"
   },
   "peerDependencies": {
-    "@travetto/cli": "^3.1.1"
+    "@travetto/cli": "^3.1.2"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

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

@@ -5,12 +5,12 @@ import type {
 } from 'openapi3-ts';
 
 import { ControllerRegistry, EndpointConfig, ControllerConfig, ParamConfig, EndpointIOType } from '@travetto/rest';
+import { RootIndex } from '@travetto/manifest';
 import { Class } from '@travetto/base';
 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';
 
@@ -224,9 +224,21 @@ export class SpecGenerator {
           properties[fieldName] = this.#processSchemaField(def.schema[fieldName], required);
         }
 
+        const extra: Record<string, unknown> = {};
+        if (RootIndex.getFunctionMetadata(type)?.abstract) {
+          const map = SchemaRegistry.getSubTypesForClass(type);
+          if (map) {
+            extra.oneOf = [...new Set(map.values())].map(c => {
+              this.#processSchema(c);
+              return this.#getType(c);
+            });
+          }
+        }
+
         Object.assign(this.#allSchemas[typeId], {
           properties,
-          ...(required.length ? { required } : {})
+          ...(required.length ? { required } : {}),
+          ...extra
         });
       } else {
         this.#allSchemas[typeId] = { title: typeId };
@@ -341,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);
         }
@@ -378,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);
         }
       }
     }