@rxap/plugin-open-api 20.1.1-dev.9 → 20.2.0-dev.2

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.
Files changed (8) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +9 -9
  3. package/package.json +9 -9
  4. package/src/generators/generate/generator.js +3 -3
  5. package/src/generators/generate/generator.js.map +1 -1
  6. package/src/generators/generate/schema.json +163 -33
  7. package/src/generators/init/schema.json +29 -5
  8. package/src/generators/init-library/schema.json +23 -4
package/CHANGELOG.md CHANGED
@@ -3,6 +3,26 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [20.2.0-dev.2](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.2.0-dev.1...@rxap/plugin-open-api@20.2.0-dev.2) (2026-01-13)
7
+
8
+ **Note:** Version bump only for package @rxap/plugin-open-api
9
+
10
+ # [20.2.0-dev.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.2.0-dev.0...@rxap/plugin-open-api@20.2.0-dev.1) (2026-01-12)
11
+
12
+ ### Bug Fixes
13
+
14
+ - update package groups ([ba8753f](https://gitlab.com/rxap/packages/commit/ba8753f5f34680adc282d84c557fc43385bfa987))
15
+
16
+ # [20.2.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.1.1-dev.10...@rxap/plugin-open-api@20.2.0-dev.0) (2026-01-12)
17
+
18
+ ### Features
19
+
20
+ - **schema:** enhance generator schema documentation with descriptions and examples ([0ae4939](https://gitlab.com/rxap/packages/commit/0ae4939d77e3e313ace4a77d8f5dd86c3c918d29))
21
+
22
+ ## [20.1.1-dev.10](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.1.1-dev.9...@rxap/plugin-open-api@20.1.1-dev.10) (2025-10-07)
23
+
24
+ **Note:** Version bump only for package @rxap/plugin-open-api
25
+
6
26
  ## [20.1.1-dev.9](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.1.1-dev.8...@rxap/plugin-open-api@20.1.1-dev.9) (2025-10-07)
7
27
 
8
28
  **Note:** Version bump only for package @rxap/plugin-open-api
package/README.md CHANGED
@@ -44,10 +44,10 @@ nx g @rxap/plugin-open-api:init-library
44
44
 
45
45
  Option | Type | Default | Description
46
46
  --- | --- | --- | ---
47
- project | string | |
48
- external | boolean | false |
49
- skipFormat | boolean | false |
50
- persistent | boolean | false |
47
+ project | string | | The name of the library project to initialize.
48
+ external | boolean | false | Whether the OpenAPI specification is located outside the workspace.
49
+ skipFormat | boolean | false | Whether to skip formatting generated files.
50
+ persistent | boolean | false | Whether to make the initialization changes persistent.
51
51
 
52
52
  ## init
53
53
  > Initialize the package in the workspace
@@ -58,11 +58,11 @@ nx g @rxap/plugin-open-api:init
58
58
 
59
59
  Option | Type | Default | Description
60
60
  --- | --- | --- | ---
61
- project | string | |
62
- projects | array | |
63
- skipFormat | boolean | false |
64
- overwrite | boolean | false | Whether to overwrite existing files
65
- skipProjects | boolean | false | Whether to skip executing project specific initialization
61
+ project | string | | The name of the project.
62
+ projects | array | | A list of projects to initialize.
63
+ skipFormat | boolean | false | Whether to skip formatting generated files.
64
+ overwrite | boolean | false | Whether to overwrite existing files.
65
+ skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
66
66
  # Executors
67
67
 
68
68
  ## copy-open-api-sdk
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
- "version": "20.1.1-dev.9",
2
+ "version": "20.2.0-dev.2",
3
3
  "name": "@rxap/plugin-open-api",
4
4
  "description": "This plugin provides generators and executors for generating code from OpenAPI specifications within an Nx workspace. It allows you to initialize libraries, generate code for Angular and NestJS, and copy OpenAPI SDKs. The plugin simplifies the process of integrating OpenAPI definitions into your projects.\n",
5
5
  "license": "GPL-3.0-or-later",
6
6
  "dependencies": {
7
7
  "@nx/devkit": "20.5.0",
8
- "@rxap/node-utilities": "^1.3.11-dev.2",
9
- "@rxap/plugin-library": "^20.2.2-dev.3",
10
- "@rxap/plugin-utilities": "^20.0.5-dev.2",
11
- "@rxap/utilities": "^16.5.0-dev.0",
12
- "@rxap/workspace-open-api": "^19.1.1-dev.6",
13
- "@rxap/workspace-ts-morph": "^19.1.13-dev.3",
14
- "@rxap/workspace-utilities": "^19.8.1-dev.2",
8
+ "@rxap/node-utilities": "^1.3.11-dev.3",
9
+ "@rxap/plugin-library": "^20.3.0-dev.2",
10
+ "@rxap/plugin-utilities": "^20.0.5-dev.3",
11
+ "@rxap/utilities": "^16.5.0-dev.1",
12
+ "@rxap/workspace-open-api": "^19.1.1-dev.8",
13
+ "@rxap/workspace-ts-morph": "^19.1.13-dev.4",
14
+ "@rxap/workspace-utilities": "^19.8.1-dev.3",
15
15
  "tslib": "2.6.2",
16
16
  "yaml": "2.3.1"
17
17
  },
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "schematics": "./generators.json",
47
47
  "type": "commonjs",
48
- "gitHead": "d844d2aedf291952ad8c443898234f5ac47ef1a4",
48
+ "gitHead": "69d6ee61a20632f52b77de621089334a34f45e03",
49
49
  "exports": {
50
50
  "./package.json": "./package.json",
51
51
  ".": {
package/src/generators/generate/generator.js CHANGED
@@ -59,15 +59,15 @@ function generateGenerator(tree, options) {
59
59
  if (tree.exists((0, path_1.join)(projectRoot, 'nest', 'src'))) {
60
60
  (0, workspace_utilities_1.DeleteRecursive)(tree, (0, path_1.join)(projectRoot, 'nest', 'src'));
61
61
  }
62
- (0, workspace_ts_morph_1.TsMorphAngularProjectTransform)(tree, {
62
+ yield (0, workspace_ts_morph_1.TsMorphAngularProjectTransform)(tree, {
63
63
  project: options.project,
64
64
  }, project => (0, workspace_open_api_1.GenerateInterfaces)(openapi, project));
65
65
  // generate the angular code
66
- (0, workspace_ts_morph_1.TsMorphAngularProjectTransform)(tree, {
66
+ yield (0, workspace_ts_morph_1.TsMorphAngularProjectTransform)(tree, {
67
67
  project: options.project,
68
68
  }, project => (0, workspace_open_api_1.GenerateOperation)(openapi, project, options, angularGeneratorFunctionList));
69
69
  // generate the nestjs code
70
- (0, workspace_ts_morph_1.TsMorphAngularProjectTransform)(tree, {
70
+ yield (0, workspace_ts_morph_1.TsMorphAngularProjectTransform)(tree, {
71
71
  project: options.project,
72
72
  }, project => (0, workspace_open_api_1.GenerateOperation)(openapi, project, options, nestGeneratorFunctionList));
73
73
  if (options.export) {
package/src/generators/generate/generator.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/open-api/src/generators/generate/generator.ts"],"names":[],"mappings":";;AA6BA,8CAgHC;;AA7ID,uCAGoB;AACpB,yDAAmE;AACnE,+CAA4C;AAC5C,iEAWkC;AAClC,iEAA0E;AAC1E,mEAMmC;AACnC,+BAA4B;AAG5B,SAAsB,iBAAiB,CACrC,IAAU,EACV,OAAgC;;;QAEhC,MAAA,OAAO,CAAC,MAAM,oCAAd,OAAO,CAAC,MAAM,GAAK,IAAI,EAAC;QACxB,MAAA,OAAO,CAAC,UAAU,oCAAlB,OAAO,CAAC,UAAU,GAAK,IAAI,EAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,IAAA,sCAAiB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACvD,0CAA0C;QAC1C,sCAAsC;QAEtC,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAC7B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC;QAC/B,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1F,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,MAAM,GAAG,IAAA,gCAAU,EAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;QAEpC,MAAM,WAAW,GAAG,IAAA,oCAAc,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAEtD,MAAM,4BAA4B,GAAuC,EAAE,CAAC;QAC5E,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,4BAA4B,CAAC,IAAI,CAAC,yCAAoB,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,4BAA4B,CAAC,IAAI,CAAC,yCAAoB,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC5B,4BAA4B,CAAC,IAAI,CAAC,uCAAkB,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC5B,4BAA4B,CAAC,IAAI,CAAC,uCAAkB,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,yBAAyB,GAAuC,EAAE,CAAC;QACzE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YACzB,yBAAyB,CAAC,IAAI,CAAC,6CAAwB,CAAC,CAAC;QAC3D,CAAC;QAED,IAAA,qCAAe,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YACrD,IAAA,qCAAe,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YAClD,IAAA,qCAAe,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1D,CAAC;QAED,IAAA,mDAA8B,EAAC,IAAI,EAAE;YACnC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,EAAE,OAAO,CAAC,EAAE,CAAC,IAAA,uCAAkB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAEpD,4BAA4B;QAC5B,IAAA,mDAA8B,EAAC,IAAI,EAAE;YACnC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,EAAE,OAAO,CAAC,EAAE,CAAC,IAAA,sCAAiB,EAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC;QAE1F,2BAA2B;QAC3B,IAAA,mDAA8B,EAAC,IAAI,EAAE;YACnC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,EAAE,OAAO,CAAC,EAAE,CAAC,IAAA,sCAAiB,EAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC;QAEvF,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,qBAAqB,GAAa;gBACtC,GAAG,WAAW,8BAA8B;gBAC5C,GAAG,WAAW,8BAA8B;gBAC5C,GAAG,WAAW,6BAA6B;gBAC3C,GAAG,WAAW,kCAAkC;aACjD,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC9B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,kCAAkC,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC9B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,kCAAkC,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC5B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,gCAAgC,CAAC,CAAC;YAC7E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC5B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,8BAA8B,CAAC,CAAC;YAC3E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;gBACzB,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,4BAA4B,CAAC,CAAC;YACzE,CAAC;YACD,MAAM,IAAA,4CAA2B,EAAC,IAAI,EAAE;gBACtC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,kBAAkB,EAAE,KAAK;gBACzB,qBAAqB;aACtB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAA,gCAAU,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,IAAA,0CAAoB,EAAC,IAAI,EAAE,WAAW,CAAC,EAAE,UAAU,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QAClG,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IAEH,CAAC;CAAA;AAED,kBAAe,iBAAiB,CAAC"}
1
+ {"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../../packages/plugin/open-api/src/generators/generate/generator.ts"],"names":[],"mappings":";;AA6BA,8CAgHC;;AA7ID,uCAGoB;AACpB,yDAAmE;AACnE,+CAA4C;AAC5C,iEAWkC;AAClC,iEAA0E;AAC1E,mEAMmC;AACnC,+BAA4B;AAG5B,SAAsB,iBAAiB,CACrC,IAAU,EACV,OAAgC;;;QAEhC,MAAA,OAAO,CAAC,MAAM,oCAAd,OAAO,CAAC,MAAM,GAAK,IAAI,EAAC;QACxB,MAAA,OAAO,CAAC,UAAU,oCAAlB,OAAO,CAAC,UAAU,GAAK,IAAI,EAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,MAAM,IAAA,sCAAiB,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACvD,0CAA0C;QAC1C,sCAAsC;QAEtC,IAAI,OAAO,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAC7B,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;YACrB,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC;QAC/B,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1F,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,OAAO,CAAC,MAAM,GAAG,IAAA,gCAAU,EAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC;QAC/D,CAAC;QAED,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC;QAEpC,MAAM,WAAW,GAAG,IAAA,oCAAc,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAEtD,MAAM,4BAA4B,GAAuC,EAAE,CAAC;QAC5E,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,4BAA4B,CAAC,IAAI,CAAC,yCAAoB,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;YAC9B,4BAA4B,CAAC,IAAI,CAAC,yCAAoB,CAAC,CAAC;QAC1D,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC5B,4BAA4B,CAAC,IAAI,CAAC,uCAAkB,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;YAC5B,4BAA4B,CAAC,IAAI,CAAC,uCAAkB,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,yBAAyB,GAAuC,EAAE,CAAC;QACzE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YACzB,yBAAyB,CAAC,IAAI,CAAC,6CAAwB,CAAC,CAAC;QAC3D,CAAC;QAED,IAAA,qCAAe,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACvD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC;YACtD,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;QACpD,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YACrD,IAAA,qCAAe,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,WAAW,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;YAClD,IAAA,qCAAe,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC;QAC1D,CAAC;QAED,MAAM,IAAA,mDAA8B,EAAC,IAAI,EAAE;YACzC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,EAAE,OAAO,CAAC,EAAE,CAAC,IAAA,uCAAkB,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;QAEpD,4BAA4B;QAC5B,MAAM,IAAA,mDAA8B,EAAC,IAAI,EAAE;YACzC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,EAAE,OAAO,CAAC,EAAE,CAAC,IAAA,sCAAiB,EAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,4BAA4B,CAAC,CAAC,CAAC;QAE1F,2BAA2B;QAC3B,MAAM,IAAA,mDAA8B,EAAC,IAAI,EAAE;YACzC,OAAO,EAAE,OAAO,CAAC,OAAO;SACzB,EAAE,OAAO,CAAC,EAAE,CAAC,IAAA,sCAAiB,EAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,yBAAyB,CAAC,CAAC,CAAC;QAEvF,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,MAAM,qBAAqB,GAAa;gBACtC,GAAG,WAAW,8BAA8B;gBAC5C,GAAG,WAAW,8BAA8B;gBAC5C,GAAG,WAAW,6BAA6B;gBAC3C,GAAG,WAAW,kCAAkC;aACjD,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC9B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,kCAAkC,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC9B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,kCAAkC,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC5B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,gCAAgC,CAAC,CAAC;YAC7E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC5B,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,8BAA8B,CAAC,CAAC;YAC3E,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;gBACzB,qBAAqB,CAAC,IAAI,CAAC,GAAG,WAAW,4BAA4B,CAAC,CAAC;YACzE,CAAC;YACD,MAAM,IAAA,4CAA2B,EAAC,IAAI,EAAE;gBACtC,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,kBAAkB,EAAE,KAAK;gBACzB,qBAAqB;aACtB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAA,gCAAU,EAAC,IAAI,EAAE,IAAA,WAAI,EAAC,IAAA,0CAAoB,EAAC,IAAI,EAAE,WAAW,CAAC,EAAE,UAAU,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QAClG,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAC1B,CAAC;IAEH,CAAC;CAAA;AAED,kBAAe,iBAAiB,CAAC"}
package/src/generators/generate/schema.json CHANGED
@@ -9,66 +9,131 @@
9
9
  "properties": {
10
10
  "path": {
11
11
  "type": "string",
12
- "description": "The path to the openapi config",
13
- "format": "path"
12
+ "description": "The local file path to the OpenAPI specification (JSON or YAML).",
13
+ "format": "path",
14
+ "examples": [
15
+ "libs/my-lib/src/api-spec.yaml"
16
+ ]
14
17
  },
15
18
  "skipFormat": {
16
19
  "type": "boolean",
17
- "default": true
20
+ "default": true,
21
+ "description": "Whether to skip formatting generated files.",
22
+ "examples": [
23
+ true,
24
+ false
25
+ ]
18
26
  },
19
27
  "project": {
20
28
  "type": "string",
21
- "description": "The target project where the data sources and remote methods should be generated.",
22
- "default": "open-api"
29
+ "description": "The name of the target project for generation.",
30
+ "default": "open-api",
31
+ "examples": [
32
+ "my-client-lib"
33
+ ]
23
34
  },
24
35
  "directory": {
25
36
  "type": "string",
26
- "description": "A directory where the library is placed."
37
+ "description": "The directory where the generated library will be located.",
38
+ "examples": [
39
+ "clients"
40
+ ]
27
41
  },
28
42
  "prefix": {
29
- "type": "string"
43
+ "type": "string",
44
+ "description": "A prefix to add to all generated classes and components.",
45
+ "examples": [
46
+ "Rxap"
47
+ ]
30
48
  },
31
49
  "transport": {
32
50
  "type": "string",
33
51
  "enum": [
34
52
  "amplify"
53
+ ],
54
+ "description": "The transport layer to use for the generated client.",
55
+ "examples": [
56
+ "amplify"
35
57
  ]
36
58
  },
37
59
  "export": {
38
60
  "type": "boolean",
39
- "description": "If true the index-export generator will be executed after the generation",
40
- "default": true
61
+ "description": "Whether to automatically run the `index-export` generator after generation.",
62
+ "default": true,
63
+ "examples": [
64
+ true,
65
+ false
66
+ ]
41
67
  },
42
68
  "inline": {
43
69
  "type": "boolean",
44
- "default": true
70
+ "default": true,
71
+ "description": "Whether to inline the OpenAPI specification in the generated code.",
72
+ "examples": [
73
+ true,
74
+ false
75
+ ]
45
76
  },
46
77
  "skipRemoteMethod": {
47
78
  "type": "boolean",
48
- "default": false
79
+ "default": false,
80
+ "description": "Whether to skip generation of remote methods.",
81
+ "examples": [
82
+ true,
83
+ false
84
+ ]
49
85
  },
50
86
  "skipDataSource": {
51
87
  "type": "boolean",
52
- "default": true
88
+ "default": true,
89
+ "description": "Whether to skip generation of data sources.",
90
+ "examples": [
91
+ true,
92
+ false
93
+ ]
53
94
  },
54
95
  "skipProvider": {
55
96
  "type": "boolean",
56
- "default": true
97
+ "default": true,
98
+ "description": "Whether to skip generation of providers.",
99
+ "examples": [
100
+ true,
101
+ false
102
+ ]
57
103
  },
58
104
  "skipDirectives": {
59
105
  "type": "boolean",
60
- "default": true
106
+ "default": true,
107
+ "description": "Whether to skip generation of directives.",
108
+ "examples": [
109
+ true,
110
+ false
111
+ ]
61
112
  },
62
113
  "skipCommand": {
63
114
  "type": "boolean",
64
- "default": false
115
+ "default": false,
116
+ "description": "Whether to skip generation of commands.",
117
+ "examples": [
118
+ true,
119
+ false
120
+ ]
65
121
  },
66
122
  "skipHttpResource": {
67
123
  "type": "boolean",
68
- "default": false
124
+ "default": false,
125
+ "description": "Whether to skip generation of HTTP resources.",
126
+ "examples": [
127
+ true,
128
+ false
129
+ ]
69
130
  },
70
131
  "serverId": {
71
- "type": "string"
132
+ "type": "string",
133
+ "description": "The ID of the server to use from the OpenAPI specification.",
134
+ "examples": [
135
+ "production"
136
+ ]
72
137
  }
73
138
  },
74
139
  "required": [
@@ -79,65 +144,130 @@
79
144
  "properties": {
80
145
  "url": {
81
146
  "type": "string",
82
- "description": "The url to the openapi config"
147
+ "description": "The URL to the remote OpenAPI specification (JSON or YAML).",
148
+ "examples": [
149
+ "https://api.example.com/openapi.json"
150
+ ]
83
151
  },
84
152
  "project": {
85
153
  "type": "string",
86
- "description": "The target project where the data sources and remote methods should be generated.",
87
- "default": "open-api"
154
+ "description": "The name of the target project for generation.",
155
+ "default": "open-api",
156
+ "examples": [
157
+ "my-client-lib"
158
+ ]
88
159
  },
89
160
  "skipFormat": {
90
161
  "type": "boolean",
91
- "default": true
162
+ "default": true,
163
+ "description": "Whether to skip formatting generated files.",
164
+ "examples": [
165
+ true,
166
+ false
167
+ ]
92
168
  },
93
169
  "directory": {
94
170
  "type": "string",
95
- "description": "A directory where the library is placed."
171
+ "description": "The directory where the generated library will be located.",
172
+ "examples": [
173
+ "clients"
174
+ ]
96
175
  },
97
176
  "prefix": {
98
- "type": "string"
177
+ "type": "string",
178
+ "description": "A prefix to add to all generated classes and components.",
179
+ "examples": [
180
+ "Rxap"
181
+ ]
99
182
  },
100
183
  "transport": {
101
184
  "type": "string",
102
185
  "enum": [
103
186
  "amplify"
187
+ ],
188
+ "description": "The transport layer to use for the generated client.",
189
+ "examples": [
190
+ "amplify"
104
191
  ]
105
192
  },
106
193
  "export": {
107
194
  "type": "boolean",
108
- "description": "If true the index-export generator will be executed after the generation",
109
- "default": true
195
+ "description": "Whether to automatically run the `index-export` generator after generation.",
196
+ "default": true,
197
+ "examples": [
198
+ true,
199
+ false
200
+ ]
110
201
  },
111
202
  "skipCommand": {
112
203
  "type": "boolean",
113
- "default": false
204
+ "default": false,
205
+ "description": "Whether to skip generation of commands.",
206
+ "examples": [
207
+ true,
208
+ false
209
+ ]
114
210
  },
115
211
  "skipHttpResource": {
116
212
  "type": "boolean",
117
- "default": false
213
+ "default": false,
214
+ "description": "Whether to skip generation of HTTP resources.",
215
+ "examples": [
216
+ true,
217
+ false
218
+ ]
118
219
  },
119
220
  "skipDataSource": {
120
221
  "type": "boolean",
121
- "default": true
222
+ "default": true,
223
+ "description": "Whether to skip generation of data sources.",
224
+ "examples": [
225
+ true,
226
+ false
227
+ ]
122
228
  },
123
229
  "inline": {
124
230
  "type": "boolean",
125
- "default": true
231
+ "default": true,
232
+ "description": "Whether to inline the OpenAPI specification in the generated code.",
233
+ "examples": [
234
+ true,
235
+ false
236
+ ]
126
237
  },
127
238
  "skipRemoteMethod": {
128
239
  "type": "boolean",
129
- "default": false
240
+ "default": false,
241
+ "description": "Whether to skip generation of remote methods.",
242
+ "examples": [
243
+ true,
244
+ false
245
+ ]
130
246
  },
131
247
  "skipProvider": {
132
248
  "type": "boolean",
133
- "default": true
249
+ "default": true,
250
+ "description": "Whether to skip generation of providers.",
251
+ "examples": [
252
+ true,
253
+ false
254
+ ]
134
255
  },
135
256
  "skipDirectives": {
136
257
  "type": "boolean",
137
- "default": true
258
+ "default": true,
259
+ "description": "Whether to skip generation of directives.",
260
+ "examples": [
261
+ true,
262
+ false
263
+ ]
138
264
  },
139
265
  "serverId": {
140
- "type": "string"
266
+ "type": "string",
267
+ "description": "The ID of the server to use from the OpenAPI specification.",
268
+ "examples": [
269
+ "production"
270
+ ]
141
271
  }
142
272
  },
143
273
  "required": [
package/src/generators/init/schema.json CHANGED
@@ -5,27 +5,51 @@
5
5
  "type": "object",
6
6
  "properties": {
7
7
  "project": {
8
- "type": "string"
8
+ "type": "string",
9
+ "description": "The name of the project.",
10
+ "examples": [
11
+ "my-app"
12
+ ]
9
13
  },
10
14
  "projects": {
11
15
  "type": "array",
12
16
  "items": {
13
17
  "type": "string"
14
- }
18
+ },
19
+ "description": "A list of projects to initialize.",
20
+ "examples": [
21
+ [
22
+ "app1",
23
+ "app2"
24
+ ]
25
+ ]
15
26
  },
16
27
  "skipFormat": {
17
28
  "type": "boolean",
18
- "default": false
29
+ "default": false,
30
+ "description": "Whether to skip formatting generated files.",
31
+ "examples": [
32
+ true,
33
+ false
34
+ ]
19
35
  },
20
36
  "overwrite": {
21
37
  "type": "boolean",
22
38
  "default": false,
23
- "description": "Whether to overwrite existing files"
39
+ "description": "Whether to overwrite existing files.",
40
+ "examples": [
41
+ true,
42
+ false
43
+ ]
24
44
  },
25
45
  "skipProjects": {
26
46
  "type": "boolean",
27
47
  "default": false,
28
- "description": "Whether to skip executing project specific initialization"
48
+ "description": "Whether to skip executing project-specific initialization logic.",
49
+ "examples": [
50
+ true,
51
+ false
52
+ ]
29
53
  }
30
54
  },
31
55
  "required": []
package/src/generators/init-library/schema.json CHANGED
@@ -5,20 +5,39 @@
5
5
  "type": "object",
6
6
  "properties": {
7
7
  "project": {
8
- "type": "string"
8
+ "type": "string",
9
+ "description": "The name of the library project to initialize.",
10
+ "examples": [
11
+ "my-client-lib"
12
+ ]
9
13
  },
10
14
  "external": {
11
15
  "type": "boolean",
12
16
  "default": false,
13
- "x-prompt": "Is the open api specification source external?"
17
+ "x-prompt": "Is the OpenAPI specification source external?",
18
+ "description": "Whether the OpenAPI specification is located outside the workspace.",
19
+ "examples": [
20
+ true,
21
+ false
22
+ ]
14
23
  },
15
24
  "skipFormat": {
16
25
  "type": "boolean",
17
- "default": false
26
+ "default": false,
27
+ "description": "Whether to skip formatting generated files.",
28
+ "examples": [
29
+ true,
30
+ false
31
+ ]
18
32
  },
19
33
  "persistent": {
20
34
  "type": "boolean",
21
- "default": false
35
+ "default": false,
36
+ "description": "Whether to make the initialization changes persistent.",
37
+ "examples": [
38
+ true,
39
+ false
40
+ ]
22
41
  }
23
42
  },
24
43
  "required": ["project"]