Skip to content

fix(core): SpecFilter follows ApiResponse $ref to avoid pruning referenced schemas #4977

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(core): SpecFilter follows ApiResponse $ref to avoid pruning referenced schemas #4977

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5761d47
fix(core): follow ApiResponse $ref in SpecFilter to avoid pruning sch…
kuntal1461 Sep 28, 2025
2920110
Merge branch 'swagger-api:master' into master
kuntal1461 Oct 1, 2025
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
24 changes: 23 additions & 1 deletion 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 @@ -36,6 +36,7 @@

public class SpecFilter {

private OpenAPI _ctxOpenAPI;
public OpenAPI filter(OpenAPI openAPI, OpenAPISpecFilter filter, Map<String, List<String>> params, Map<String, String> cookies, Map<String, List<String>> headers) {
OpenAPI filteredOpenAPI = filterOpenAPI(filter, openAPI, params, cookies, headers);
if (filteredOpenAPI == null) {
Expand Down Expand Up @@ -399,6 +400,26 @@ private void addPathItemSchemaRef(PathItem pathItem, Set<String> referencedDefin
}

private void addApiResponseSchemaRef(ApiResponse response, Set<String> referencedDefinitions) {
if (response == null) return;
String respRef = response.get$ref();
if (respRef != null && !respRef.isEmpty() && _ctxOpenAPI != null) {
String name = (String) RefUtils.extractSimpleName(respRef).getLeft();
referencedDefinitions.add(name);
Components comps = _ctxOpenAPI.getComponents();
ApiResponse resolved = (comps != null && comps.getResponses() != null)
? comps.getResponses().get(name)
: null;
if (resolved != null) {
if (resolved.getHeaders() != null) {
for (Header h : resolved.getHeaders().values()) {
addHeaderSchemaRef(h, referencedDefinitions);
}
}
addContentSchemaRef(resolved.getContent(), referencedDefinitions);
}
return;
}

if (response.getHeaders() != null) {
for (String keyHeaders : response.getHeaders().keySet()) {
Header header = response.getHeaders().get(keyHeaders);
Expand Down Expand Up @@ -469,7 +490,7 @@ private void addComponentsSchemaRef(Components components, Set<String> reference
}

protected OpenAPI removeBrokenReferenceDefinitions(OpenAPI openApi) {

this._ctxOpenAPI = openApi;
if (openApi == null || openApi.getComponents() == null || openApi.getComponents().getSchemas() == null) {
return openApi;
}
Expand Down Expand Up @@ -499,6 +520,7 @@ protected OpenAPI removeBrokenReferenceDefinitions(OpenAPI openApi) {
.retainAll(referencedDefinitions.stream()
.map(s -> (String) RefUtils.extractSimpleName(s).getLeft())
.collect(Collectors.toSet()));
this._ctxOpenAPI = null;
return openApi;
}

Expand Down