Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Commit 06c4cdf

Browse files
committed
Readme update
1 parent 8fa0641 commit 06c4cdf

File tree

5 files changed

+17
-51
lines changed

5 files changed

+17
-51
lines changed

README.md

Lines changed: 17 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,8 @@ Definitely!
4343
- [Table of Contents](#table-of-contents)
4444
- [1 - Installation](#1---installation)
4545
- [1.1 - Compatibility](#11---compatibility)
46-
- [1.2 - Download JAR](#12---download-jar)
47-
- [1.3 - Build Projects](#13---build-projects)
48-
- [1.4 - Docker](#14---docker)
46+
- [1.2 - Build Projects](#12---build-projects)
47+
- [1.3 - Docker](#13---docker)
4948
- [2 - Getting Started](#2---getting-started)
5049
- [3 - Usage](#3---usage)
5150
- [3.1 - Customization](#31---customization)
@@ -55,7 +54,7 @@ Definitely!
5554
- [3.5 - IDE Integration](#35---ide-integration)
5655
- [4 - Companies/Projects using OpenAPI JSON Schema Generator](#4---companiesprojects-using-openapi-json-schema-generator)
5756
- [5 - About Us](#5---about-us)
58-
- [5.3 - History of OpenAPI JSON Schema Generator](#53---history-of-openapi-json-schema-generator)
57+
- [5.1 - History of OpenAPI JSON Schema Generator](#53---history-of-openapi-json-schema-generator)
5958
- [6 - License](#6---license)
6059

6160
## [1 - Installation](#table-of-contents)
@@ -69,33 +68,7 @@ The OpenAPI Specification has undergone 3 revisions since initial creation in 20
6968
| 1.0.0 (first stable release) [SNAPSHOT](https://oss.sonatype.org/content/repositories/snapshots/org/openapitools/openapi-json-schema-generator-cli/1.0.0-SNAPSHOT/) | TBD | First release |
7069
OpenAPI Spec compatibility: 3.0
7170

72-
73-
### [1.2 - Download JAR](#table-of-contents)
74-
<!-- RELEASE_VERSION -->
75-
If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):
76-
77-
JAR location: `https://repo1.maven.org/maven2/org/openapitools/openapi-json-schema-generator-cli/6.1.0/openapi-json-schema-generator-cli-6.1.0.jar`
78-
79-
For **Mac/Linux** users:
80-
```sh
81-
wget https://repo1.maven.org/maven2/org/openapitools/openapi-json-schema-generator-cli/6.1.0/openapi-json-schema-generator-cli-6.1.0.jar -O openapi-json-schema-generator-cli.jar
82-
```
83-
84-
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.
85-
```
86-
Invoke-WebRequest -OutFile openapi-json-schema-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-json-schema-generator-cli/6.1.0/openapi-json-schema-generator-cli-6.1.0.jar
87-
```
88-
89-
After downloading the JAR, run `java -jar openapi-json-schema-generator-cli.jar help` to show the usage.
90-
91-
For Mac users, please make sure Java 8 is installed (Tips: run `java -version` to check the version), and export `JAVA_HOME` in order to use the supported Java version:
92-
```sh
93-
export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
94-
export PATH=${JAVA_HOME}/bin:$PATH
95-
```
96-
<!-- /RELEASE_VERSION -->
97-
98-
### [1.3 - Build Projects](#table-of-contents)
71+
### [1.2 - Build Projects](#table-of-contents)
9972

10073
To build from source, you need the following installed and available in your `$PATH:`
10174

@@ -119,7 +92,7 @@ The default build contains minimal static analysis (via CheckStyle). To run your
11992
mvn -Pstatic-analysis clean install
12093
```
12194

122-
### [1.4 - Docker](#table-of-contents)
95+
### [1.3 - Docker](#table-of-contents)
12396

12497
#### Public Pre-built Docker images
12598

@@ -228,17 +201,17 @@ cd /vagrant
228201
<!-- /RELEASE_VERSION -->
229202
## [2 - Getting Started](#table-of-contents)
230203

231-
To generate a PHP client for [petstore.yaml](https://raw.githubusercontent.com/openapitools/openapi-json-schema-generator/master/modules/openapi-json-schema-generator/src/test/resources/3_0/petstore.yaml), please run the following
204+
To generate a python client for [petstore.yaml](https://raw.githubusercontent.com/openapi-json-schema-tools/openapi-json-schema-generator/master/modules/openapi-json-schema-generator/src/test/resources/3_0/petstore.yaml), please run the following
232205
```sh
233-
git clone https://github.com/openapitools/openapi-json-schema-generator
206+
git clone https://github.com/openapi-json-schema-tools/openapi-json-schema-generator
234207
cd openapi-json-schema-generator
235208
mvn clean package
236209
java -jar modules/openapi-json-schema-generator-cli/target/openapi-json-schema-generator-cli.jar generate \
237-
-i https://raw.githubusercontent.com/openapitools/openapi-json-schema-generator/master/modules/openapi-json-schema-generator/src/test/resources/3_0/petstore.yaml \
238-
-g php \
239-
-o /var/tmp/php_api_client
210+
-i https://raw.githubusercontent.com/openapi-json-schema-tools/openapi-json-schema-generator/master/modules/openapi-json-schema-generator/src/test/resources/3_0/petstore.yaml \
211+
-g python \
212+
-o /var/tmp/python_api_client
240213
```
241-
(if you're on Windows, replace the last command with `java -jar modules\openapi-json-schema-generator-cli\target\openapi-json-schema-generator-cli.jar generate -i https://raw.githubusercontent.com/openapitools/openapi-json-schema-generator/master/modules/openapi-json-schema-generator/src/test/resources/3_0/petstore.yaml -g php -o c:\temp\php_api_client`)
214+
(if you're on Windows, replace the last command with `java -jar modules\openapi-json-schema-generator-cli\target\openapi-json-schema-generator-cli.jar generate -i https://raw.githubusercontent.com/openapi-json-schema-tools/openapi-json-schema-generator/master/modules/openapi-json-schema-generator/src/test/resources/3_0/petstore.yaml -g python -o c:\temp\python_api_client`)
242215

243216
<!-- RELEASE_VERSION -->
244217
You can also download the JAR (latest release) directly from [maven.org](https://repo1.maven.org/maven2/org/openapitools/openapi-json-schema-generator-cli/6.1.0/openapi-json-schema-generator-cli-6.1.0.jar)
@@ -350,11 +323,16 @@ The OpenAPI JSON Schema Generator project is intended as a benefit for users of
350323

351324
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.
352325

353-
### [6 - History of OpenAPI JSON Schema Generator](#table-of-contents)
326+
## [4 - Companies/Projects using OpenAPI JSON Schema Generator](#table-of-contents)
327+
328+
## [5 - About Us](#table-of-contents)
329+
330+
## [6 - History of OpenAPI JSON Schema Generator](#table-of-contents)
354331

355332
OpenAPI JSON Schema Generator is based on OpenAPI Generator v6.2.0. It focuses on JSON schema support and the output is designed to be 100% compliance with JSON Schema.
356333

357334
## [7 - License](#table-of-contents)
335+
358336
-------
359337

360338
Copyright 2018 OpenAPI-Generator Contributors (https://openapi-generator.tech)

modules/openapi-json-schema-generator-cli/pom.xml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
<parent>
44
<groupId>org.openapitools</groupId>
55
<artifactId>openapi-json-schema-generator-project</artifactId>
6-
<!-- RELEASE_VERSION -->
7-
<version>1.0.0-SNAPSHOT</version>
8-
<!-- /RELEASE_VERSION -->
96
<relativePath>../..</relativePath>
107
</parent>
118
<modelVersion>4.0.0</modelVersion>

modules/openapi-json-schema-generator-core/pom.xml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@
55
<parent>
66
<artifactId>openapi-json-schema-generator-project</artifactId>
77
<groupId>org.openapitools</groupId>
8-
<!-- RELEASE_VERSION -->
9-
<version>1.0.0-SNAPSHOT</version>
10-
<!-- /RELEASE_VERSION -->
118
<relativePath>../..</relativePath>
129
</parent>
1310
<modelVersion>4.0.0</modelVersion>

modules/openapi-json-schema-generator-online/pom.xml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
<parent>
44
<groupId>org.openapitools</groupId>
55
<artifactId>openapi-json-schema-generator-project</artifactId>
6-
<!-- RELEASE_VERSION -->
7-
<version>1.0.0-SNAPSHOT</version>
8-
<!-- /RELEASE_VERSION -->
96
<relativePath>../..</relativePath>
107
</parent>
118
<artifactId>openapi-json-schema-generator-online</artifactId>

modules/openapi-json-schema-generator/pom.xml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,6 @@
33
<parent>
44
<groupId>org.openapitools</groupId>
55
<artifactId>openapi-json-schema-generator-project</artifactId>
6-
<!-- RELEASE_VERSION -->
7-
<version>1.0.0-SNAPSHOT</version>
8-
<!-- /RELEASE_VERSION -->
96
<relativePath>../..</relativePath>
107
</parent>
118
<modelVersion>4.0.0</modelVersion>

0 commit comments

Comments
 (0)