OpenApiNormalizer FILTER improvements. Multi filters + filter on path #22128
+317
−108
Conversation
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
jpfinne
changed the title
docs/customization.md
Outdated
| - `FILTER` | ||
| The `FILTER` parameter allows selective inclusion of API operations based on specific criteria. It applies the `x-internal: true` property to operations that do **not** match the specified values, preventing them from being generated. | ||
| The `FILTER` parameter allows selective inclusion of API operations based on specific criteria. It applies the `x-internal: true` property to operations that do **not** match the specified values, preventing them from being generated. Multiple filters can be separated by a semi-column. |
There was a problem hiding this comment.
It should say "semi-colon" (;) rather than "semi-column"?
| .filter(Objects::nonNull) | ||
| .map(String::trim) | ||
| .collect(Collectors.toCollection(HashSet::new)); | ||
| if ("operationId".equals(filterKey)) { |
There was a problem hiding this comment.
Should we collect these commonly used definitions ("operationId", "method", ...) as static variables in the class so it is easier to navigate and see where they are used?
Improve exception handling and tests.
|
Wait a bit before merging. |
|
Now the filter processing is extensible |
|
Looks great. Love it when extensible functionality is introduced (and especially when there are test-cases to illustrate how to utilize the customization!). ❤️ |
|
tested locally and the result is good --- a/api/openapi.yaml
+++ b/api/openapi.yaml
@@ -334,7 +334,7 @@ paths:
summary: Returns pet inventories by status
tags:
- store
- x-internal: true
+ x-internal: false
x-accepts:
- application/json
/store/order:
@@ -363,7 +363,7 @@ paths:
summary: Place an order for a pet
tags:
- store
- x-internal: true
+ x-internal: false
x-content-type: application/json
x-accepts:
- application/json
@@ -390,7 +390,7 @@ paths:
summary: Delete purchase order by ID
tags:
- store
- x-internal: true
+ x-internal: false
x-accepts:
- application/json
get:
@@ -426,7 +426,7 @@ paths:
summary: Find purchase order by ID
tags:
- store
- x-internal: true
+ x-internal: false
x-accepts:
- application/json
- application/xmlthanks for the contribution. |
wing328
added
Enhancement: General
OpenAPI Normalizer
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.
Fix #22127
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)