Skip to content

Do not include /api path in OpenAPI definition #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
cportele opened this issue Nov 8, 2017 · 1 comment
Closed

Do not include /api path in OpenAPI definition #7

cportele opened this issue Nov 8, 2017 · 1 comment

Comments

@cportele
Copy link
Member

cportele commented Nov 8, 2017

It seems to be rather uncommon to include an operation in an OpenAPI definition that returns an OpenAPI document.

One of the reasons for excluding the operation would be that it will not work well with code generation tool.

Proposal: Simply require that the OpenAPI definition is available at /api, but drop the example and exclude the /api operation from all other examples, too.

@cportele
Copy link
Member Author

Discussed during the meeting on 2017-11-28: Agreed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant