Skip to content

Commit ebfd7f0

Browse files
gracekarinagracekarina
authored
Merge branch 'master' into issue1086
2 parents f1d3db2 + 974cd15 commit ebfd7f0

File tree

13 files changed

+257
-7
lines changed

13 files changed

+257
-7
lines changed

‎README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
[![Build Status](https://img.shields.io/jenkins/s/https/jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2.svg)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2)
66

7+
[![Build Status](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2/badge/icon?subject=jenkins%20build%20-%20java%208)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2/)
8+
9+
[![Build Status](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2-java9/badge/icon?subject=jenkins%20build%20-%20java%209)](https://jenkins.swagger.io/view/OSS%20-%20Java/job/oss-swagger-parser-v2-java9/)
10+
711
## Overview
812
This is the Swagger Parser project, which reads OpenAPI definitions into current Java POJOs. It also provides a simple framework to add additional converters from different formats into the Swagger objects, making the entire toolchain available.
913

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

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,25 @@ public List<Parameter> processParameters(List<Parameter> parameters) {
161161
}
162162

163163
}
164+
else if(parameter.getContent() != null){
165+
Map<String,MediaType> content = parameter.getContent();
166+
for( String mediaName : content.keySet()) {
167+
MediaType mediaType = content.get(mediaName);
168+
if(mediaType.getSchema()!= null) {
169+
schema = mediaType.getSchema();
170+
if (schema != null) {
171+
schemaProcessor.processSchema(schema);
172+
}
173+
}
174+
if(mediaType.getExamples() != null) {
175+
for(Example ex: mediaType.getExamples().values()){
176+
exampleProcessor.processExample(ex);
177+
}
178+
}
179+
}
180+
}
164181
}
165182

166183
return processedPathLevelParameters;
167184
}
168-
}
185+
}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,12 @@ protected void updateLocalRefs(RequestBody body, String pathRef) {
225225
if (mediaType.getSchema() != null) {
226226
updateLocalRefs(mediaType.getSchema(), pathRef);
227227
}
228+
Map<String, Example> examples = content.get(key).getExamples();
229+
if (examples != null) {
230+
for (Example example : examples.values()) {
231+
updateLocalRefs(example, pathRef);
232+
}
233+
}
228234
}
229235
}else if(body.get$ref() != null){
230236

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package io.swagger.v3.parser.processors;
22

33
import io.swagger.v3.oas.models.OpenAPI;
4+
import io.swagger.v3.oas.models.examples.Example;
45
import io.swagger.v3.oas.models.media.MediaType;
56
import io.swagger.v3.oas.models.media.Schema;
67
import io.swagger.v3.oas.models.parameters.RequestBody;
@@ -18,11 +19,13 @@
1819
public class RequestBodyProcessor {
1920
private final SchemaProcessor schemaProcessor;
2021
private final ExternalRefProcessor externalRefProcessor;
22+
private final ExampleProcessor exampleProcessor;
2123
private final ResolverCache cache;
2224
private final OpenAPI openAPI;
2325

2426
public RequestBodyProcessor(ResolverCache cache, OpenAPI openAPI) {
2527
schemaProcessor = new SchemaProcessor(cache,openAPI);
28+
exampleProcessor = new ExampleProcessor(cache,openAPI);
2629
this.externalRefProcessor = new ExternalRefProcessor(cache, openAPI);
2730
this.cache = cache;
2831
this.openAPI = openAPI;
@@ -44,6 +47,11 @@ public void processRequestBody(RequestBody requestBody) {
4447
schemaProcessor.processSchema(schema);
4548
}
4649
}
50+
if(mediaType.getExamples() != null) {
51+
for(Example ex: mediaType.getExamples().values()){
52+
exampleProcessor.processExample(ex);
53+
}
54+
}
4755
}
4856
}
4957
}

