Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Clean up qna and faq
  • Loading branch information
jimschubert committed Dec 5, 2018
commit e149f4f6c34efdf862c4429c33facd5c6a4f7a53
18 changes: 18 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -1 +1,19 @@
# FAQ

## Do you have a chat room?

[![Gitter](https://img.shields.io/gitter/room/:user/:repo.svg?style=for-the-badge)](https://gitter.im/OpenAPITools/openapi-generator)

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

OpenAPI generator (openapi-generator) is managed by the members of the [core team](./core-team.md).

## What is the difference between Swagger Codegen and OpenAPI Generator?

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. For more details, see the [Fork Q&A](./qna.md).

Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.

## How do I extend the generator?

See our [customization](./customization.md) documentation.
41 changes: 12 additions & 29 deletions docs/qna.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,24 @@
## Question and Answer
# Questions and Answers

#### What is the governance structure of the OpenAPI Generator project?
This document aims to answer some questions about the fork for historical reference, where these questions don't fit into other documents related to the project itself.

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


#### What is the difference between Swagger Codegen and OpenAPI Generator?

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.

Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.


#### Why was it decided to fork Swagger Codegen and to maintain a community-driven version?
## Why was it decided to fork Swagger Codegen?

There are several reasons:

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.
1. The founding members had concerns about the development practices, which seemed to be contributing to an unstable and insufficiently tested codebase.
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.
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).
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.
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.md).

#### Was anything done to attempt to address the issues before deciding to fork Swagger Codegen and maintain a community-driven version?

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.
But there was no consensus on the next steps and on the direction for Swagger Codegen 3.0.0.
1. The founding members felt that Swagger Codegen 3.0.0 was diverging too much from the philosophy of Swagger Codegen 2.x.
1. The founding members were concerned that the maintenance overhead of two separate branches (2.x, 3.x) would result in issues similar to those felt in the Python community.
1. The founding members wanted 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.
1. Having a community-driven version allows for innovation, reliability, and a [roadmap](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/roadmap.md) owned by the community.

#### Are there any changes to the project license?
## Are there any changes to the project license?

No, OpenAPI Generator is still using the [Apache license (version 2)](https://www.apache.org/licenses/LICENSE-2.0).

#### I am currently using Swagger Codegen 2.x. How can I upgrade the generator to OpenAPI Generator?
## I am 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 relatively straightforward. Refer to the [migration guide](migration-from-swagger-codegen.md) for more information.
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.

#### Who maintains this Q&A page?
## Who maintains this Q&A page?

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.
This Q&A page is maintained by the [core team members](./core-team.md). It is not maintained by any single person, nor do these Q&As represent the views of any individual or person.