allow operationId be ignored when generating operation names #2043
Conversation
This file contains 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
mrlubos
reviewed
Feb 20, 2024
bin/index.js
Outdated
| @@ -19,6 +19,7 @@ const params = program | |||
| .option('--exportCore <value>', 'Write core files to disk', true) | |||
| .option('--exportServices <value>', 'Write services to disk', true) | |||
| .option('--exportModels <value>', 'Write models to disk', true) | |||
| .option('--ignoreOperationId <value>', 'Use operation id', true) | |||
There was a problem hiding this comment.
Suggested change
| .option('--ignoreOperationId <value>', 'Use operation id', true) | |
| .option('--ignoreOperationId <value>', 'Ignore operation id', true) |
Although I agree with the initial intent – make the flag opt-in and default to true to preserve current functionality
Suggested change
| .option('--ignoreOperationId <value>', 'Use operation id', true) | |
| .option('--useOperationId <value>', 'Use operation id', true) |
There was a problem hiding this comment.
Fixed in the next commit. Thanks for the review.
|
@askvortcov want to open this pull request against our fork? |
…tent throughout the codebase and documentation
askvortcov
force-pushed
the
allowIgnoringOperationId
branch
from
e8e7a31
to
af4dfb7
Compare
@mrlubos, Done. There is a merge conflict though. If I merge it it pulls too many commits along. |
|
@askvortcov no worries, I will resolve it! |
askvortcov
force-pushed
the
allowIgnoringOperationId
branch
from
e4c3846
to
af4dfb7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a CLI parameter
--useOperationId, which allows using or ignoring OperationId in the swagger and relies on the path to generate operation names.Use path placeholders to decorate operation names.
Ignoring operation ID is handy when working with a swagger generated by
springdoc-openapi, since it generates messy operation IDs when confronted with multiple possibilities ofAcceptheader.resolves #1525