loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[core] Add type and format properties to model of inline response (#6153)

Browse Source
This commit is contained in:
Yuriy Belenko
2020-08-04 01:37:37 +03:00
committed by GitHub
parent 1be98b4920
commit 6a08ec59c0
37 changed files with 204 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
modules/openapi-generator/src/main/java/org/openapitools/codegen/InlineModelResolver.java
View File

@@ -621,6 +621,15 @@ public class InlineModelResolver {
XML xml = object.getXml();
Map<String, Schema> properties = object.getProperties();
Schema model = new Schema();
if (object.getType() != null) {
model.setType(object.getType());
}
if (object.getFormat() != null) {
// Even though the `format` keyword typically applies to primitive types only,
// the JSON schema specification states `format` can be used for any model type instance
// including object types.
model.setFormat(object.getFormat());
}
model.setDescription(description);
model.setExample(example);
model.setName(object.getName());

17
modules/openapi-generator/src/test/java/org/openapitools/codegen/InlineModelResolverTest.java
View File

@@ -263,6 +263,23 @@ public class InlineModelResolverTest {
assertTrue(model.getProperties().get("name") instanceof StringSchema);
}
@Test
public void testInlineResponseModelType() {
OpenAPI openAPI = TestUtils.parseSpec("src/test/resources/3_0/6150_model_json_inline.yaml");
new InlineModelResolver().flatten(openAPI);
Schema InlineResponse200 = openAPI.getComponents().getSchemas().get("inline_response_200");
assertEquals("object", InlineResponse200.getType());
assertEquals("unknown", InlineResponse200.getFormat());
Schema FooBarObject = openAPI.getComponents().getSchemas().get("FooBarObject");
assertEquals("object", FooBarObject.getType());
assertEquals("date-time", FooBarObject.getFormat());
Schema Animal = openAPI.getComponents().getSchemas().get("Animal");
assertEquals("object", Animal.getType());
Schema Dog = openAPI.getComponents().getSchemas().get("Dog");
assertNull(Dog.getType());
}
@Test
public void testInlineResponseModelWithTitle() {
OpenAPI openapi = new OpenAPI();

79
modules/openapi-generator/src/test/resources/3_0/6150_model_json_inline.yaml Normal file
View File

@@ -0,0 +1,79 @@
openapi: "3.0.0"
info:
version: 1.0.0
title: Test inline response model
description: Test inline response model.
license:
name: MIT
paths:
/foobar:
get:
operationId: testOperation
description: No type property in modelJson of InlineResponse200
responses:
200:
description: InlineResponse200 itself.
content:
application/json:
schema:
type: object
# It is legal to use the `format` keyword for object types. The JSON schema specification explicitly allows this.
# Even if in practice most OAS authors use `format` for primitive types, it should still be allowed to use format for object types.
format: unknown
properties:
foo:
type: string
bar:
type: string
post:
operationId: testOperationPost
description: No type property in modelJson of InlineResponse200
responses:
400:
description: InlineResponse200 itself.
content:
application/json:
schema:
title: FooBarObject
type: object
# It is legal to use the `format` keyword for object types. The JSON schema specification explicitly allows this.
# Even if in practice most OAS authors use `format` for primitive types, it should still be allowed to use format for object types.
format: date-time
properties:
foo:
type: string
components:
schemas:
Animal:
type: object
discriminator: className
required:
- className
properties:
className:
type: string
color:
type: string
default: 'red'
Dog:
allOf:
- $ref: '#/components/schemas/Animal'
- type: object
properties:
breed:
type: string
Cat:
allOf:
- $ref: '#/components/schemas/Animal'
- type: object
properties:
declawed:
type: boolean
HugeCat:
allOf:
- $ref: '#/components/schemas/Cat'
- type: object
properties:
kind:
type: string
enum: [lions, tigers, leopards, jaguars]

3
samples/client/petstore/go-experimental/go-petstore/api/openapi.yaml
View File

@@ -2090,10 +2090,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2103,6 +2105,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/go/go-petstore-withXml/api/openapi.yaml
View File

@@ -2090,10 +2090,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2103,6 +2105,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/go/go-petstore/api/openapi.yaml
View File

@@ -2090,10 +2090,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2103,6 +2105,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/haskell-http-client/openapi.yaml
View File

@@ -2090,10 +2090,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2103,6 +2105,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/feign/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/google-api-client/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/jersey1/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/jersey2-java8/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/native-async/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/native/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/okhttp-gson-parcelableModel/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/okhttp-gson/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/rest-assured-jackson/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/rest-assured/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/resteasy/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/resttemplate-withXml/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/resttemplate/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/retrofit2-play26/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/retrofit2/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/retrofit2rx2/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/retrofit2rx3/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/vertx/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/client/petstore/java/webclient/api/openapi.yaml
View File

@@ -2151,10 +2151,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2164,6 +2166,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/openapi3/client/petstore/go-experimental/go-petstore/api/openapi.yaml
View File

@@ -1999,6 +1999,7 @@ components:
properties:
string:
$ref: '#/components/schemas/Foo'
type: object
inline_object:
properties:
name:
@@ -2138,10 +2139,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/openapi3/client/petstore/go/go-petstore/api/openapi.yaml
View File

@@ -1920,6 +1920,7 @@ components:
properties:
string:
$ref: '#/components/schemas/Foo'
type: object
inline_object:
properties:
name:
@@ -2059,10 +2060,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
securitySchemes:
petstore_auth:
flows:

4
samples/openapi3/client/petstore/java/jersey2-java8/api/openapi.yaml
View File

@@ -2249,6 +2249,7 @@ components:
properties:
string:
$ref: '#/components/schemas/Foo'
type: object
inline_object:
properties:
name:
@@ -2390,14 +2391,17 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
ChildCat_allOf:
properties:
name:
type: string
type: object
securitySchemes:
petstore_auth:
flows:

9
samples/server/petstore/java-play-framework-fake-endpoints/public/openapi.json
View File

@@ -2831,14 +2831,16 @@
"breed" : {
"type" : "string"
}
}
},
"type" : "object"
},
"Cat_allOf" : {
"properties" : {
"declawed" : {
"type" : "boolean"
}
}
},
"type" : "object"
},
"BigCat_allOf" : {
"properties" : {
@@ -2846,7 +2848,8 @@
"enum" : [ "lions", "tigers", "leopards", "jaguars" ],
"type" : "string"
}
}
},
"type" : "object"
}
},
"securitySchemes" : {

3
samples/server/petstore/jaxrs-spec-interface/src/main/openapi/openapi.yaml
View File

@@ -2225,10 +2225,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2238,6 +2240,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

3
samples/server/petstore/jaxrs-spec/src/main/openapi/openapi.yaml
View File

@@ -2225,10 +2225,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2238,6 +2240,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows:

1
samples/server/petstore/rust-server/output/multipart-v3/api/openapi.yaml
View File

@@ -132,4 +132,5 @@ components:
type: array
required:
- field_a
type: object

1
samples/server/petstore/rust-server/output/openapi-v3/api/openapi.yaml
View File

@@ -606,6 +606,7 @@ components:
properties:
foo:
type: string
type: object
securitySchemes:
authScheme:
flows:

2
samples/server/petstore/rust-server/output/petstore-with-fake-endpoints-models-for-testing/api/openapi.yaml
View File

@@ -1565,10 +1565,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
securitySchemes:
petstore_auth:
flows:

1
samples/server/petstore/rust-server/output/rust-server-test/api/openapi.yaml
View File

@@ -211,4 +211,5 @@ components:
type: integer
required:
- required_thing
type: object

3
samples/server/petstore/springboot-reactive/src/main/resources/openapi.yaml
View File

@@ -2225,10 +2225,12 @@ components:
properties:
breed:
type: string
type: object
Cat_allOf:
properties:
declawed:
type: boolean
type: object
BigCat_allOf:
properties:
kind:
@@ -2238,6 +2240,7 @@ components:
- leopards
- jaguars
type: string
type: object
securitySchemes:
petstore_auth:
flows: