Skip to content

Commit b594262

Browse files
authored
update documentation (#428)
1 parent 2ed3d8c commit b594262

File tree

5 files changed

+13
-3
lines changed

5 files changed

+13
-3
lines changed
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@
1111

1212

1313
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.swagger/openapi-generator-project/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/io.swagger/openapi-generator-project)
14-
[![PR Stats](http://issuestats.com/github/openapitools/openapi-generator/badge/pr)](http://issuestats.com/github/openapitools/openapi-generator) [![Issue Stats](http://issuestats.com/github/openapitools/openapi-generator/badge/issue)](http://issuestats.com/github/openapitools/openapi-generator)
1514

1615
:star::star::star: If you would like to contribute, please refer to [guidelines](CONTRIBUTING.md) and a list of [open tasks](https://github.com/openapitools/openapi-generator/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22).:star::star::star:
1716

17+
:bangbang: To migrate from Swagger Codegen to OpenAPI Generator, please refer to the [migration guide](docs/migration-from-swagger-codegen.md) :bangbang:
18+
1819
:notebook_with_decorative_cover: For more information, please refer to the [Wiki page](https://github.com/openapitools/openapi-generator/wiki) and [FAQ](https://github.com/openapitools/openapi-generator/wiki/FAQ) :notebook_with_decorative_cover:
1920

2021
:warning: If the OpenAPI spec is obtained from an untrusted source, please make sure you've reviewed the spec before using OpenAPI Generator to generate the API client, server stub or documentation as [code injection](https://en.wikipedia.org/wiki/Code_injection) may occur :warning:

docs/migration-from-swagger-codegen.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,14 @@ All languages of `swagger-codegen` have been migrated to `openapi-generator`, bu
7676
| `scala` | `scala-httpclient` |
7777
| `jaxrs` | `jaxrs-jersey` |
7878
| `qt5cpp` | `cpp-qt5` |
79+
| `cpprest` | `cpp-restsdk` |
80+
| `tizen` | `cpp-tizen` |
81+
| `sinatra` | `ruby-sinatra` |
7982
| `swift` | `swift2-deprecated` |
83+
| `lumen` | `php-lumen` |
84+
| `slim` | `php-slim` |
85+
| `ze-ph` | `php-ze-ph` |
86+
| `nancyfx` | `csharp-nancyfx` |
8087

8188

8289
### New parameters name
@@ -120,7 +127,7 @@ If this is a problem for you, you need to explicitly set the the parameter value
120127

121128
### New fully qualified name for the classes
122129

123-
If you have extended some generators in your project, and you are looking for a specific class, replace the `io.swagger.codegen` package (old name) with `org.openapitools.codegen` package (new name).
130+
If you have extended some generators in your project, and you are looking for a specific class, replace the `io.swagger.codegen` package (old name) with `org.openapitools.codegen` package (new name).
124131

125132
Example: `org.openapitools.codegen.DefaultGenerator`
126133

docs/qna.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ No, OpenAPI Generator is still using [Apache license (version 2)](https://www.ap
2929

3030
Swagger Codegen is driven by SmartBear while OpenAPI Generator is driven by the community. More than 40 top contributors and template creators of Swagger Codegen have joined OpenAPI Generator as the founding team members.
3131

32-
#### I’m currently using Swagger Codegen 2.x. How can I upggrade the generator to OpenAPI Generator?
32+
Swagger is a trademark owned by SmartBear and the use of the term "Swagger" found in this project is for demo purpose (reference) only.
33+
34+
#### I’m currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?
3335

3436
OpenAPI Generator is based on Swagger Codegen 2.4.0-SNAPSHOT version so the migration should be easy, straightforward and almost seamless. Please refer to the [migration guide](migration-from-swagger-codegen.md) for more information.
3537

0 commit comments

Comments
 (0)