search

ccouzens / keycloak-openapi

OpenAPI definitions for Keycloak's Admin API
168 stars 66 forks source link

Remove Default from tagging #3

Closed yordis closed 4 years ago

yordis commented 4 years ago

Related to https://github.com/ccouzens/keycloak-openapi/issues/2

  1. Visit https://petstore.swagger.io/
  2. Enter https://raw.githubusercontent.com/ccouzens/keycloak-openapi/master/keycloak/10.0.json in the explore input field
  3. Notice that the Default tag is duplicating the content.

I would propose to remove Default from the tagging, otherwise, it will generate duplicates in the swagger configuration, and I am not sure what is the value-added since every single operation has Default in it (unless I am missed something and I may be wrong)

ccouzens commented 4 years ago

Hi @yordis,

I'm torn about this one.

Here's a commit to show the problem.

The issue is that the example app had to be changed to avoid breaking. If I push this change to master, I might break other people's applications.

I will think about this, and make a decision tomorrow.

I wish I knew how people were using this project. It would help me understand if this would cause problems or not.

yordis commented 4 years ago

Personally, I dont mind breaking changes as long as the authors take the time to document the issue and how to potentially fix it.

This is a small fix that will pay off in the long term, especially that code-gen tools don't have to worry about such thing.

And better sooner than later.

ccouzens commented 4 years ago

I agree with what you say, and have pushed the change to master.

I've added a "Notable Changes" section to the readme to warn about the change https://github.com/ccouzens/keycloak-openapi/blob/master/README.md#notable-changes Hopefully this will be sufficient to warn existing users.