@rxap/plugin-open-api 20.0.2 → 20.0.3-dev.1

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 (3) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/README.md +38 -44
  3. package/package.json +7 -7
package/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
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.0.3-dev.1](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.0.3-dev.0...@rxap/plugin-open-api@20.0.3-dev.1) (2025-02-17)
7
+
8
+ **Note:** Version bump only for package @rxap/plugin-open-api
9
+
10
+ ## [20.0.3-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.0.2...@rxap/plugin-open-api@20.0.3-dev.0) (2025-02-17)
11
+
12
+ **Note:** Version bump only for package @rxap/plugin-open-api
13
+
6
14
  ## [20.0.2](https://gitlab.com/rxap/packages/compare/@rxap/plugin-open-api@20.0.1...@rxap/plugin-open-api@20.0.2) (2025-02-13)
7
15
 
8
16
  **Note:** Version bump only for package @rxap/plugin-open-api
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @rxap/plugin-open-api
1
+ 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.
2
2
 
3
3
  [![npm version](https://img.shields.io/npm/v/@rxap/plugin-open-api?style=flat-square)](https://www.npmjs.com/package/@rxap/plugin-open-api)
4
4
  [![commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](https://commitizen.github.io/cz-cli/)
@@ -9,7 +9,12 @@
9
9
 
10
10
  - [Installation](#installation)
11
11
  - [Generators](#generators)
12
+ - [generate](#generate)
13
+ - [init-library](#init-library)
14
+ - [init](#init)
12
15
  - [Executors](#executors)
16
+ - [copy-open-api-sdk](#copy-open-api-sdk)
17
+ - [generate](#generate)
13
18
 
14
19
  # Installation
15
20
 
@@ -27,70 +32,59 @@ yarn nx g @rxap/plugin-open-api:init
27
32
  > generate generator
28
33
 
29
34
  ```bash
30
- yarn nx g @rxap/plugin-open-api:generate
35
+ nx g @rxap/plugin-open-api:generate
31
36
  ```
32
37
 
33
38
  ## init-library
34
39
  > init-library generator
35
40
 
36
41
  ```bash
37
- yarn nx g @rxap/plugin-open-api:init-library
42
+ nx g @rxap/plugin-open-api:init-library
38
43
  ```
39
44
 
40
- ## init
41
- > Initialize the package in the workspace
42
-
43
- ```bash
44
- yarn nx g @rxap/plugin-open-api:init
45
- ```
46
-
47
- ## generate
48
- > generate generator
49
-
50
- ```bash
51
- yarn nx g @rxap/plugin-open-api:generate
52
- ```
53
-
54
- ## init-library
55
- > init-library generator
56
-
57
- ```bash
58
- yarn nx g @rxap/plugin-open-api:init-library
59
- ```
45
+ Option | Type | Default | Description
46
+ --- | --- | --- | ---
47
+ project | string | |
48
+ external | boolean | false |
49
+ skipFormat | boolean | false |
50
+ persistent | boolean | false |
60
51
 
61
52
  ## init
62
53
  > Initialize the package in the workspace
63
54
 
64
55
  ```bash
65
- yarn nx g @rxap/plugin-open-api:init
56
+ nx g @rxap/plugin-open-api:init
66
57
  ```
58
+
59
+ Option | Type | Default | Description
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
67
66
  # Executors
68
67
 
69
68
  ## copy-open-api-sdk
70
69
  > copy-open-api-sdk executor
71
70
 
72
- **project.json**
73
- ```json
74
- {
75
- "targets": {
76
- "copy-open-api-sdk": {
77
- "executor": "@rxap/plugin-open-api:copy-open-api-sdk"
78
- }
79
- }
80
- }
81
- ```
71
+
72
+ Option | Type | Default | Description
73
+ --- | --- | --- | ---
74
+ clientSdkProject | string | | The name of the client SDK project to copy
75
+ angular | boolean | | Whether to copy the files for an Angular project
76
+ nestjs | boolean | | Whether to copy the files for a NestJS project
77
+ outputDir | string | openapi | The directory to copy the files to
78
+ skipDirectives | boolean | | Whether to skip copying the directives
79
+ skipDataSources | boolean | | Whether to skip copying the data sources
80
+ skipRemoteMethods | boolean | | Whether to skip copying the remote methods
82
81
 
83
82
  ## generate
84
83
  > generate executor
85
84
 
86
- **project.json**
87
- ```json
88
- {
89
- "targets": {
90
- "generate": {
91
- "executor": "@rxap/plugin-open-api:generate"
92
- }
93
- }
94
- }
95
- ```
85
+
86
+ Option | Type | Default | Description
87
+ --- | --- | --- | ---
88
+ properties | | |
89
+ required | | |
96
90
 
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
- "version": "20.0.2",
2
+ "version": "20.0.3-dev.1",
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.4.2",
8
8
  "@rxap/node-utilities": "^1.3.8",
9
- "@rxap/plugin-library": "^20.1.1",
10
- "@rxap/plugin-utilities": "^20.0.1",
9
+ "@rxap/plugin-library": "^20.1.2-dev.1",
10
+ "@rxap/plugin-utilities": "^20.0.2-dev.1",
11
11
  "@rxap/utilities": "^16.4.2",
12
- "@rxap/workspace-open-api": "^19.0.11",
13
- "@rxap/workspace-ts-morph": "^19.1.9",
14
- "@rxap/workspace-utilities": "^19.6.1",
12
+ "@rxap/workspace-open-api": "^19.0.12-dev.0",
13
+ "@rxap/workspace-ts-morph": "^19.1.10-dev.0",
14
+ "@rxap/workspace-utilities": "^19.6.2-dev.0",
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": "402887412674e616554624b2c11770ca36982b78",
48
+ "gitHead": "0b022b6165e06718ce3edf73ae1d5375f0ff3413",
49
49
  "exports": {
50
50
  "./package.json": "./package.json",
51
51
  ".": {