Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,10 +395,10 @@ openapi-generator version
```

<!-- RELEASE_VERSION -->
Or install a particular OpenAPI Generator version (e.g. v4.1.2):
Or install a particular OpenAPI Generator version (e.g. v4.2.2):

```sh
npm install @openapitools/openapi-generator-cli@cli-4.1.2 -g
npm install @openapitools/openapi-generator-cli@cli-4.2.2 -g
```

Or install it as dev-dependency:
Expand Down
2 changes: 2 additions & 0 deletions bin/utils/release/release_version_update_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ declare -a xml_files=(
"${root}/modules/openapi-generator-maven-plugin/README.md"
"${root}/modules/openapi-generator-gradle-plugin/samples/local-spec/README.md"
"${root}/README.md"
"${root}/docs/installation.md"
"${root}/website/pages/en/index.js"
)

declare -a commented_files=(
Expand Down
14 changes: 8 additions & 6 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ npm install @openapitools/openapi-generator-cli -g
```

To install a specific version of the tool, pass the version during installation:

<!-- RELEASE_VERSION -->
```bash
npm install @openapitools/openapi-generator-cli@cli-3.3.4 -g
npm install @openapitools/openapi-generator-cli@cli-4.2.2 -g
```

<!-- /RELEASE_VERSION -->
To install the tool as a dev dependency in your current project:

```bash
Expand Down Expand Up @@ -77,21 +77,23 @@ docker run --rm \

> **Platform(s)**: Linux, macOS, Windows

<!-- RELEASE_VERSION -->
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):

JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/3.3.4/openapi-generator-cli-3.3.4.jar`
JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.2/openapi-generator-cli-4.2.2.jar`

For **Mac/Linux** users:

```bash
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/3.3.4/openapi-generator-cli-3.3.4.jar -O openapi-generator-cli.jar
wget https//repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.2/openapi-generator-cli-4.2.2.jar -O openapi-generator-cli.jar
```

For **Windows** users, you will need to install [wget](http://gnuwin32.sourceforge.net/packages/wget.htm) or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.

```
Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/3.3.4/openapi-generator-cli-3.3.4.jar
Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.2/openapi-generator-cli-4.2.2.jar
```
<!-- /RELEASE_VERSION -->

After downloading the JAR, run `java -jar openapi-generator-cli.jar help` to show the usage.

Expand Down
5 changes: 3 additions & 2 deletions website/pages/en/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -179,17 +179,18 @@ class Index extends React.Component {
const tryNpmContents = stripMargin`
| The [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) is cross-platform wrapper around the .jar artifact.
| **Install** globally, exposing the CLI on the command line:
|
| <!-- RELEASE_VERSION -->
| \`\`\`bash
| # install the latest version of "openapi-generator-cli"
| npm install @openapitools/openapi-generator-cli -g
|
| # install a specific version of "openapi-generator-cli"
| npm install @openapitools/openapi-generator-cli@cli-3.0.0 -g
| npm install @openapitools/openapi-generator-cli@cli-4.2.2 -g
|
| # Or install it as dev-dependency in your node.js projects
| npm install @openapitools/openapi-generator-cli -D
| \`\`\`
|<!-- /RELEASE_VERSION -->
|
| Then, **generate** a ruby client from a valid [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml) doc:
| \`\`\`bash
Expand Down