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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b61834f
test: Add a test to verify faulty ref resolution
nicolaideffremo Nov 13, 2025
d3defc9
fix: Consider PathItem parameters for resolveFully.
nicolaideffremo Nov 26, 2025
2d42f0c
fix: No inlining sideeffect for parameter processing
nicolaideffremo Nov 26, 2025
99f5b3e
chore: Address test not testing, according to parser spec behavior
nicolaideffremo Nov 26, 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
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 @@ -134,29 +134,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 @@ -232,6 +217,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
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 @@ -3,15 +3,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 @@ -226,28 +229,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
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
77 changes: 71 additions & 6 deletions modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIResolverTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
import io.swagger.v3.parser.reference.DereferencerContext;
import io.swagger.v3.parser.reference.DereferencersFactory;
import io.swagger.v3.parser.reference.OpenAPIDereferencer;
import io.swagger.v3.parser.reference.ReferenceUtils;
import io.swagger.v3.parser.util.OpenAPIDeserializer;
import io.swagger.v3.parser.util.ResolverFully;
import org.apache.commons.io.FileUtils;
Expand Down Expand Up @@ -563,7 +564,11 @@ public void pathsResolver() throws Exception {
assertEquals(id.get$ref(),"#/components/schemas/Pet");

//internal parameter url
assertEquals(openAPI.getPaths().get("/store/inventory").getGet().getParameters().get(0), openAPI.getComponents().getParameters().get("limitParam"));
Parameter inventoryParam = openAPI.getPaths().get("/store/inventory").getGet().getParameters().get(0);
String refName = ReferenceUtils.getRefName(inventoryParam.get$ref());
assertEquals(refName, "limitParam");
Components components = openAPI.getComponents();
assertEquals(components.getParameters().get(refName).getName(), "limit");
}

@Test
Expand Down Expand Up @@ -657,6 +662,60 @@ public void testIssue85() {
assertTrue(prop instanceof Schema);
}

@Test
void testIssue2211() {
// given
String yaml =
" openapi: 3.0.3\n" +
" info:\n" +
" title: technical-definitions\n" +
" description: Commons technical definitions\n" +
" version: 1.0.0\n" +
" paths:\n" +
" /components/parameter:\n" +
" get:\n" +
" tags:\n" +
" - example\n" +
" operationId: getExampleById4\n" +
" parameters:\n" +
" - $ref: '#/components/parameters/Parameter'\n" +
" responses:\n" +
" '200':\n" +
" description: Successful response\n" +
" content:\n" +
" application/json:\n" +
" schema:\n" +
" type: object\n" +
" properties:\n" +
" message:\n" +
" type: string\n" +
" example: Success\n" +
" components:\n" +
" parameters:\n" +
" Parameter:\n" +
" name: id\n" +
" in: query\n" +
" description: The ID of the example to retrieve\n" +
" required: true\n" +
" style: form\n" +
" explode: true\n" +
" schema:\n" +
" type: string\n" +
"\n";

ParseOptions options = new ParseOptions();
options.setResolve(true);

// when
SwaggerParseResult parseResult = new OpenAPIV3Parser().readContents(yaml, auths, options);

OpenAPI openAPI = parseResult.getOpenAPI();

// then
assertNotNull(openAPI);
assertEquals(openAPI.getPaths().get("/components/parameter").getGet().getParameters().get(0).get$ref(), "#/components/parameters/Parameter");
}

@Test
public void testIssue1352() {
ParseOptions options = new ParseOptions();
Expand Down Expand Up @@ -1178,7 +1237,9 @@ public void testOperationParameterRemoteRefs() {
final List<Parameter> params = swagger.getPaths().get("/fun").getGet().getParameters();
assertEquals(params.size(), 1);
final Parameter param = params.get(0);
assertEquals(param.getName(), "skip");
String refName = ReferenceUtils.getRefName(param.get$ref());
Components components = swagger.getComponents();
assertEquals(components.getParameters().get(refName).getName(), "skip");
}


Expand All @@ -1203,7 +1264,9 @@ public void testOperationBodyParameterRemoteRefs() {
final List<Parameter> params = swagger.getPaths().get("/fun").getGet().getParameters();
assertEquals(params.size(), 1);
final Parameter param = params.get(0);
assertEquals(param.getName(), "skip");
String refName = ReferenceUtils.getRefName(param.get$ref());
Components components = swagger.getComponents();
assertEquals(components.getParameters().get(refName).getName(), "skip");
}

private void testResponseRemoteRefs(String remoteRef) {
Expand Down Expand Up @@ -1338,8 +1401,10 @@ public void testIssue291() {


Parameter param = resolved.getPaths().get("/test").getGet().getParameters().get(0);
QueryParameter qp = (QueryParameter) param;
//assertEquals(qp.getCollectionFormat(), "csv");
String refName = ReferenceUtils.getRefName(param.get$ref());
Components components = resolved.getComponents();
QueryParameter refParameter = (QueryParameter) components.getParameters().get(refName);
assertEquals(refParameter.getName(), "test");
}

@Test
Expand Down Expand Up @@ -1500,5 +1565,5 @@ public Object[][] explicitObjectSchemaProvider() {
{ false }
};
}

}
Loading