Skip to content

Commit c9085b4

Browse files
authored
Update Q&A based on feedback from users (#695)
* update qna based on feedback from users * Improvements * minor fix to typo
1 parent f6146b2 commit c9085b4

1 file changed

Lines changed: 21 additions & 22 deletions

File tree

docs/qna.md

Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,40 @@
22

33
#### What is the governance structure of the OpenAPI Generator project?
44

5-
OpenAPI generator (openapi-generator) is managed by the [core team members](../README.md#openapi-generator-core-team).
5+
OpenAPI generator (openapi-generator) is managed by the members of the [core team](../README.md#openapi-generator-core-team).
66

77

8-
#### Why was it decided to fork Swagger Codegen and to maintain a community-driven version?
8+
#### What is the difference between Swagger Codegen and OpenAPI Generator?
99

10-
There are several reasons:
10+
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.
1111

12-
1. The founding members came to the conclusion that Swagger Codegen 3.0.0 beta contains too many breaking changes while they strongly believe 3.0.0 release should only focus on one thing: OpenAPI specification 3.0 support.
13-
1. Swagger Codegen 3.0.0 beta was evaluated as unstable. Changes made directly to 3.0.0 branch without reviews or tests, were breaking the builds from time to time (e.g. a simple `mvn clean package` failed).
14-
1. Reviews of code changes in the 3.0.0 branch highlighted a lot of code block removal without any reason. This might produce regressions for edge cases discovered previously.
15-
1. Most of the test cases in the generators have been commented out as part of the migration to support OpenAPI 3.0. Test cases are the most valuable assets of the project and should be maintained to ensure a good quality.
16-
1. According to SmartBear, [Swagger Codegen 2.x and 3.x should be supported in parallel for a while](https://github.com/swagger-api/swagger-codegen/issues/7754#issuecomment-375039048) without the possibility to work with git branches to merge the fixes from one branch to the next. Having to implement everything twice is not a good idea and the best use of the Swagger Codegen community resources.
17-
1. Having a community-driven version can bring the project to the next level.
12+
Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.
1813

19-
UPDATE: After the public launch of OpenAPI Generator, some of the core team members were contacted by Ron (SmartBear) and we explained to him the reasons of the fork as explained above. We also asked him to contact team@openapitools.org if he wants to discuss further but so far we don't see any email from him to team@openapitools.org.
2014

21-
#### Has anything been done in attempt to address the issues before deciding to fork Swagger Codegen and maintain a community-driven version?
15+
#### Why was it decided to fork Swagger Codegen and to maintain a community-driven version?
2216

23-
There were several conversations with SmartBear (Ron, Hugo) via emails, gitter, Skype call and GitHub issues.
24-
But there was no consensus on the next steps and on the direction for Swagger Codegen 3.0.0.
17+
There are several reasons:
2518

26-
#### Is there any change to the project license?
19+
1. The founding members came to the conclusion that Swagger Codegen 3.0.0 beta contains too many breaking changes. They also strongly believe the 3.0.0 release should only focus on one thing: OpenAPI 3.0 support.
20+
1. The founding members had concerns about the development practices, which seemed to be contributing to an unstable and insufficiently tested codebase.
21+
1. There was a disagreement on the evolutionary strategy for Swagger Codegen. The founding members felt it was important to move forward with OpenAPI 3.0 support, while maintaining backward compatibility with OpenAPI 2.0 in the same codebase.
22+
1. The founding members found that the enhancements and bug fixes submitted for Swagger Codegen 2.x need to be submitted again for Swagger Codegen 3.0.0 branch (otherwise, these changes would not appear in the 3.0.0 branch. Having to do the pull request twice is not the best use of community resources).
23+
1. The community-driven version has a more rapid [release cycle](https://github.com/OpenAPITools/openapi-generator/releases/) (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.
24+
1. Having a community-driven version _can_ bring the project to the next level with reliable releases and a clear [roadmap](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/roadmap.adoc).
2725

28-
No, OpenAPI Generator is still using [Apache license (version 2)](https://www.apache.org/licenses/LICENSE-2.0).
26+
#### Was anything done to attempt to address the issues before deciding to fork Swagger Codegen and maintain a community-driven version?
2927

30-
#### What is the difference between Swagger Codegen and OpenAPI Generator?
28+
There were several conversations with the project owners of Swagger Codegen via emails, Gitter, Skype call and GitHub issues to discuss the state of Swagger Codegen 3.0.0.
29+
But there was no consensus on the next steps and on the direction for Swagger Codegen 3.0.0.
3130

32-
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.
31+
#### Are there any changes to the project license?
3332

34-
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+
No, OpenAPI Generator is still using the [Apache license (version 2)](https://www.apache.org/licenses/LICENSE-2.0).
3534

36-
#### I’m currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?
35+
#### I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?
3736

38-
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.
37+
OpenAPI Generator is based on Swagger Codegen `2.4.0-SNAPSHOT` version so the migration should be relatively straightforward. Refer to the [migration guide](migration-from-swagger-codegen.md) for more information.
3938

40-
#### May I know who maintains this Q&A page?
39+
#### Who maintains this Q&A page?
4140

42-
This Q&A page is maintained by the [core team members](../README.md#openapi-generator-core-team). It's not maintained by a single person nor do these Q&As represent the view of an individual.
41+
This Q&A page is maintained by the [core team members](../README.md#openapi-generator-core-team). It is not maintained by a single person nor do these Q&As represent the views of any individual or person.

0 commit comments

Comments
 (0)