Skip to content

Commit 583fe78

Browse files
gracekarinagracekarina
authored
Merge pull request #850 from swagger-api/issue-relative-refs-OAS2
fix issue relative refs items and properties
2 parents 3ff3d03 + ecf6800 commit 583fe78

File tree

10 files changed

+332
-0
lines changed

10 files changed

+332
-0
lines changed

‎modules/swagger-parser/src/main/java/io/swagger/parser/processors/ExternalRefProcessor.java

+7
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import io.swagger.models.*;
44
import io.swagger.models.properties.ArrayProperty;
55
import io.swagger.models.properties.MapProperty;
6+
import io.swagger.models.properties.ObjectProperty;
67
import io.swagger.models.properties.Property;
78
import io.swagger.models.properties.RefProperty;
89
import io.swagger.models.refs.RefFormat;
@@ -218,6 +219,12 @@ private void processProperties(final Map<String, Property> subProps, final Strin
218219
if (arrayProp.getItems() instanceof RefProperty) {
219220
processRefProperty((RefProperty) arrayProp.getItems(), file);
220221
}
222+
if (arrayProp.getItems() != null){
223+
if (arrayProp.getItems() instanceof ObjectProperty) {
224+
ObjectProperty objectProperty = (ObjectProperty) arrayProp.getItems();
225+
processProperties(objectProperty.getProperties(), file);
226+
}
227+
}
221228
} else if (prop.getValue() instanceof MapProperty) {
222229
MapProperty mapProp = (MapProperty) prop.getValue();
223230
if (mapProp.getAdditionalProperties() instanceof RefProperty) {

‎modules/swagger-parser/src/test/java/io/swagger/parser/SwaggerParserTest.java

+14
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
import io.swagger.models.properties.ByteArrayProperty;
2626
import io.swagger.models.properties.IntegerProperty;
2727
import io.swagger.models.properties.MapProperty;
28+
import io.swagger.models.properties.ObjectProperty;
2829
import io.swagger.models.properties.Property;
2930
import io.swagger.models.properties.RefProperty;
3031
import io.swagger.models.properties.StringProperty;
@@ -54,6 +55,19 @@
5455

5556
public class SwaggerParserTest {
5657

58+
@Test
59+
public void testIssueRelativeRefs2(){
60+
String location = "exampleSpecs/specs/my-domain/test-api/v1/test-api-swagger_v1.json";
61+
Swagger swagger = new SwaggerParser().read(location, null, true);
62+
assertNotNull(swagger);
63+
Map<String, Model> definitions = swagger.getDefinitions();
64+
Assert.assertTrue(definitions.get("confirmMessageType_v01").getProperties().get("resources") instanceof ArrayProperty);
65+
ArrayProperty arraySchema = (ArrayProperty) definitions.get("confirmMessageType_v01").getProperties().get("resources");
66+
ObjectProperty prop = (ObjectProperty) arraySchema.getItems();
67+
RefProperty refProperty = (RefProperty) prop.getProperties().get("resourceID");
68+
assertEquals(refProperty.get$ref(),"#/definitions/simpleIDType_v01");
69+
}
70+
5771
@Test
5872
public void testIssue845() {
5973
SwaggerDeserializationResult swaggerDeserializationResult = new SwaggerParser().readWithInfo("");

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/common/confirmMessageType_v01.json

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"description": "",
3+
"type": "object",
4+
"properties": {
5+
"confirmMessageID": {
6+
"description": "",
7+
"$ref": "./simpleIDType_v01.json"
8+
},
9+
"processID": {
10+
"description": "",
11+
"$ref": "./simpleIDType_v01.json"
12+
},
13+
"processStatus": {
14+
"description": "",
15+
"type": "string",
16+
"enum": [
17+
"success", "partial-failure", "failure"
18+
]
19+
},
20+
"resources": {
21+
"type": "array",
22+
"items": {
23+
"type": "object",
24+
"properties": {
25+
"resourceID": {
26+
"description": "",
27+
"$ref": "./simpleIDType_v01.json"
28+
},
29+
"resourceReference": {
30+
"description": "",
31+
"type": "string"
32+
},
33+
"resourceStatus": {
34+
"description": "",
35+
"type": "string",
36+
"enum": [
37+
"success", "partial-failure", "failure"
38+
]
39+
}
40+
}
41+
}
42+
},
43+
"links": {
44+
"type": "array",
45+
"items": {
46+
"$ref": "./linkType_v01.json"
47+
}
48+
}
49+
}
50+
}

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/common/confirmMessageType_v02.json

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"description": "",
3+
"type": "object",
4+
"properties": {
5+
"confirmMessageID": {
6+
"description": "",
7+
"$ref": "./simpleIDType_v01.json"
8+
},
9+
"processID": {
10+
"description": "",
11+
"$ref": "./simpleIDType_v01.json"
12+
},
13+
"processStatus": {
14+
"description": "",
15+
"type": "string",
16+
"enum": [
17+
"success", "partial-failure", "failure"
18+
]
19+
},
20+
"resources": {
21+
"type": "array",
22+
"items": {
23+
"type": "object",
24+
"properties": {
25+
"resourceID": {
26+
"description": "",
27+
"$ref": "./simpleIDType_v01.json"
28+
},
29+
"resourceReference": {
30+
"description": "",
31+
"type": "string"
32+
},
33+
"resourceStatus": {
34+
"description": "",
35+
"type": "string",
36+
"enum": [
37+
"success", "partial-failure", "failure"
38+
]
39+
}
40+
}
41+
}
42+
},
43+
"links": {
44+
"type": "array",
45+
"items": {
46+
"$ref": "./linkType_v01.json"
47+
}
48+
}
49+
}
50+
}

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/common/dateType_v01.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"title": "date",
3+
"description": "The string representation",
4+
"type": "string",
5+
"format": "date"
6+
}

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/common/linkType_v01.json

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"title": "link",
3+
"description": "A link description object",
4+
"type": "object",
5+
"properties": {
6+
"href": {
7+
"$ref": "./simpleIDType_v01.json"
8+
},
9+
"mediaType": {
10+
"description": "media type description",
11+
"type": "string",
12+
"enum": [
13+
"application/gzip",
14+
"application/json",
15+
"application/msword",
16+
"application/pdf",
17+
"application/postscript",
18+
"application/vnd.ms-excel",
19+
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
20+
"application/vnd.openxmlformats-officedocument.wordprocessingml.document",
21+
"application/xml",
22+
"application/x-www-form-urlencoded",
23+
"image/gif",
24+
"image/jpeg",
25+
"image/png",
26+
"image/tiff",
27+
"multipart/mixed",
28+
"text/html",
29+
"text/plain",
30+
"application/vnd.visio",
31+
"image/bmp",
32+
"application/vnd.openxmlformats-officedocument.presentationml.presentation",
33+
"application/vnd.ms-powerpoint",
34+
"video/mp4",
35+
"audio/mpeg",
36+
"video/x-msvideo",
37+
"video/x-ms-wmv",
38+
"application/rtf",
39+
"application/vnd.ms-outlook",
40+
"text/csv",
41+
"video/quicktime",
42+
"application/zip",
43+
"application/illustrator",
44+
"text/xml"
45+
]
46+
},
47+
"payloadArguments": {
48+
"type": "array",
49+
"items": {
50+
"type": "object",
51+
"properties": {
52+
"argumentPath": {
53+
"description": "payloadArguments",
54+
"type": "string"
55+
},
56+
"argumentValue": {
57+
"description": "payloadArguments",
58+
"type": "string"
59+
}
60+
}
61+
}
62+
}
63+
}
64+
}

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/common/simpleIDType_v01.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"$schema": "http://json-schema.org/draft-04/schema#",
3+
"title": "simpleID",
4+
"description": "Simple (string) identifier of an object to be used when there is no appropriate specific named ID Type",
5+
"type": "string",
6+
"pattern": "^[a-zA-Z0-9.$-_\/]+$"
7+
}

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/my-domain/test-api/v1/schemas/test-api-schema_v01.json

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"description": "Description",
3+
"type": "object",
4+
"properties": {
5+
"testingApi": {
6+
"type": "array",
7+
"items": {
8+
"title": "testingApi",
9+
"type": "object",
10+
"properties": {
11+
"itemID": {
12+
"$ref": "../../../../common/simpleIDType_v01.json"
13+
},
14+
"testLink": {
15+
"type": "array",
16+
"items": {
17+
"$ref": "../../../../common/linkType_v01.json"
18+
}
19+
}
20+
},
21+
"additionalProperties": false
22+
}
23+
},
24+
"_confirmMessage": {
25+
"$ref": "../../../../common/confirmMessageType_v01.json"
26+
}
27+
}
28+
}

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/my-domain/test-api/v1/schemas/test-api-schema_v02.json

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"description": "Test Description",
3+
"type": "object",
4+
"properties": {
5+
"testingApi": {
6+
"type": "array",
7+
"items": {
8+
"title": "testingApi",
9+
"type": "object",
10+
"properties": {
11+
"itemID": {
12+
"$ref": "../../../../common/simpleIDType_v01.json"
13+
},
14+
"testLink": {
15+
"type": "array",
16+
"items": {
17+
"$ref": "../../../../common/linkType_v01.json"
18+
}
19+
}
20+
},
21+
"additionalProperties": false
22+
}
23+
},
24+
"_confirmMessage": {
25+
"$ref": "../../../../common/confirmMessageType_v02.json"
26+
}
27+
}
28+
}

