From b5942624d6714f38c0bde9ae9c7400df1d48b1ed Mon Sep 17 00:00:00 2001 From: William Cheng Date: Sat, 12 May 2018 10:19:27 +0800 Subject: [PATCH] update documentation (#428) --- .travis.yml.bash => CI/.travis.yml.bash | 0 .travis.yml.ios => CI/.travis.yml.ios | 0 README.md | 3 ++- docs/migration-from-swagger-codegen.md | 9 ++++++++- docs/qna.md | 4 +++- 5 files changed, 13 insertions(+), 3 deletions(-) rename .travis.yml.bash => CI/.travis.yml.bash (100%) rename .travis.yml.ios => CI/.travis.yml.ios (100%) diff --git a/.travis.yml.bash b/CI/.travis.yml.bash similarity index 100% rename from .travis.yml.bash rename to CI/.travis.yml.bash diff --git a/.travis.yml.ios b/CI/.travis.yml.ios similarity index 100% rename from .travis.yml.ios rename to CI/.travis.yml.ios diff --git a/README.md b/README.md index bb9a616fe63c..6d9a6d681ef8 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,11 @@ [![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) -[![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) :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: +:bangbang: To migrate from Swagger Codegen to OpenAPI Generator, please refer to the [migration guide](docs/migration-from-swagger-codegen.md) :bangbang: + :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: :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: diff --git a/docs/migration-from-swagger-codegen.md b/docs/migration-from-swagger-codegen.md index 59a33e089cb2..fa1f4eb87a78 100644 --- a/docs/migration-from-swagger-codegen.md +++ b/docs/migration-from-swagger-codegen.md @@ -76,7 +76,14 @@ All languages of `swagger-codegen` have been migrated to `openapi-generator`, bu | `scala` | `scala-httpclient` | | `jaxrs` | `jaxrs-jersey` | | `qt5cpp` | `cpp-qt5` | +| `cpprest` | `cpp-restsdk` | +| `tizen` | `cpp-tizen` | +| `sinatra` | `ruby-sinatra` | | `swift` | `swift2-deprecated` | +| `lumen` | `php-lumen` | +| `slim` | `php-slim` | +| `ze-ph` | `php-ze-ph` | +| `nancyfx` | `csharp-nancyfx` | ### New parameters name @@ -120,7 +127,7 @@ If this is a problem for you, you need to explicitly set the the parameter value ### New fully qualified name for the classes -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). +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). Example: `org.openapitools.codegen.DefaultGenerator` diff --git a/docs/qna.md b/docs/qna.md index 8310c2170acb..5a93680b03c9 100644 --- a/docs/qna.md +++ b/docs/qna.md @@ -29,7 +29,9 @@ No, OpenAPI Generator is still using [Apache license (version 2)](https://www.ap 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. -#### I’m currently using Swagger Codegen 2.x. How can I upggrade the generator to OpenAPI Generator? +Swagger is a trademark owned by SmartBear and the use of the term "Swagger" found in this project is for demo purpose (reference) only. + +#### I’m currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator? 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.