Skip to content

Commit

Permalink
docs: update versions, fix links, remove broken camel.xml, update dow…
Browse files Browse the repository at this point in the history
…nload counts (OpenAPITools#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
  • Loading branch information
martin-mfg authored Aug 15, 2024
1 parent daf5222 commit 05c1093
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 208 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ openapi-generator-cli version
To use a specific version of "openapi-generator-cli"

```sh
openapi-generator-cli version-manager set 7.0.1
openapi-generator-cli version-manager set 7.7.0
```

Or install it as dev-dependency:
Expand All @@ -460,7 +460,7 @@ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generat
(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`)

<!-- RELEASE_VERSION -->
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)
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)
<!-- /RELEASE_VERSION -->

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

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

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:
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:

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

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.
Expand Down Expand Up @@ -943,7 +943,7 @@ Here are some companies/projects (alphabetical order) using OpenAPI Generator in

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

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).
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).

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

Expand Down
1 change: 1 addition & 0 deletions bin/utils/release/release_version_update_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ declare -a xml_files=(
"${root}/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md"
"${root}/README.md"
"${root}/docs/installation.md"
"${root}/docs/plugins.md"
"${root}/website/src/pages/index.js"
)

Expand Down
2 changes: 1 addition & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ npm install @openapitools/openapi-generator-cli -g
To install a specific version of the tool, pass the version during installation:
<!-- RELEASE_VERSION -->
```bash
openapi-generator-cli version-manager set 5.3.0
openapi-generator-cli version-manager set 7.7.0
```
<!-- /RELEASE_VERSION -->
To install the tool as a dev dependency in your current project:
Expand Down
6 changes: 3 additions & 3 deletions docs/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,12 @@ A Maven plugin to support the OpenAPI generator project

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

<!-- RELEASE_VERSION -->
```xml
<plugin>
<groupId>org.openapitools</groupId>
<artifactId>openapi-generator-maven-plugin</artifactId>
<!-- RELEASE_VERSION -->
<version>6.6.0</version>
<!-- /RELEASE_VERSION -->
<version>7.7.0</version>
<executions>
<execution>
<goals>
Expand All @@ -34,6 +33,7 @@ Add to your `build->plugins` section (default phase is `generate-sources` phase)
</executions>
</plugin>
```
<!-- /RELEASE_VERSION -->

Followed by:

Expand Down
198 changes: 0 additions & 198 deletions modules/openapi-generator-maven-plugin/examples/camel.xml

This file was deleted.

2 changes: 1 addition & 1 deletion website/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ const callouts = [
|npm install @openapitools/openapi-generator-cli -g
|
|# use a specific version of "openapi-generator-cli"
|openapi-generator-cli version-manager set 6.2.0
|openapi-generator-cli version-manager set 7.7.0
|
|# Or install it as dev-dependency in your node.js projects
|npm install @openapitools/openapi-generator-cli -D
Expand Down

0 comments on commit 05c1093

Please sign in to comment.