Core: Change Swagger word in favor of OpenAPI

Created on 8 Jun 2017  路  13Comments  路  Source: api-platform/core

easy pick waiting

Most helpful comment

Not in class names, it would be a BC break 馃槗.
In UIs it's ok to use Open API. In docs, I think we should use something like Open API (previously known as Swagger) because I'm pretty sure that most people still type "Swagger" when they use the search engine or Google.

All 13 comments

@ismailbaskin Do you want to make a PR about this ?

@Simperfit Should I change all swagger words (except swagger UI) to Open API?

LGTM... WDYT @api-platform/core-team?

Not in class names, it would be a BC break 馃槗.
In UIs it's ok to use Open API. In docs, I think we should use something like Open API (previously known as Swagger) because I'm pretty sure that most people still type "Swagger" when they use the search engine or Google.

What about api:swagger:export command, it will break BC too. So this issue will be closed until new major version, isn't it? @dunglas

We can create a new command but keep this one to avoid breaking IMO.

Yes @antograssiot obviously :p

@ismailbaskin do you want to do it ?

@Simperfit which branch to start on and to which branch this PR should be made ?

@mysiar master IMHO, since 2.2 does not accept new feature and 2.1/2.0 are bug/security fix only.

@Simperfit please correct me if I'm wrong
API documentation standard is OpenAPI but UI is still Swagger, right ?

Was this page helpful?
0 / 5 - 0 ratings