‎modules/swagger-parser/src/test/resources/exampleSpecs/specs/my-domain/test-api/v1/test-api-swagger_v1.json

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"description": "APIs to retrieve some data",
5+
"version": "1.0",
6+
"title": "TEST A NEW API",
7+
"contact": {
8+
"name": "mine",
9+
"email": "[email protected]"
10+
}
11+
},
12+
"tags": [
13+
{
14+
"name": "Test",
15+
"description": "APIs to retrieve some data"
16+
}
17+
],
18+
"paths": {
19+
"/my-domain/v1/test-system": {
20+
"get": {
21+
"description": "Retrieve relevant data",
22+
"tags": [
23+
"Test"
24+
],
25+
"summary": "Retrieve relevant data",
26+
"responses": {
27+
"200": {
28+
"description": "Request was successful",
29+
"headers": {
30+
},
31+
"schema": {
32+
"$ref": "./schemas/test-api-schema_v02.json"
33+
}
34+
},
35+
"400": {
36+
"$ref": "#/responses/400"
37+
}
38+
}
39+
}
40+
}
41+
},
42+
"definitions": {
43+
},
44+
"responses": {
45+
"200": {
46+
"description": "OK",
47+
"headers": {
48+
}
49+
},
50+
"400": {
51+
"description": "Bad Request",
52+
"headers": {
53+
},
54+
"schema": {
55+
"$ref": "../../../common/confirmMessageType_v01.json"
56+
}
57+
}
58+
},
59+
"parameters": {
60+
"asOfDate": {
61+
"name": "asOfDate",
62+
"in": "query",
63+
"description": "date",
64+
"required": false,
65+
"example": "2017-01-01"
66+
},
67+
"header_Accept-Language": {
68+
"name": "Accept-Language",
69+
"in": "header",
70+
"description": "Accept-Language",
71+
"required": false,
72+
"schema": {
73+
"type": "string"
74+
}
75+
}
76+
}
77+
78+
}

0 commit comments

Comments
 (0)