@travetto/openapi 2.2.2 → 2.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -97,7 +97,7 @@ The framework, when in watch mode, will generate the [OpenAPI](https://github.co
97
97
 
98
98
  ## CLI - openapi:spec
99
99
 
100
- The module provides a plugin 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.
100
+ 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.
101
101
 
102
102
  **Terminal: OpenAPI usage**
103
103
  ```bash
@@ -116,7 +116,7 @@ The command will run your application, in non-server mode, to collect all the ro
116
116
 
117
117
  ## CLI - openapi:client
118
118
 
119
- The module provides a plugin 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.
119
+ 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.
120
120
 
121
121
  **Terminal: OpenAPI usage**
122
122
  ```bash
@@ -2,7 +2,7 @@ import * as path from 'path';
2
2
  import * as fs from 'fs/promises';
3
3
  import { readFileSync } from 'fs';
4
4
 
5
- import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
5
+ import { CliCommand, OptionConfig, ListOptionConfig } from '@travetto/cli/src/command';
6
6
  import { AppCache, ExecUtil, PathUtil } from '@travetto/boot';
7
7
  import { color } from '@travetto/cli/src/color';
8
8
 
@@ -10,7 +10,7 @@ const presets: Record<string, [string, object] | [string]> = JSON.parse(readFile
10
10
 
11
11
  type Options = {
12
12
  extendedHelp: OptionConfig<boolean>;
13
- props: OptionConfig<string[]>;
13
+ props: ListOptionConfig<string>;
14
14
  input: OptionConfig<string>;
15
15
  output: OptionConfig<string>;
16
16
  dockerImage: OptionConfig<string>;
@@ -19,7 +19,7 @@ type Options = {
19
19
  /**
20
20
  * CLI for generating the cli client
21
21
  */
22
- export class OpenApiClientPlugin extends BasePlugin<Options> {
22
+ export class OpenApiClientCommand extends CliCommand<Options> {
23
23
  name = 'openapi:client';
24
24
 
25
25
  presetMap(prop?: object): string {
@@ -1,4 +1,4 @@
1
- import { BasePlugin, OptionConfig } from '@travetto/cli/src/plugin-base';
1
+ import { CliCommand, OptionConfig } from '@travetto/cli/src/command';
2
2
  import { ExecUtil } from '@travetto/boot';
3
3
  import { EnvInit } from '@travetto/base/bin/init';
4
4
 
@@ -9,7 +9,7 @@ type Options = {
9
9
  /**
10
10
  * CLI for outputting the open api spec to a local file
11
11
  */
12
- export class OpenApiSpecPlugin extends BasePlugin<Options> {
12
+ export class OpenApiSpecCommand extends CliCommand<Options> {
13
13
  name = 'openapi:spec';
14
14
 
15
15
  getOptions(): Options {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@travetto/openapi",
3
3
  "displayName": "OpenAPI Specification",
4
- "version": "2.2.2",
4
+ "version": "2.2.3",
5
5
  "description": "OpenAPI integration support for the travetto framework",
6
6
  "keywords": [
7
7
  "rest",
@@ -28,14 +28,14 @@
28
28
  "directory": "module/openapi"
29
29
  },
30
30
  "dependencies": {
31
- "@travetto/config": "^2.2.2",
32
- "@travetto/rest": "^2.2.2",
33
- "@travetto/schema": "^2.2.2",
34
- "@travetto/yaml": "^2.2.2",
31
+ "@travetto/config": "^2.2.3",
32
+ "@travetto/rest": "^2.2.3",
33
+ "@travetto/schema": "^2.2.3",
34
+ "@travetto/yaml": "^2.2.3",
35
35
  "openapi3-ts": "^2.0.2"
36
36
  },
37
37
  "optionalPeerDependencies": {
38
- "@travetto/cli": "^2.2.2"
38
+ "@travetto/cli": "^2.2.3"
39
39
  },
40
40
  "publishConfig": {
41
41
  "access": "public"