@openapitools/openapi-generator-cli 2.13.4 → 2.13.6

package/README.md

@@ -10,7 +10,7 @@ OpenAPI Generator allows generation of API client libraries (SDK generation), se
 configuration automatically given an OpenAPI Spec (both 2.0 and 3.0 are supported). Please see
 [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator).
 
-The OpenAPI Generator is a Java project. `openapi-generator-cli` will download the appropriate JAR file and invoke the `java` executable to run the OpenAPI Generator. You must have the `java` binary executable available on your `PATH` for this to work.
+The OpenAPI Generator is a Java project. `openapi-generator-cli` will download the appropriate JAR file and invoke the `java` executable to run the OpenAPI Generator. You must have the `java` binary executable available on your `PATH` for this to work. (JDK 11 is the minimal version supported. To install OpenJDK, please visit https://adoptium.net/)
 
 If you find this tool useful, please consider sponsoring this project financially via https://opencollective.com/openapi_generator or directly to [Kay Schecker](https://github.com/sponsors/kay-schecker) (the author of this tool) :pray:
 
@@ -115,7 +115,7 @@ Initially the file has the following content:
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "4.3.1" // or the current latest version ;)
+    "version": "7.8.0" // or the current latest version ;)
   }
 }
 ```
@@ -124,7 +124,7 @@ This configuration indicates the following:
 
 - the json file shall be formatted using **2 spaces**
 - the jar files shall be downloaded to *./my/custom/storage/dir*
-- the generator-cli version 4.3.1 is used
+- the generator-cli version 7.8.0 is used
 
 Further it is also possible to configure generators, for example:
 
@@ -133,7 +133,7 @@ Further it is also possible to configure generators, for example:
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "4.3.1",
+    "version": "7.8.0",
     "storageDir": "~/my/custom/storage/dir", // optional
     "generators": { // optional
       "v2.0": { // any name you like (just printed to the console log or reference it using --generator-key) 
@@ -185,7 +185,7 @@ If you're using a private maven registry you can configure the `downloadUrl` and
   "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
   "spaces": 2,
   "generator-cli": {
-    "version": "5.3.0",
+    "version": "7.8.0",
     "repository": {
       "queryUrl": "https://private.maven.intern/solrsearch/select?q=g:${group.id}+AND+a:${artifact.id}&core=gav&start=0&rows=200",
       "downloadUrl": "https://private.maven.intern/maven2/${groupId}/${artifactId}/${versionName}/${artifactId}-${versionName}.jar"
@@ -196,6 +196,44 @@ If you're using a private maven registry you can configure the `downloadUrl` and
 
 If the `version` property param is set it is not necessary to configure the `queryUrl`.
 
+### Use locally built JAR
+In order to use a locally built jar of the generator CLI, you can copy the jar from your local build (i.e. if you were to `build` the [OpenAPITools/openapi-generator](https://github.com/OpenAPITools/openapi-generator) repository it would be in `~/openapi-generator/modules/openapi-generator-cli/target/openapi-generator-cli.jar`) into `./node_modules/@openapitools/openapi-generator-cli/versions/` and change the `version` in the `openapitools.json` file to the base name of the jar file.
+E.g.:
+```sh
+cd openapi-generator
+./mvnw clean package
+cp ./modules/openapi-generator-cli/target/openapi-generator-cli.jar /your/project/node_modules/@openapitools/openapi-generator-cli/versions/my-local-snapshot.jar
+```
+and then:
+```json
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "my-local-snapshot",
+  }
+}
+```
+
+### Use nightly `SNAPSHOT` build
+Change your `openapitools.json` to:
+
+```json
+{
+  "$schema": "node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.9.0-20240829.123431-22",
+    "repository": {
+      "downloadUrl": "https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/7.9.0-SNAPSHOT/openapi-generator-cli-${versionName}.jar"
+    }
+  }
+}
+```
+
+Example is with a snapshot of `7.9.0`, please change the `version` and `downloadUrl` accordingly.
+You can find all snapshots [here](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-generator-cli/).
+
 ## Run specific generators
 
 | cmd                                                      | v3.0 runs | v2.0 runs |
@@ -231,7 +269,7 @@ more information about the possible arguments and a detailed usage manual of the
 
 ```sh
 npm install @openapitools/openapi-generator-cli@previous
-npm i @openapitools/openapi-generator-cli@1.0.18-4.3.1                                         
+npm i @openapitools/openapi-generator-cli@1.0.18-4.3.1
 ```
 
 or using yarn

package/package.json

@@ -51,7 +51,7 @@
       "text": "Please sponsor OpenAPI Generator."
     }
   },
-  "version": "2.13.4",
+  "version": "2.13.6",
   "name": "@openapitools/openapi-generator-cli",
   "description": "A npm package wrapper for OpenAPI Generator (https://github.com/OpenAPITools/openapi-generator), generates which API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)",
   "scripts": {
@@ -66,11 +66,11 @@
     "main.js"
   ],
   "dependencies": {
-    "@nestjs/axios": "3.0.2",
+    "@nestjs/axios": "3.0.3",
     "@nestjs/common": "10.3.0",
     "@nestjs/core": "10.3.0",
     "@nuxtjs/opencollective": "0.3.2",
-    "axios": "1.6.8",
+    "axios": "1.7.4",
     "chalk": "4.1.2",
     "commander": "8.3.0",
     "compare-versions": "4.1.4",