loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

Add docs/installation.md and docsite index to version update script (#5037)

Browse Source
This commit is contained in:
Jim Schubert 2020-01-19 18:02:28 -05:00 committed by GitHub
parent d61dcc17e0
commit bbe88ba635
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

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

2
bin/utils/release/release_version_update_docs.sh
View File

@ -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=(

14
docs/installation.md
View File

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

5
website/pages/en/index.js
View File

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