[feature] [jaxrs-spec] Use tag by default to group paths#4939
Closed
shybovycha wants to merge 3 commits intoOpenAPITools:5.0.xfrom
Closed
[feature] [jaxrs-spec] Use tag by default to group paths#4939shybovycha wants to merge 3 commits intoOpenAPITools:5.0.xfrom
shybovycha wants to merge 3 commits intoOpenAPITools:5.0.xfrom
Conversation
shybovycha
changed the title
jimschubert
reviewed
Feb 8, 2020
| } else { | ||
| if (co.path.startsWith("/" + basePath)) { | ||
| co.path = co.path.substring(("/" + basePath).length()); | ||
| String operationKey = tag; |
Member
There was a problem hiding this comment.
I like this idea, however I think it should be guarded by an option the way other generators are doing this (see useTags in SpringCodegen. It looks like defaulting to tags will also have a negative impact on user upgrades for those relying on the subresource behaviors (or groupings in general). I think it would be best to have the opt-in option for 5.0 and make it default at some point later, maybe 5.1?
Contributor
Author
There was a problem hiding this comment.
like this idea. this should make this more a workaround rather than a breaking change. will change my approach
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Introduction
There is one quite nifty but undocumented option,
apis, which could be set in system properties. It defines which API groups should be generated. Given the undocumented internal behavior of grouping all operations by tags, this gives an easy way to migrate existing projects to Open-API with minimal changes by automatically generating API definitions and then generating API interfaces with operations automatically grouped according to the existing endpoints.Hence I am creating a few PRs (#4937, #4938, #4939) addressing this hidden gem of
openapi-generator.This change
Using tag as the primary key to group paths and operations.
This comes extremely handy when used together with
apissystem property (oradditionalPropertiesone, as in #4937 ) so the operations could be grouped into resources.I tested it on our existing project together with
swagger-maven-plugin(specifically this hack) to minimize the change when migrating the whole project to Open-API (mostly automatically).This definitely is a breaking change (as the resources generated will have different names), so targeting
5.0.x.PR checklist
./bin/(or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh,./bin/openapi3/{LANG}-petstore.shif updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).master,4.3.x,5.0.x. Default:master.