Skip to content

Commit 05c1093

Browse files
authored
docs: update versions, fix links, remove broken camel.xml, update download counts (#19356)
* manually update version in documentation, remove camel.xml ... because it has the wrong generator version, it has the wrong generator name (should be "java-camel"), the generated code doesn't compile - and then I didn't check further * improve automatic version updating * fix one more Readme link * update docker stats again
1 parent daf5222 commit 05c1093

6 files changed

Lines changed: 11 additions & 208 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -436,7 +436,7 @@ openapi-generator-cli version
436436
To use a specific version of "openapi-generator-cli"
437437

438438
```sh
439-
openapi-generator-cli version-manager set 7.0.1
439+
openapi-generator-cli version-manager set 7.7.0
440440
```
441441

442442
Or install it as dev-dependency:
@@ -460,7 +460,7 @@ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generat
460460
(if you're on Windows, replace the last command with `java -jar modules\openapi-generator-cli\target\openapi-generator-cli.jar generate -i https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g php -o c:\temp\php_api_client`)
461461

462462
<!-- RELEASE_VERSION -->
463-
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.0.1/openapi-generator-cli-7.0.1.jar)
463+
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.7.0/openapi-generator-cli-7.7.0.jar)
464464
<!-- /RELEASE_VERSION -->
465465

466466
To get a list of **general** options available, please run `java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help generate`
@@ -576,9 +576,9 @@ Please refer to [online.md](docs/online.md) on how to run and use the `openapi-g
576576

577577
### [3.4 - License information on Generated Code](#table-of-contents)
578578

579-
The OpenAPI Generator project is intended as a benefit for users of the Open API Specification. The project itself has the [License](#license) as specified. In addition, please understand the following points:
579+
The OpenAPI Generator project is intended as a benefit for users of the Open API Specification. The project itself has the [License](#7---license) as specified. In addition, please understand the following points:
580580

581-
* The templates included with this project are subject to the [License](#license).
581+
* The templates included with this project are subject to the [License](#7---license).
582582
* Generated code is intentionally _not_ subject to the parent project license
583583

584584
When code is generated from this project, it shall be considered **AS IS** and owned by the user of the software. There are no warranties--expressed or implied--for generated code. You can do what you wish with it, and once generated, the code is your responsibility and subject to the licensing terms that you deem appropriate.
@@ -943,7 +943,7 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in
943943

944944
What's the design philosophy or principle behind OpenAPI Generator?
945945

946-
We focus on developer experience. The generators should produce code, config, documentation, and more that are easily understandable and consumable by users. We focused on simple use cases to start with (bottom-up approach). Since then the project and the community have grown a lot: 300k weekly downloads via NPM CLI wrapper, 20M downloads via openapi-generator-cli docker image just to highlight a few. We've gradually supported more features (e.g. oneOf, anyOf introduced in OpenAPI 3.0) in various generators and we will continue this approach to deliver something based on our understanding of user demand and what they want, and continue to add support of new features introduced in OpenAPI specification (such as v3.1 and future versions of the OpenAPI specification).
946+
We focus on developer experience. The generators should produce code, config, documentation, and more that are easily understandable and consumable by users. We focused on simple use cases to start with (bottom-up approach). Since then the project and the community have grown a lot: 600k weekly downloads via NPM CLI wrapper, 30M downloads via openapi-generator-cli docker image just to highlight a few. We've gradually supported more features (e.g. oneOf, anyOf introduced in OpenAPI 3.0) in various generators and we will continue this approach to deliver something based on our understanding of user demand and what they want, and continue to add support of new features introduced in OpenAPI specification (such as v3.1 and future versions of the OpenAPI specification).
947947

948948
### [6.1 - OpenAPI Generator Core Team](#table-of-contents)
949949

bin/utils/release/release_version_update_docs.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ declare -a xml_files=(
107107
"${root}/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md"
108108
"${root}/README.md"
109109
"${root}/docs/installation.md"
110+
"${root}/docs/plugins.md"
110111
"${root}/website/src/pages/index.js"
111112
)
112113

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ npm install @openapitools/openapi-generator-cli -g
2222
To install a specific version of the tool, pass the version during installation:
2323
<!-- RELEASE_VERSION -->
2424
```bash
25-
openapi-generator-cli version-manager set 5.3.0
25+
openapi-generator-cli version-manager set 7.7.0
2626
```
2727
<!-- /RELEASE_VERSION -->
2828
To install the tool as a dev dependency in your current project:

docs/plugins.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,12 @@ A Maven plugin to support the OpenAPI generator project
1111

1212
Add to your `build->plugins` section (default phase is `generate-sources` phase)
1313

14+
<!-- RELEASE_VERSION -->
1415
```xml
1516
<plugin>
1617
<groupId>org.openapitools</groupId>
1718
<artifactId>openapi-generator-maven-plugin</artifactId>
18-
<!-- RELEASE_VERSION -->
19-
<version>6.6.0</version>
20-
<!-- /RELEASE_VERSION -->
19+
<version>7.7.0</version>
2120
<executions>
2221
<execution>
2322
<goals>
@@ -34,6 +33,7 @@ Add to your `build->plugins` section (default phase is `generate-sources` phase)
3433
</executions>
3534
</plugin>
3635
```
36+
<!-- /RELEASE_VERSION -->
3737

3838
Followed by:
3939

modules/openapi-generator-maven-plugin/examples/camel.xml

Lines changed: 0 additions & 198 deletions
This file was deleted.

website/src/pages/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ const callouts = [
147147
|npm install @openapitools/openapi-generator-cli -g
148148
|
149149
|# use a specific version of "openapi-generator-cli"
150-
|openapi-generator-cli version-manager set 6.2.0
150+
|openapi-generator-cli version-manager set 7.7.0
151151
|
152152
|# Or install it as dev-dependency in your node.js projects
153153
|npm install @openapitools/openapi-generator-cli -D

0 commit comments

Comments
 (0)