@travetto/openapi 3.0.2 → 3.0.3

package/README.md

@@ -1,6 +1,7 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
-<!-- Please modify https://github.com/travetto/travetto/tree/main/module/openapi/DOC.ts and execute "npx trv doc" to rebuild -->
+<!-- Please modify https://github.com/travetto/travetto/tree/main/module/openapi/DOC.tsx and execute "npx trv doc" to rebuild -->
 # OpenAPI Specification
+
 ## OpenAPI integration support for the Travetto framework
 
 **Install: @travetto/openapi**
@@ -12,7 +13,7 @@ npm install @travetto/openapi
 yarn add @travetto/openapi
 ```
 
-In the [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") module, the controllers and endpoints can be described via decorators, comments, or typings. This only provides the general metadata internally. This is not sufficient to generate a usable API doc, and so this module exists to bridge that gap.
+In the [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") module, the controllers and endpoints can be described via decorators, comments, or typings. This only provides the general metadata internally. This is not sufficient to generate a usable API doc, and so this module exists to bridge that gap. 
 
 The module is provides an [OpenAPI](https://github.com/OAI/OpenAPI-Specification) v3.x representation of the API metadata provided via the [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") and [Schema](https://github.com/travetto/travetto/tree/main/module/schema#readme "Data type registry for runtime validation, reflection and binding.") modules.
 
@@ -70,7 +71,7 @@ export class ApiHostConfig {
   /**
    * OpenAPI Version
    */
-  openapi = '3.0.1';
+  openapi = '3.1.0';
 }
 
 /**
@@ -98,14 +99,14 @@ export class ApiSpecConfig {
   exposeAllSchemas: boolean = false;
 
   async postConstruct(): Promise<void> {
-    this.output = path.toPosix(this.output);
+    this.output = path.resolve(this.output);
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {
       this.persist ??= GlobalEnv.dynamic;
     }
     if (this.persist) {
-      if (!/[.](json|ya?ml)$/.test(this.output)) { // Assume a folder
+      if (!/[.](json|ya?ml) $/.test(this.output)) { // Assume a folder
         this.output = path.resolve(this.output, 'openapi.yml');
       }
     }
@@ -114,10 +115,9 @@ export class ApiSpecConfig {
 ```
 
 ## Spec Generation
-The framework, when in watch mode, will generate the [OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification in either [JSON](https://www.json.org) or [YAML](https://en.wikipedia.org/wiki/YAML). This module integrates with the file watching paradigm and can regenerate the openapi spec as changes to endpoints and models are made during development.  The output format is defined by the suffix of the output file, `.yaml` or `.json`.  
+The framework, when in watch mode, will generate the [OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification in either [JSON](https://www.json.org) or [YAML](https://en.wikipedia.org/wiki/YAML). This module integrates with the file watching paradigm and can regenerate the openapi spec as changes to endpoints and models are made during development.  The output format is defined by the suffix of the output file, `.yaml` or `.json`.
 
 ## CLI - openapi:spec
-
 The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") to allow scripting file generation.
 
 **Terminal: OpenAPI usage**
@@ -136,7 +136,6 @@ The command will run your application, in non-server mode, to collect all the ro
 **Note**: The module supports generating the OpenAPI spec in real-time while listening for changes to routes and models.
 
 ## CLI - openapi:client
-
 The module provides a command for the [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") to allow client generation from the API structure.
 
 **Terminal: OpenAPI usage**

package/package.json

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

package/src/config.ts

@@ -46,7 +46,7 @@ export class ApiHostConfig {
   /**
    * OpenAPI Version
    */
-  openapi = '3.0.1';
+  openapi = '3.1.0';
 }
 
 /**
@@ -74,7 +74,7 @@ export class ApiSpecConfig {
   exposeAllSchemas: boolean = false;
 
   async postConstruct(): Promise<void> {
-    this.output = path.toPosix(this.output);
+    this.output = path.resolve(this.output);
     if (!this.output || this.output === '-') {
       this.persist = false;
     } else {

package/support/cli.openapi_spec.ts

@@ -25,7 +25,7 @@ export class OpenApiSpecCommand extends CliCommand<Options> {
 
   async action(): Promise<void> {
     const result = await ExecUtil.worker(
-      RootIndex.resolveFileImport('@travetto/cli/support/cli.ts'),
+      RootIndex.resolveFileImport('@travetto/cli/support/entry.cli.ts'),
       ['main', '@travetto/openapi/support/bin/generate.ts'],
       { env: { TRV_OPENAPI_OUTPUT: this.cmd.output, TRV_OPENAPI_PERSIST: '1' } }
     ).message;