‎modules/swagger-parser-v3/src/main/java/io/swagger/v3/parser/util/OpenAPIDeserializer.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2242,6 +2242,8 @@ public Schema getSchema(ObjectNode node, String location, ParseResult result){
22422242
for (JsonNode n : enumArray) {
22432243
if (n.isNumber()) {
22442244
schema.addEnumItemObject(n.numberValue());
2245+
} else if (n.isBoolean()) {
2246+
schema.addEnumItemObject(n.booleanValue());
22452247
} else if (n.isValueNode()) {
22462248
try {
22472249
schema.addEnumItemObject( getDecodedObject( schema, n.asText(null)));

‎modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/processors/ParameterProcessorTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public void testProcessParameters_TypesThatAreNotRefOrBody(@Injectable final Hea
4242
@Injectable final PathParameter pathParameter) throws Exception {
4343
expectedModelProcessorCreation();
4444
new Expectations() {
45-
{
45+
{
4646
headerParameter.getSchema();
4747
result = null;
4848
headerParameter.getContent();

‎modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/test/OpenAPIV3ParserTest.java

Lines changed: 98 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
import io.swagger.v3.oas.models.Components;
1212
import io.swagger.v3.oas.models.OpenAPI;
1313
import io.swagger.v3.oas.models.Operation;
14+
import io.swagger.v3.oas.models.Paths;
1415
import io.swagger.v3.oas.models.PathItem;
1516
import io.swagger.v3.oas.models.headers.Header;
1617
import io.swagger.v3.oas.models.links.Link;
@@ -225,7 +226,7 @@ public void testIssue853() {
225226
ParseOptions options = new ParseOptions();
226227
options.setResolve(true);
227228
options.setFlatten(true);
228-
final OpenAPI openAPI = new OpenAPIV3Parser().readLocation("issue-837-853/main.yaml", null, options).getOpenAPI();
229+
final OpenAPI openAPI = new OpenAPIV3Parser().readLocation("issue-837-853-1131/main.yaml", null, options).getOpenAPI();
229230

230231
Assert.assertNotNull(openAPI);
231232

@@ -248,7 +249,7 @@ public void testIssue853() {
248249
public void testIssue837() {
249250
ParseOptions options = new ParseOptions();
250251
options.setResolve(true);
251-
final OpenAPI openAPI = new OpenAPIV3Parser().readLocation("issue-837-853/main.yaml", null, options).getOpenAPI();
252+
final OpenAPI openAPI = new OpenAPIV3Parser().readLocation("issue-837-853-1131/main.yaml", null, options).getOpenAPI();
252253

253254
Assert.assertNotNull(openAPI);
254255

@@ -262,6 +263,38 @@ public void testIssue837() {
262263
Assert.assertEquals(examples.get("external").get$ref(), "#/components/examples/ExternalRef");
263264
}
264265

266+
@Test
267+
public void testIssue1131() {
268+
ParseOptions options = new ParseOptions();
269+
options.setResolve(true);
270+
final OpenAPI openAPI = new OpenAPIV3Parser().readLocation("issue-837-853-1131/main.yaml", null, options).getOpenAPI();
271+
272+
Assert.assertNotNull(openAPI);
273+
274+
Content content = openAPI.getPaths().get("/events").getGet().getRequestBody().getContent();
275+
Assert.assertNotNull(content);
276+
277+
Map<String, Example> examples = content.get("application/json").getExamples();
278+
Assert.assertEquals(examples.size(), 3);
279+
Assert.assertEquals(((ObjectNode) examples.get("plain").getValue()).get("test").asText(), "plain");
280+
Assert.assertEquals(examples.get("local").get$ref(), "#/components/examples/LocalRef");
281+
Assert.assertEquals(examples.get("external").get$ref(), "#/components/examples/ExternalRef");
282+
283+
// Also cover the case from Issue 853
284+
Operation post = openAPI.getPaths().get("/guests").getPost();
285+
Assert.assertNotNull(post);
286+
287+
content = post.getRequestBody().getContent();
288+
Assert.assertNotNull(content);
289+
290+
examples = content.get("application/json").getExamples();
291+
Assert.assertEquals(examples.size(), 1);
292+
assertNotNull(openAPI.getComponents());
293+
assertNotNull(openAPI.getComponents().getExamples());
294+
assertNotNull(openAPI.getComponents().getExamples().get("testExample"));
295+
assertEquals(((LinkedHashMap<String, Object>)openAPI.getComponents().getExamples().get("testExample").getValue()).get("test"),"value");
296+
}
297+
265298
@Test
266299
public void testIssue834() {
267300
ParseOptions options = new ParseOptions();
@@ -1912,6 +1945,68 @@ public void shouldParseApiWithMultipleParameterReferences() {
19121945
}
19131946

19141947
@Test
1948+
public void shouldParseApiWithParametersUsingContentvsSchema() {
1949+
// Tests that the content method of specifying the format of a parameter
1950+
// gets resolved.
1951+
// Test checks if an API's single parameter of array type gets fully resolved to
1952+
// referenced definitions.
1953+
String location = "src/test/resources/issue-1078/api.yaml";
1954+
ParseOptions options = new ParseOptions();
1955+
options.setResolve(true);
1956+
// This test uses an Array in the parameters, test if it get's fully resolved.
1957+
options.setResolveFully(true);
1958+
OpenAPIV3Parser tested = new OpenAPIV3Parser();
1959+
1960+
// Parse yaml
1961+
SwaggerParseResult result = tested.readLocation(location, emptyList(), options);
1962+
1963+
OpenAPI api = result.getOpenAPI();
1964+
Paths paths = api.getPaths();
1965+
1966+
// First ensure all schemas were resolved, this is important when this library
1967+
// is used to generate code
1968+
Components components = api.getComponents();
1969+
assertNotNull(components);
1970+
assertThat(components.getSchemas().size(), equalTo(4));
1971+
assertNotNull(components.getSchemas().get("LocationType"));
1972+
assertNotNull(components.getSchemas().get("Lat"));
1973+
assertNotNull(components.getSchemas().get("Long"));
1974+
assertNotNull(components.getSchemas().get("SearchResult"));
1975+
1976+
PathItem apiEndpoint = paths.get("/api-endpoint-1");
1977+
List<Parameter> parameters = apiEndpoint.getGet().getParameters();
1978+
1979+
// Ensure there's only one parameter in this test
1980+
assertThat(parameters.size(), equalTo(1));
1981+
1982+
// We are testing content for a parameter so make sure its there.
1983+
Content content = parameters.get(0).getContent();
1984+
assertNotNull(content);
1985+
// spec says only one content is permitted in 3.x
1986+
assertThat( content.size(), equalTo(1));
1987+
1988+
// Ensure there's a media type
1989+
MediaType mediaType = content.entrySet().iterator().next().getValue();
1990+
assertNotNull(mediaType);
1991+
1992+
// This test has a single parameter of type array
1993+
Schema parameterSchema = mediaType.getSchema();
1994+
Assert.assertTrue(parameterSchema instanceof ArraySchema);
1995+
ArraySchema arraySchema = (ArraySchema)parameterSchema;
1996+
1997+
// Test if the item schema was resolved properly
1998+
Schema itemSchema = arraySchema.getItems();
1999+
assertNotNull(itemSchema);
2000+
Assert.assertTrue(itemSchema instanceof ObjectSchema);
2001+
2002+
// Ensure the referenced item's schema has been resolved.
2003+
ObjectSchema objSchema = (ObjectSchema)itemSchema;
2004+
Map<String, Schema> objectItemSchemas = objSchema.getProperties();
2005+
assertThat( objectItemSchemas.size(), equalTo(2));
2006+
Assert.assertTrue(objectItemSchemas.get("lat") instanceof IntegerSchema);
2007+
Assert.assertTrue(objectItemSchemas.get("long") instanceof IntegerSchema);
2008+
2009+
}
19152010
public void testIssue1063() {
19162011
// given
19172012
String location = "src/test/resources/issue-1063/openapi.yaml";
@@ -1949,4 +2044,4 @@ public void testResolveFullyMap() {
19492044
private static int getDynamicPort() {
19502045
return new Random().ints(10000, 20000).findFirst().getAsInt();
19512046
}
1952-
}
2047+
}

‎modules/swagger-parser-v3/src/test/java/io/swagger/v3/parser/util/OpenAPIDeserializerTest.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -878,6 +878,8 @@ public void testDeserializeEnum() {
878878
" $ref: '#/components/schemas/IntegerEnum'\n" +
879879
" ne:\n" +
880880
" $ref: '#/components/schemas/NumberEnum'\n" +
881+
" be:\n" +
882+
" $ref: '#/components/schemas/BooleanEnum'\n" +
881883
"components:\n" +
882884
" schemas:\n" +
883885
" StringEnum:\n" +
@@ -886,6 +888,10 @@ public void testDeserializeEnum() {
886888
" enum:\n" +
887889
" - First\n" +
888890
" - Second\n" +
891+
" BooleanEnum:\n" +
892+
" enum:\n" +
893+
" - true \n" +
894+
" - false \n" +
889895
" IntegerEnum:\n" +
890896
" type: integer\n" +
891897
" default: 1\n" +
@@ -934,6 +940,13 @@ public void testDeserializeEnum() {
934940
assertEquals(new BigDecimal("1.6161"), numberValues.get(2));
935941
assertEquals(new BigDecimal("3.14"), numberValues.get(3));
936942
assertEquals(numberImpl.getDefault(), new BigDecimal("3.14"));
943+
944+
Schema booleanModel = resolved.getComponents().getSchemas().get("BooleanEnum");
945+
assertEquals("boolean", booleanModel.getType());
946+
List<Object> booleanValues = booleanModel.getEnum();
947+
assertEquals(2, booleanValues.size());
948+
assertEquals(Boolean.TRUE, booleanValues.get(0));
949+
assertEquals(Boolean.FALSE, booleanValues.get(1));
937950
}
938951

939952
@Test

‎modules/swagger-parser-v3/src/test/resources/issue-1078/api.yaml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
openapi: 3.0.0
2+
info:
3+
version: '1.0.0'
4+
title: 'Simple Test'
5+
description: 'Test of schema vs content for Query Parameters'
6+
7+
paths:
8+
/api-endpoint-1:
9+
get:
10+
summary: Test Service API Endpoint 1
11+
operationId: SimpleTestEndpoint1
12+
tags:
13+
- SimpleTestEndpoint(1)
14+
parameters:
15+
- name: target-locations-list
16+
in: query
17+
description: list of locations to search near
18+
content:
19+
application/json:
20+
schema:
21+
type: array
22+
items:
23+
$ref: './common.yaml#/components/schemas/LocationType'
24+
minItems: 1
25+
responses:
26+
'200':
27+
description: Expected response to a valid request
28+
content:
29+
application/json:
30+
schema:
31+
$ref: './common.yaml#/components/schemas/SearchResult'
32+
'404':
33+
$ref: './common.yaml#/components/responses/404'

‎modules/swagger-parser-v3/src/test/resources/issue-1078/common.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
openapi: 3.0.0
2+
info:
3+
version: '1.0.0'
4+
title: 'Common Data Types'
5+
description: 'Common Data Types for Test'
6+
7+
paths: {}
8+
components:
9+
schemas:
10+
11+
LocationType:
12+
type: object
13+
properties:
14+
lat:
15+
$ref: '#/components/schemas/Lat'
16+
long:
17+
$ref: '#/components/schemas/Long'
18+
required:
19+
- lat
20+
- long
21+
22+
Lat:
23+
type: integer
24+
Long:
25+
type: integer
26+
27+
SearchResult:
28+
type: object
29+
required:
30+
- simpleTestResults
31+
properties:
32+
resultId:
33+
type: integer
34+
simpleTestResults:
35+
type: array
36+
items:
37+
type: string
38+
39+
40+
responses:
41+
'404':
42+
description: Not Found
43+
type: string

0 commit comments

Comments
 (0)