Skip to content
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.

Sign up for GitHub

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

Bugfix for filtering nested $refs #3304

Closed
wants to merge 1 commit into from
Closed

Bugfix for filtering nested $refs #3304

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 29 additions & 15 deletions modules/swagger-core/src/main/java/io/swagger/v3/core/filter/SpecFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,25 +391,39 @@ protected OpenAPI removeBrokenReferenceDefinitions(OpenAPI openApi) {
addPathItemSchemaRef(pathItem, referencedDefinitions);
}
}

Set<String> nestedReferencedDefinitions = new TreeSet<>();
for (String ref : referencedDefinitions) {
locateReferencedDefinitions(ref, nestedReferencedDefinitions, openApi);
}
referencedDefinitions.addAll(nestedReferencedDefinitions);
openApi.getComponents().getSchemas().keySet().retainAll(referencedDefinitions.stream().map(s -> (String) RefUtils.extractSimpleName(s).getLeft()).collect(Collectors.toSet()));

referencedDefinitions.addAll(resolveAllNestededRefs(referencedDefinitions, referencedDefinitions, openApi));
openApi.getComponents()
.getSchemas()
.keySet()
.retainAll(referencedDefinitions.stream()
.map(s -> (String) RefUtils.extractSimpleName(s).getLeft())
.collect(Collectors.toSet()));
return openApi;
}

protected Set<String> resolveAllNestededRefs(Set<String> refs, OpenAPI openApi) {
Set<String> justDiscoveredReferencedDefinitions = new TreeSet<>();
for (String ref : refs) {
locateReferencedDefinitions(ref, justDiscoveredReferencedDefinitions, openApi);
}
// Base case - no new references have been discovered. Halt discovery to avoid infinite loops
if (refs.containsAll(justDiscoveredReferencedDefinitions)) {
return Collections.emptySet();
} else {
// Remove all refs that have already been discovered.
justDiscoveredReferencedDefinitions.removeAll(refs);
refs.addAll(justDiscoveredReferencedDefinitions);
return resolveAllNestededRefs(justDiscoveredReferencedDefinitions, openApi);
}
}

protected void locateReferencedDefinitions(String ref, Set<String> nestedReferencedDefinitions, OpenAPI openAPI) {
// if not already processed so as to avoid infinite loops
if (!nestedReferencedDefinitions.contains(ref)) {
nestedReferencedDefinitions.add(ref);
String simpleName = (String) RefUtils.extractSimpleName(ref).getLeft();
Schema model = openAPI.getComponents().getSchemas().get(simpleName);
if (model != null) {
addSchemaRef(model, nestedReferencedDefinitions);
}
nestedReferencedDefinitions.add(ref);
String simpleName = (String) RefUtils.extractSimpleName(ref).getLeft();
Schema model = openAPI.getComponents().getSchemas().get(simpleName);
if (model != null) {
addSchemaRef(model, nestedReferencedDefinitions);
}
}
}