Skip to content

$ref name conflicts for OAS 3 #591

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

Merged
merged 2 commits into from
Nov 22, 2017
Merged

$ref name conflicts for OAS 3 #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3a07c0
Handle external and local refs with the same name. The external ref w…
joeljons Nov 22, 2017
a2d1f04
Fix tests after avoiding duplicate ref names.
joeljons Nov 22, 2017
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
63 changes: 54 additions & 9 deletions ...swagger-parser-v3/src/main/java/io/swagger/v3/parser/processors/ExternalRefProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ public ExternalRefProcessor(ResolverCache cache, OpenAPI openAPI) {
}

public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final Schema schema = cache.loadRef($ref, refFormat, Schema.class);

if(schema == null) {
Expand All @@ -52,7 +57,7 @@ public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
schemas = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, schemas.keySet());

Schema existingModel = schemas.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -111,6 +116,11 @@ public String processRefToExternalSchema(String $ref, RefFormat refFormat) {
}

public String processRefToExternalResponse(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final ApiResponse response = cache.loadRef($ref, refFormat, ApiResponse.class);

if(response == null) {
Expand All @@ -127,7 +137,7 @@ public String processRefToExternalResponse(String $ref, RefFormat refFormat) {
responses = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, responses.keySet());

ApiResponse existingResponse = responses.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -161,6 +171,11 @@ public String processRefToExternalResponse(String $ref, RefFormat refFormat) {
}

public String processRefToExternalRequestBody(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final RequestBody body = cache.loadRef($ref, refFormat, RequestBody.class);

if(body == null) {
Expand All @@ -177,7 +192,7 @@ public String processRefToExternalRequestBody(String $ref, RefFormat refFormat)
bodies = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, bodies.keySet());

RequestBody existingBody= bodies.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -211,6 +226,11 @@ public String processRefToExternalRequestBody(String $ref, RefFormat refFormat)
}

public String processRefToExternalHeader(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final Header header = cache.loadRef($ref, refFormat, Header.class);

if(header == null) {
Expand All @@ -227,7 +247,7 @@ public String processRefToExternalHeader(String $ref, RefFormat refFormat) {
headers = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, headers.keySet());

Header existingHeader = headers.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -261,6 +281,11 @@ public String processRefToExternalHeader(String $ref, RefFormat refFormat) {
}

public String processRefToExternalSecurityScheme(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final SecurityScheme securityScheme = cache.loadRef($ref, refFormat, SecurityScheme.class);

if(securityScheme == null) {
Expand All @@ -277,7 +302,7 @@ public String processRefToExternalSecurityScheme(String $ref, RefFormat refForma
securitySchemeMap = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, securitySchemeMap.keySet());

SecurityScheme existingSecurityScheme = securitySchemeMap.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -311,6 +336,11 @@ public String processRefToExternalSecurityScheme(String $ref, RefFormat refForma
}

public String processRefToExternalLink(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final Link link = cache.loadRef($ref, refFormat, Link.class);

if(link == null) {
Expand All @@ -327,7 +357,7 @@ public String processRefToExternalLink(String $ref, RefFormat refFormat) {
links = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, links.keySet());

Link existingLink = links.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -361,6 +391,11 @@ public String processRefToExternalLink(String $ref, RefFormat refFormat) {
}

public String processRefToExternalExample(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final Example example = cache.loadRef($ref, refFormat, Example.class);

if(example == null) {
Expand All @@ -377,7 +412,7 @@ public String processRefToExternalExample(String $ref, RefFormat refFormat) {
examples = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, examples.keySet());

Example existingExample = examples.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -411,6 +446,11 @@ public String processRefToExternalExample(String $ref, RefFormat refFormat) {
}

public String processRefToExternalParameter(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final Parameter parameter = cache.loadRef($ref, refFormat, Parameter.class);

if(parameter == null) {
Expand All @@ -427,7 +467,7 @@ public String processRefToExternalParameter(String $ref, RefFormat refFormat) {
parameters = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, parameters.keySet());

Parameter existingParameters = parameters.get(possiblyConflictingDefinitionName);

Expand Down Expand Up @@ -461,6 +501,11 @@ public String processRefToExternalParameter(String $ref, RefFormat refFormat) {
}

public String processRefToExternalCallback(String $ref, RefFormat refFormat) {
String renamedRef = cache.getRenamedRef($ref);
if(renamedRef != null) {
return renamedRef;
}

final Callback callback = cache.loadRef($ref, refFormat, Callback.class);

if(callback == null) {
Expand All @@ -477,7 +522,7 @@ public String processRefToExternalCallback(String $ref, RefFormat refFormat) {
callbacks = new LinkedHashMap<>();
}

final String possiblyConflictingDefinitionName = computeDefinitionName($ref);
final String possiblyConflictingDefinitionName = computeDefinitionName($ref, callback.keySet());

Callback existingCallback = callbacks.get(possiblyConflictingDefinitionName);

Expand Down
10 changes: 8 additions & 2 deletions modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/RefUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Set;

public class RefUtils {

public static String computeDefinitionName(String ref) {
public static String computeDefinitionName(String ref, Set<String> reserved) {

final String[] refParts = ref.split("#/");

Expand All @@ -38,8 +39,13 @@ public static String computeDefinitionName(String ref) {
final String[] split = plausibleName.split("\\.");
plausibleName = split[0];
}
String tryName = plausibleName;

return plausibleName;
for (int i = 2; reserved.contains(tryName); i++) {
tryName = plausibleName + "_" + i;
}

return tryName;
}

public static boolean isAnExternalRefFormat(RefFormat refFormat) {
Expand Down
20 changes: 17 additions & 3 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 @@ -33,6 +33,7 @@
import org.apache.commons.io.FileUtils;
import org.testng.Assert;

import org.testng.AssertJUnit;
import org.testng.annotations.AfterClass;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
Expand Down Expand Up @@ -187,7 +188,7 @@ public void componentsResolver(@Injectable final List<AuthorizationValue> auths)

//remote url schema
Schema user = (Schema) pet.getProperties().get("user");
assertEquals(user.get$ref(),"#/components/schemas/User");
assertEquals(user.get$ref(),"#/components/schemas/User_3");


//ArraySchema items
Expand All @@ -200,7 +201,7 @@ public void componentsResolver(@Injectable final List<AuthorizationValue> auths)
assertEquals(schemas.get("OrderRef").getNot().get$ref(), "#/components/schemas/Category");

//Schema additionalProperties
assertEquals(schemas.get("OrderRef").getAdditionalProperties().get$ref(), "#/components/schemas/User");
assertEquals(schemas.get("OrderRef").getAdditionalProperties().get$ref(), "#/components/schemas/User_3");

//AllOfSchema
ComposedSchema extended = (ComposedSchema) schemas.get("ExtendedErrorModel");
Expand Down Expand Up @@ -265,7 +266,7 @@ public void componentsResolver(@Injectable final List<AuthorizationValue> auths)
//internal Schema header
Map<String, Header> headers = openAPI.getComponents().getHeaders();
//header remote schema ref
assertEquals(headers.get("X-Rate-Limit-Remaining").getSchema().get$ref(),"#/components/schemas/User");
assertEquals(headers.get("X-Rate-Limit-Remaining").getSchema().get$ref(),"#/components/schemas/User_3");

//header examples
assertEquals(headers.get("X-Rate-Limit-Reset").getExamples().get("headerExample").get$ref(), "#/components/examples/dog" );
Expand Down Expand Up @@ -603,6 +604,19 @@ public void resolveComposedSchema(@Injectable final List<AuthorizationValue> aut

}

@Test
public void testRefNameConflicts() throws Exception {
ParseOptions options = new ParseOptions();
options.setResolveFully(true);
OpenAPI openAPI = new OpenAPIV3Parser().readLocation("src/test/resources/refs-name-conflict/a.yaml",null, options).getOpenAPI();

AssertJUnit.assertEquals("local", ((Schema) openAPI.getPaths().get("/newPerson").getPost().getResponses().get("200").getContent().get("*/*").getSchema().getProperties().get("location")).getExample());
AssertJUnit.assertEquals("referred", ((Schema)openAPI.getPaths().get("/oldPerson").getPost().getResponses().get("200").getContent().get("*/*").getSchema().getProperties().get("location")).getExample());
AssertJUnit.assertEquals("referred", ((Schema)openAPI.getPaths().get("/yetAnotherPerson").getPost().getResponses().get("200").getContent().get("*/*").getSchema().getProperties().get("location")).getExample());
AssertJUnit.assertEquals("local", ((Schema) openAPI.getComponents().getSchemas().get("PersonObj").getProperties().get("location")).getExample());
AssertJUnit.assertEquals("referred", ((Schema) openAPI.getComponents().getSchemas().get("PersonObj_2").getProperties().get("location")).getExample());
}

private static int getDynamicPort() {
return new Random().ints(50000, 60000).findFirst().getAsInt();
}
Expand Down
47 changes: 47 additions & 0 deletions modules/swagger-parser-v3/src/test/resources/refs-name-conflict/a.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
openapi: 3.0.0
servers: []
info:
version: 1.0.0
title: Person
description: Maintain Person data
paths:
/newPerson:
post:
summary: Create new person
description: Create new person
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/PersonObj'
/oldPerson:
post:
summary: Create old person
description: Create old person
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: './src/test/resources/refs-name-conflict/b.yaml#/components/schemas/PersonObj'
/yetAnotherPerson:
post:
summary: Create yet another person
description: Create yet another person
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: './src/test/resources/refs-name-conflict/b.yaml#/components/schemas/PersonObj'
components:
schemas:
PersonObj:
properties:
location:
type: string
example: local
13 changes: 13 additions & 0 deletions modules/swagger-parser-v3/src/test/resources/refs-name-conflict/b.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
openapi: 3.0.0
servers: []
info:
version: ''
title: ''
paths: {}
components:
schemas:
PersonObj:
properties:
location:
type: string
example: referred