Skip to content

Issue #2216 and #2211: Parameter inline with setResolve #2254

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
nicolaideffremo wants to merge 6 commits into
base: master
Choose a base branch
from
+477 −64
Open

Issue #2216 and #2211: Parameter inline with setResolve #2254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
74aa752
test: Add a test to verify faulty ref resolution
nicolaideffremo Nov 13, 2025
8b0438d
fix: Consider PathItem parameters for resolveFully.
nicolaideffremo Nov 26, 2025
649062d
fix: No inlining sideeffect for parameter processing
nicolaideffremo Nov 26, 2025
fd9451e
chore: Address test not testing, according to parser spec behavior
nicolaideffremo Nov 26, 2025
c5ed4cd
add tests
ewaostrowska Apr 23, 2026
528e242
chore: Additional tests to parser spec
nicolaideffremo Oct 8, 2026
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
7 changes: 6 additions & 1 deletion ...s/swagger-parser-v3/src/main/java/io/swagger/v3/parser/processors/ParameterProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ public List<Parameter> processParameters(List<Parameter> parameters) {
}

}

if (processedPathLevelParameters.isEmpty()) {
processedPathLevelParameters.addAll(refParameters);
}

processedPathLevelParameters.forEach(parameter -> {
if (parameter.getSchema() != null) {
schemaProcessor.processSchema(parameter.getSchema());
Expand Down Expand Up @@ -140,7 +145,7 @@ private List<Parameter> processPathLevelParams(List<Parameter> parameters, List<
if (matched) {
refParameters.add(resolvedParameter);
} else {
processedPathLevelParameters.add(resolvedParameter);
processedPathLevelParameters.add(parameter);
}
} else {
processedPathLevelParameters.add(parameter);
Expand Down
52 changes: 32 additions & 20 deletions modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/ResolverFully.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,29 +136,14 @@ public void resolveFully(OpenAPI openAPI) {
}

public void resolvePath(PathItem pathItem){
if (pathItem.getParameters() != null) {
pathItem.setParameters(mapToResolvedParameters(pathItem.getParameters()));
}

for(Operation op : pathItem.readOperations()) {
// inputs
if (op.getParameters() != null) {
for (Parameter parameter : op.getParameters()) {
parameter = parameter.get$ref() != null ? resolveParameter(parameter) : parameter;
if (parameter.getSchema() != null) {
Schema resolved = resolveSchema(parameter.getSchema());
if (resolved != null) {
parameter.setSchema(resolved);
}
}
if(parameter.getContent() != null){
Map<String,MediaType> content = parameter.getContent();
for (String key: content.keySet()){
if (content.get(key) != null && content.get(key).getSchema() != null ){
Schema resolvedSchema = resolveSchema(content.get(key).getSchema());
if (resolvedSchema != null) {
content.get(key).setSchema(resolvedSchema);
}
}
}
}
}
op.setParameters(mapToResolvedParameters(op.getParameters()));
}

if (op.getCallbacks() != null){
Expand Down Expand Up @@ -234,6 +219,33 @@ public void resolvePath(PathItem pathItem){
}
}

private List<Parameter> mapToResolvedParameters(List<Parameter> rawParameters) {
List<Parameter> resolvedParameters = new ArrayList<>();
for (Parameter parameter : rawParameters) {
parameter = parameter.get$ref() != null ? resolveParameter(parameter) : parameter;
if (parameter.getSchema() != null) {
Schema resolved = resolveSchema(parameter.getSchema());
if (resolved != null) {
parameter.setSchema(resolved);
}
}
if (parameter.getContent() != null) {
Map<String, MediaType> content = parameter.getContent();
for (String key : content.keySet()) {
if (content.get(key) != null && content.get(key).getSchema() != null) {
Schema resolvedSchema = resolveSchema(content.get(key).getSchema());
if (resolvedSchema != null) {
content.get(key).setSchema(resolvedSchema);
}
}
}
}
resolvedParameters.add(parameter);
}

return resolvedParameters;
}

private void resolveHeaders(Map<String, Header> headers) {
if (headers == null || headers.isEmpty()) {
return;
Expand Down
7 changes: 7 additions & 0 deletions ...agger-parser-v3/src/test/java/io/swagger/v3/parser/processors/ParameterProcessorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import io.swagger.v3.parser.ResolverCache;
import io.swagger.v3.parser.models.RefFormat;
import mockit.*;
import org.testng.annotations.Ignore;
import org.testng.annotations.Test;


Expand Down Expand Up @@ -109,10 +110,16 @@ public void testProcessParameters_RefToHeader() throws Exception {

final String ref = "#/components/parameters/foo";
Parameter refParameter = new Parameter().$ref(ref);
refParameter.setName("foo");
refParameter.setIn("header");

expectLoadingRefFromCache(ref, RefFormat.INTERNAL, resolvedHeaderParam);
new Expectations() {
{
resolvedHeaderParam.getName();
result = "foo";
resolvedHeaderParam.getIn();
result = "header";
resolvedHeaderParam.getSchema();
result = null;
resolvedHeaderParam.getContent();
Expand Down
20 changes: 15 additions & 5 deletions ...s/swagger-parser-v3/src/test/java/io/swagger/v3/parser/processors/PathsProcessorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import io.swagger.v3.parser.OpenAPIV3Parser;
import io.swagger.v3.parser.core.models.ParseOptions;
import io.swagger.v3.parser.core.models.SwaggerParseResult;
import io.swagger.v3.parser.reference.ReferenceUtils;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;

Expand All @@ -21,6 +22,7 @@
import static org.testng.Assert.assertFalse;
import static org.testng.Assert.assertNotNull;
import static org.testng.Assert.assertNull;
import static org.testng.Assert.assertTrue;

public class PathsProcessorTest {

Expand Down Expand Up @@ -158,8 +160,8 @@ public void testInternalSchemaRefKeepsRootDocumentCompatibility() {
@Test
public void testIssue1948BareOperationParameterRefIsRelativeToExternalPathItem() {
SwaggerParseResult result = parse("issue-1948/openapi.yaml");
Parameter parameter = result.getOpenAPI().getPaths().get("/products/{param1}")
.getGet().getParameters().get(0);
Parameter parameter = componentParameter(result, result.getOpenAPI().getPaths().get("/products/{param1}")
.getGet().getParameters().get(0));

assertParameter(parameter, "param1", "path", "string");
Schema responseSchema = result.getOpenAPI().getPaths().get("/products/{param1}")
Expand All @@ -172,8 +174,8 @@ public void testIssue1948BareOperationParameterRefIsRelativeToExternalPathItem()
@Test
public void testIssue2066DotSlashPathParameterRefIsRelativeToExternalPathItem() {
SwaggerParseResult result = parse("issue-2066/openapi.json");
Parameter parameter = result.getOpenAPI().getPaths().get("/params")
.getGet().getParameters().get(0);
Parameter parameter = componentParameter(result, result.getOpenAPI().getPaths().get("/params")
.getGet().getParameters().get(0));

assertNotNull(parameter);
assertEquals(parameter.getName(), "limit");
Expand Down Expand Up @@ -430,7 +432,15 @@ private SwaggerParseResult parseFully(String location) {
}

private Parameter parameter(SwaggerParseResult result, String path) {
return result.getOpenAPI().getPaths().get(path).getGet().getParameters().get(0);
return componentParameter(result, result.getOpenAPI().getPaths().get(path).getGet().getParameters().get(0));
}

private Parameter componentParameter(SwaggerParseResult result, Parameter parameter) {
assertNotNull(parameter);
String ref = parameter.get$ref();
assertNotNull(ref);
assertTrue(ReferenceUtils.isLocalRefToComponents(ref), "Expected a local parameter ref: " + ref);
return result.getOpenAPI().getComponents().getParameters().get(ReferenceUtils.getRefName(ref));
}

private void assertParameter(Parameter parameter, String name, String in, String schemaType) {
Expand Down
30 changes: 20 additions & 10 deletions modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/FileReferenceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,18 @@


import io.swagger.v3.core.util.Yaml;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.Operation;
import io.swagger.v3.oas.models.PathItem;
import io.swagger.v3.oas.models.media.ArraySchema;
import io.swagger.v3.oas.models.media.ComposedSchema;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.parameters.Parameter;
import io.swagger.v3.parser.OpenAPIV3Parser;
import io.swagger.v3.parser.core.models.ParseOptions;
import io.swagger.v3.parser.core.models.SwaggerParseResult;
import io.swagger.v3.parser.reference.ReferenceUtils;
import org.testng.annotations.Test;

import static org.testng.Assert.*;
Expand Down Expand Up @@ -225,28 +228,35 @@ public void testIssue421() {
assertNotNull(swagger.getPaths().get("/pet/{petId}"));
assertNotNull(swagger.getPaths().get("/pet/{petId}").getGet());
assertNotNull(swagger.getPaths().get("/pet/{petId}").getGet().getParameters());
assertTrue(swagger.getPaths().get("/pet/{petId}").getGet().getParameters().size() == 1);
assertTrue(swagger.getPaths().get("/pet/{petId}").getGet().getParameters().get(0).getName().equals("petId"));
assertEquals(swagger.getPaths().get("/pet/{petId}").getGet().getParameters().size(), 1);

Parameter parameter = swagger.getPaths().get("/pet/{petId}").getGet().getParameters().get(0);
String refName = ReferenceUtils.getRefName(parameter.get$ref());
Components components = result.getOpenAPI().getComponents();
Parameter refParam = components.getParameters().get(refName);

assertEquals(refParam.getName(), "petId");

assertTrue(swagger.getComponents().getSchemas().get("Pet") instanceof Schema);
assertTrue(swagger.getComponents().getSchemas().get("Pet").getProperties().size() == 6);
assertEquals(swagger.getComponents().getSchemas().get("Pet").getProperties().size(), 6);

assertNotNull(swagger.getPaths().get("/pet/{petId}").getPost());
assertNotNull(swagger.getPaths().get("/pet/{petId}").getPost().getParameters());
assertTrue(swagger.getPaths().get("/pet/{petId}").getPost().getParameters().size() == 1);
assertTrue(swagger.getPaths().get("/pet/{petId}").getPost().getRequestBody() != null);
assertTrue(swagger.getPaths().get("/pet/{petId}").getPost().getRequestBody().get$ref() != null);
assertEquals(swagger.getPaths().get("/pet/{petId}").getPost().getParameters().size(), 1);
assertNotNull(swagger.getPaths().get("/pet/{petId}").getPost().getRequestBody());
assertNotNull(swagger.getPaths().get("/pet/{petId}").getPost().getRequestBody().get$ref());
assertEquals(swagger.getPaths().get("/pet/{petId}").getPost().getRequestBody().get$ref(),"#/components/requestBodies/requestBody");
assertTrue(swagger.getPaths().get("/pet/{petId}").getPost().getRequestBody().get$ref().equals("#/components/requestBodies/requestBody"));
assertEquals(swagger.getPaths().get("/pet/{petId}").getPost().getRequestBody().get$ref(), "#/components/requestBodies/requestBody");

assertNotNull(swagger.getPaths().get("/store/order"));
assertNotNull(swagger.getPaths().get("/store/order").getPost());
assertNotNull(swagger.getPaths().get("/store/order").getPost().getRequestBody());
assertNotNull(swagger.getPaths().get("/store/order").getPost().getRequestBody().getContent().get("application/json").getSchema());
assertTrue(swagger.getPaths().get("/store/order").getPost().getRequestBody().getContent().get("application/json").getSchema().get$ref() != null);
assertTrue(swagger.getPaths().get("/store/order").getPost().getRequestBody().getContent().get("application/json").getSchema().get$ref().equals("#/components/schemas/Order"));
assertNotNull(swagger.getPaths().get("/store/order").getPost().getRequestBody().getContent().get("application/json").getSchema().get$ref());
assertEquals(swagger.getPaths().get("/store/order").getPost().getRequestBody().getContent().get("application/json").getSchema().get$ref(), "#/components/schemas/Order");

assertTrue(swagger.getComponents().getSchemas().get("Order") instanceof Schema);
assertTrue(swagger.getComponents().getSchemas().get("Order").getProperties().size() == 6);
assertEquals(swagger.getComponents().getSchemas().get("Order").getProperties().size(), 6);
}

@Test
Expand Down
15 changes: 9 additions & 6 deletions modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/Issue2055Test.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,13 @@ public void externalParametersWithSameNameKeepBothDefinitions() {
Operation post = openAPI.getPaths().get("/a-path").getPost();
Operation put = openAPI.getPaths().get("/a-path").getPut();

assertEquals(post.getParameters().get(0).getDescription(), "There can be only 1");
assertEquals(put.getParameters().get(0).getDescription(), "There can be only 2");

Map<String, Parameter> parameters = openAPI.getComponents().getParameters();
Parameter postParameter = assertLocalRefResolves(post.getParameters().get(0).get$ref(), "parameters", parameters);
Parameter putParameter = assertLocalRefResolves(put.getParameters().get(0).get$ref(), "parameters", parameters);

assertEquals(postParameter.getDescription(), "There can be only 1");
assertEquals(putParameter.getDescription(), "There can be only 2");

assertEquals(parameters.size(), 10);
assertTrue(parameters.keySet().containsAll(Arrays.asList("limit", "limit_1")));
assertTrue(parameters.values().stream()
Expand All @@ -63,15 +66,15 @@ public void externalParametersWithSameNameKeepBothDefinitionsForEveryLocation(
OpenAPI openAPI = parse();
Operation post = openAPI.getPaths().get("/parameter-types/{pathParam}").getPost();
Operation put = openAPI.getPaths().get("/parameter-types/{pathParam}").getPut();
Parameter first = post.getParameters().get(parameterIndex);
Parameter second = put.getParameters().get(parameterIndex);
Map<String, Parameter> parameters = openAPI.getComponents().getParameters();
Parameter first = assertLocalRefResolves(post.getParameters().get(parameterIndex).get$ref(), "parameters", parameters);
Parameter second = assertLocalRefResolves(put.getParameters().get(parameterIndex).get$ref(), "parameters", parameters);

assertEquals(first.getIn(), location);
assertEquals(second.getIn(), location);
assertEquals(first.getDescription(), location + " parameter from file one");
assertEquals(second.getDescription(), location + " parameter from file two");

Map<String, Parameter> parameters = openAPI.getComponents().getParameters();
assertTrue(parameters.keySet().containsAll(Arrays.asList(componentBaseName, componentBaseName + "_1")));
assertTrue(parameters.values().stream()
.anyMatch(parameter -> (location + " parameter from file one").equals(parameter.getDescription())));
Expand Down
10 changes: 8 additions & 2 deletions modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/NetworkReferenceTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.swagger.v3.parser.test;


import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.PathItem;
import io.swagger.v3.oas.models.media.Schema;
Expand All @@ -11,6 +12,7 @@
import io.swagger.v3.parser.core.models.AuthorizationValue;
import io.swagger.v3.parser.core.models.ParseOptions;
import io.swagger.v3.parser.core.models.SwaggerParseResult;
import io.swagger.v3.parser.reference.ReferenceUtils;
import io.swagger.v3.parser.urlresolver.PermittedUrlsChecker;
import io.swagger.v3.parser.util.RemoteUrl;
import mockit.Expectations;
Expand Down Expand Up @@ -288,8 +290,12 @@ public void testIssue411() throws Exception {
assertNotNull(swagger.getComponents().getSchemas().get("Success"));

Parameter param = swagger.getPaths().get("/stuff").getGet().getParameters().get(0);
assertEquals(param.getIn(), "query");
assertEquals(param.getName(), "skip");
String refName = ReferenceUtils.getRefName(param.get$ref());
Components components = result.getOpenAPI().getComponents();
Parameter refParam = components.getParameters().get(refName);

assertEquals(refParam.getIn(), "query");
assertEquals(refParam.getName(), "skip");

ApiResponse response = swagger.getPaths().get("/stuff").getGet().getResponses().get("200");
assertNotNull(response);
Expand Down
Loading