Skip to content

Commit 0ee44b1

Browse files
kerrykimbroughkerrykimbrough
committed
Merge remote-tracking branch 'upstream/master'
2 parents 141d71f + a95f13b commit 0ee44b1

File tree

60 files changed

+6263
-209
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+6263
-209
lines changed

‎LICENSE

Lines changed: 199 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,201 @@
1-
Copyright 2017 SmartBear Software
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
24

3-
Licensed under the Apache License, Version 2.0 (the "License");
4-
you may not use this file except in compliance with the License.
5-
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
66

7-
Unless required by applicable law or agreed to in writing, software
8-
distributed under the License is distributed on an "AS IS" BASIS,
9-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10-
See the License for the specific language governing permissions and
11-
limitations under the License.
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2020 SmartBear Software Inc.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import io.swagger.v3.oas.models.OpenAPI;
2424
// read a swagger description from the petstore
2525

2626

27-
OpenAPI openAPI = new OpenAPIV3Parser().read("http://petstore.swagger.io/v3/openapi.json");
27+
OpenAPI openAPI = new OpenAPIV3Parser().read("https://petstore3.swagger.io/api/v3/openapi.json");
2828

2929
```
3030

@@ -50,7 +50,7 @@ import io.swagger.v3.parser.core.models.AuthorizationValue;
5050
// or in a single constructor
5151
AuthorizationValue apiKey = new AuthorizationValue("api_key", "special-key", "header");
5252
OpenAPI openAPI = new OpenAPIV3Parser().readWithInfo(
53-
"http://petstore.swagger.io/v2/swagger.json",
53+
"https://petstore3.swagger.io/api/v3/openapi.json",
5454
Arrays.asList(mySpecialHeader, apiKey)
5555
);
5656
```
@@ -103,27 +103,10 @@ You can include this library from Sonatype OSS for SNAPSHOTS, or Maven central f
103103
<dependency>
104104
<groupId>io.swagger.parser.v3</groupId>
105105
<artifactId>swagger-parser</artifactId>
106-
<version>2.0.16</version>
106+
<version>2.0.19</version>
107107
</dependency>
108108
```
109109

110110
## Security contact
111111

112112
Please disclose any security-related issues or vulnerabilities by emailing [[email protected]](mailto:[email protected]), instead of using the public issue tracker.
113-
114-
License
115-
-------
116-
117-
Copyright 2018 SmartBear Software
118-
119-
Licensed under the Apache License, Version 2.0 (the "License");
120-
you may not use this file except in compliance with the License.
121-
You may obtain a copy of the License at [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
122-
123-
Unless required by applicable law or agreed to in writing, software
124-
distributed under the License is distributed on an "AS IS" BASIS,
125-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
126-
See the License for the specific language governing permissions and
127-
limitations under the License.
128-
129-
---

‎modules/swagger-parser-core/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<parent>
44
<groupId>io.swagger.parser.v3</groupId>
55
<artifactId>swagger-parser-project</artifactId>
6-
<version>2.0.17-SNAPSHOT</version>
6+
<version>2.0.20-SNAPSHOT</version>
77
<relativePath>../..</relativePath>
88
</parent>
99
<modelVersion>4.0.0</modelVersion>

‎modules/swagger-parser-core/src/main/java/io/swagger/v3/parser/core/models/ParseOptions.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ public class ParseOptions {
55
private boolean resolveCombinators = true;
66
private boolean resolveFully;
77
private boolean flatten;
8+
private boolean flattenComposedSchemas;
89
private boolean skipMatches;
910

1011
public boolean isResolve() {
@@ -42,4 +43,12 @@ public boolean isSkipMatches() {
4243
public void setSkipMatches(boolean skipMatches) {
4344
this.skipMatches = skipMatches;
4445
}
46+
47+
public boolean isFlattenComposedSchemas() {
48+
return flattenComposedSchemas;
49+
}
50+
51+
public void setFlattenComposedSchemas(boolean flattenComposedSchemas) {
52+
this.flattenComposedSchemas = flattenComposedSchemas;
53+
}
4554
}

‎modules/swagger-parser-v2-converter/pom.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<parent>
44
<groupId>io.swagger.parser.v3</groupId>
55
<artifactId>swagger-parser-project</artifactId>
6-
<version>2.0.17-SNAPSHOT</version>
6+
<version>2.0.20-SNAPSHOT</version>
77
<relativePath>../..</relativePath>
88
</parent>
99
<modelVersion>4.0.0</modelVersion>
@@ -12,6 +12,11 @@
1212
<name>swagger-parser-v2-converter</name>
1313

1414
<dependencies>
15+
<dependency>
16+
<groupId>io.swagger</groupId>
17+
<artifactId>swagger-core</artifactId>
18+
<version>${swagger-core-v2-version}</version>
19+
</dependency>
1520
<dependency>
1621
<groupId>io.swagger</groupId>
1722
<artifactId>swagger-parser</artifactId>

‎modules/swagger-parser-v2-converter/src/main/java/io/swagger/v3/parser/converter/SwaggerConverter.java

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,7 @@
2020
import io.swagger.models.parameters.BodyParameter;
2121
import io.swagger.models.parameters.RefParameter;
2222
import io.swagger.models.parameters.SerializableParameter;
23-
import io.swagger.models.properties.AbstractNumericProperty;
24-
import io.swagger.models.properties.ArrayProperty;
25-
import io.swagger.models.properties.FileProperty;
26-
import io.swagger.models.properties.MapProperty;
27-
import io.swagger.models.properties.ObjectProperty;
28-
import io.swagger.models.properties.Property;
29-
import io.swagger.models.properties.RefProperty;
30-
import io.swagger.models.properties.StringProperty;
23+
import io.swagger.models.properties.*;
3124
import io.swagger.parser.SwaggerParser;
3225
import io.swagger.parser.SwaggerResolver;
3326
import io.swagger.parser.util.SwaggerDeserializationResult;
@@ -210,9 +203,27 @@ public SwaggerParseResult convert(SwaggerDeserializationResult parse) {
210203
ref.set$ref(updatedRef);
211204
}
212205
}
206+
207+
if (property instanceof ComposedProperty) {
208+
ComposedProperty comprop = (ComposedProperty) property;
209+
if (comprop.getAllOf() != null) {
210+
for (Property item : comprop.getAllOf()) {
211+
if (item instanceof RefProperty) {
212+
RefProperty ref = (RefProperty) item;
213+
if (ref.get$ref().indexOf("#/definitions") == 0) {
214+
String updatedRef = "#/components/schemas" + ref.get$ref().substring("#/definitions".length());
215+
ref.set$ref(updatedRef);
216+
}
217+
218+
219+
}
220+
221+
}
222+
}
223+
}
213224
}
214225

215-
if (swagger.getParameters() != null) {
226+
if (swagger.getParameters() != null) {
216227
globalV2Parameters.putAll(swagger.getParameters());
217228
swagger.getParameters().forEach((k, v) -> {
218229
if ("body".equals(v.getIn())) {

‎modules/swagger-parser-v2-converter/src/test/java/io/swagger/parser/test/V2ConverterTest.java

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ public class V2ConverterTest {
9494
private static final String ISSUE_1032_YAML = "issue-1032.yaml";
9595
private static final String ISSUE_1113_YAML = "issue-1113.yaml";
9696
private static final String ISSUE_1164_YAML = "issue-1164.yaml";
97+
private static final String ISSUE_1261_YAML = "issue-1261.yaml";
9798

9899
private static final String API_BATCH_PATH = "/api/batch/";
99100
private static final String PETS_PATH = "/pets";
@@ -840,4 +841,13 @@ private OpenAPI getConvertedOpenAPIFromJsonFile(String file) throws IOException,
840841
assertNotNull(result);
841842
return result.getOpenAPI();
842843
}
844+
845+
@Test(description = "OpenAPI v2 converter - verifies the references inside composed schema is resolved")
846+
public void testissue1261() throws Exception {
847+
OpenAPI oas = getConvertedOpenAPIFromJsonFile(ISSUE_1261_YAML);
848+
assertNotNull(oas);
849+
ComposedSchema schema = (ComposedSchema) oas.getComponents().getSchemas().get("Bar").getProperties().get("bar2");
850+
assertEquals(schema.getAllOf().get(0).get$ref(),"#/components/schemas/Foo");
851+
852+
}
843853
}

‎modules/swagger-parser-v2-converter/src/test/resources/issue-1261.yaml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
swagger: '2.0'
2+
info:
3+
title: Conversion test
4+
version: '1.0.0'
5+
paths: {}
6+
7+
definitions:
8+
Foo:
9+
type: object
10+
properties:
11+
foo:
12+
type: string
13+
Bar:
14+
type: object
15+
properties:
16+
bar1:
17+
$ref: '#/definitions/Foo' # This $ref is converted properly to `#/components/schemas`
18+
bar2:
19+
allOf:
20+
- $ref: '#/definitions/Foo' # This $ref remains as `#/definitions`

0 commit comments

Comments
 (0)