Better inline model resolver to handle inline schema in array item (#12104)

* better support of inline schema in array item

* update tests

* update samples

* regenerate samples

* fix allof naming, remove files

* add files

* update samples

* update readme

* fix tests

* update samples

* update samples

* add new files

* update test spec

* add back tests

* remove unused files

* comment out python test

* update js test using own spec

* remove files

* remove unused files

* remove files

* remove unused files

* better handling of allOf with a single type

* comment out go test

* remove test_all_of_with_single_ref_single_ref_type.py

* fix inline resolver, uncomment go test
This commit is contained in:
William Cheng
2022-04-20 10:28:15 +08:00
committed by GitHub
parent 12454de3ac
commit 8330e16d66
200 changed files with 7495 additions and 975 deletions

View File

@@ -3,6 +3,7 @@
README.md
bin/autodoc
docs/AdditionalPropertiesClass.md
docs/AllOfWithSingleRef.md
docs/Animal.md
docs/AnotherFakeApi.md
docs/ApiResponse.md
@@ -50,12 +51,12 @@ docs/OuterObjectWithEnumProperty.md
docs/Pet.md
docs/PetApi.md
docs/ReadOnlyFirst.md
docs/SingleRefType.md
docs/SpecialModelName.md
docs/StoreApi.md
docs/Tag.md
docs/User.md
docs/UserApi.md
docs/UserType.md
git_push.sh
lib/WWW/OpenAPIClient/AnotherFakeApi.pm
lib/WWW/OpenAPIClient/ApiClient.pm
@@ -65,6 +66,7 @@ lib/WWW/OpenAPIClient/DefaultApi.pm
lib/WWW/OpenAPIClient/FakeApi.pm
lib/WWW/OpenAPIClient/FakeClassnameTags123Api.pm
lib/WWW/OpenAPIClient/Object/AdditionalPropertiesClass.pm
lib/WWW/OpenAPIClient/Object/AllOfWithSingleRef.pm
lib/WWW/OpenAPIClient/Object/Animal.pm
lib/WWW/OpenAPIClient/Object/ApiResponse.pm
lib/WWW/OpenAPIClient/Object/ArrayOfArrayOfNumberOnly.pm
@@ -107,10 +109,10 @@ lib/WWW/OpenAPIClient/Object/OuterEnumIntegerDefaultValue.pm
lib/WWW/OpenAPIClient/Object/OuterObjectWithEnumProperty.pm
lib/WWW/OpenAPIClient/Object/Pet.pm
lib/WWW/OpenAPIClient/Object/ReadOnlyFirst.pm
lib/WWW/OpenAPIClient/Object/SingleRefType.pm
lib/WWW/OpenAPIClient/Object/SpecialModelName.pm
lib/WWW/OpenAPIClient/Object/Tag.pm
lib/WWW/OpenAPIClient/Object/User.pm
lib/WWW/OpenAPIClient/Object/UserType.pm
lib/WWW/OpenAPIClient/PetApi.pm
lib/WWW/OpenAPIClient/Role.pm
lib/WWW/OpenAPIClient/Role/AutoDoc.pm

View File

@@ -243,6 +243,7 @@ use WWW::OpenAPIClient::UserApi;
To load the models:
```perl
use WWW::OpenAPIClient::Object::AdditionalPropertiesClass;
use WWW::OpenAPIClient::Object::AllOfWithSingleRef;
use WWW::OpenAPIClient::Object::Animal;
use WWW::OpenAPIClient::Object::ApiResponse;
use WWW::OpenAPIClient::Object::ArrayOfArrayOfNumberOnly;
@@ -285,10 +286,10 @@ use WWW::OpenAPIClient::Object::OuterEnumIntegerDefaultValue;
use WWW::OpenAPIClient::Object::OuterObjectWithEnumProperty;
use WWW::OpenAPIClient::Object::Pet;
use WWW::OpenAPIClient::Object::ReadOnlyFirst;
use WWW::OpenAPIClient::Object::SingleRefType;
use WWW::OpenAPIClient::Object::SpecialModelName;
use WWW::OpenAPIClient::Object::Tag;
use WWW::OpenAPIClient::Object::User;
use WWW::OpenAPIClient::Object::UserType;
````
@@ -310,6 +311,7 @@ use WWW::OpenAPIClient::UserApi;
# load the models
use WWW::OpenAPIClient::Object::AdditionalPropertiesClass;
use WWW::OpenAPIClient::Object::AllOfWithSingleRef;
use WWW::OpenAPIClient::Object::Animal;
use WWW::OpenAPIClient::Object::ApiResponse;
use WWW::OpenAPIClient::Object::ArrayOfArrayOfNumberOnly;
@@ -352,10 +354,10 @@ use WWW::OpenAPIClient::Object::OuterEnumIntegerDefaultValue;
use WWW::OpenAPIClient::Object::OuterObjectWithEnumProperty;
use WWW::OpenAPIClient::Object::Pet;
use WWW::OpenAPIClient::Object::ReadOnlyFirst;
use WWW::OpenAPIClient::Object::SingleRefType;
use WWW::OpenAPIClient::Object::SpecialModelName;
use WWW::OpenAPIClient::Object::Tag;
use WWW::OpenAPIClient::Object::User;
use WWW::OpenAPIClient::Object::UserType;
# for displaying the API response data
use Data::Dumper;
@@ -427,6 +429,7 @@ Class | Method | HTTP request | Description
# DOCUMENTATION FOR MODELS
- [WWW::OpenAPIClient::Object::AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md)
- [WWW::OpenAPIClient::Object::AllOfWithSingleRef](docs/AllOfWithSingleRef.md)
- [WWW::OpenAPIClient::Object::Animal](docs/Animal.md)
- [WWW::OpenAPIClient::Object::ApiResponse](docs/ApiResponse.md)
- [WWW::OpenAPIClient::Object::ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md)
@@ -469,10 +472,10 @@ Class | Method | HTTP request | Description
- [WWW::OpenAPIClient::Object::OuterObjectWithEnumProperty](docs/OuterObjectWithEnumProperty.md)
- [WWW::OpenAPIClient::Object::Pet](docs/Pet.md)
- [WWW::OpenAPIClient::Object::ReadOnlyFirst](docs/ReadOnlyFirst.md)
- [WWW::OpenAPIClient::Object::SingleRefType](docs/SingleRefType.md)
- [WWW::OpenAPIClient::Object::SpecialModelName](docs/SpecialModelName.md)
- [WWW::OpenAPIClient::Object::Tag](docs/Tag.md)
- [WWW::OpenAPIClient::Object::User](docs/User.md)
- [WWW::OpenAPIClient::Object::UserType](docs/UserType.md)
# DOCUMENTATION FOR AUTHORIZATION

View File

@@ -0,0 +1,16 @@
# WWW::OpenAPIClient::Object::AllOfWithSingleRef
## Load the model package
```perl
use WWW::OpenAPIClient::Object::AllOfWithSingleRef;
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**username** | **string** | | [optional]
**single_ref_type** | [**SingleRefType**](SingleRefType.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -1,8 +1,8 @@
# WWW::OpenAPIClient::Object::UserType
# WWW::OpenAPIClient::Object::SingleRefType
## Load the model package
```perl
use WWW::OpenAPIClient::Object::UserType;
use WWW::OpenAPIClient::Object::SingleRefType;
```
## Properties

View File

@@ -16,7 +16,6 @@ Name | Type | Description | Notes
**password** | **string** | | [optional]
**phone** | **string** | | [optional]
**user_status** | **int** | User Status | [optional]
**user_type** | [**UserType**](UserType.md) | | [optional]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,193 @@
=begin comment
OpenAPI Petstore
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
The version of the OpenAPI document: 1.0.0
Generated by: https://openapi-generator.tech
=end comment
=cut
#
# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
# Do not edit the class manually.
# Ref: https://openapi-generator.tech
#
package WWW::OpenAPIClient::Object::AllOfWithSingleRef;
require 5.6.0;
use strict;
use warnings;
use utf8;
use JSON qw(decode_json);
use Data::Dumper;
use Module::Runtime qw(use_module);
use Log::Any qw($log);
use Date::Parse;
use DateTime;
use WWW::OpenAPIClient::Object::SingleRefType;
use base ("Class::Accessor", "Class::Data::Inheritable");
#
#
#
# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). Do not edit the class manually.
# REF: https://openapi-generator.tech
#
=begin comment
OpenAPI Petstore
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
The version of the OpenAPI document: 1.0.0
Generated by: https://openapi-generator.tech
=end comment
=cut
#
# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
# Do not edit the class manually.
# Ref: https://openapi-generator.tech
#
__PACKAGE__->mk_classdata('attribute_map' => {});
__PACKAGE__->mk_classdata('openapi_types' => {});
__PACKAGE__->mk_classdata('method_documentation' => {});
__PACKAGE__->mk_classdata('class_documentation' => {});
# new plain object
sub new {
my ($class, %args) = @_;
my $self = bless {}, $class;
$self->init(%args);
return $self;
}
# initialize the object
sub init
{
my ($self, %args) = @_;
foreach my $attribute (keys %{$self->attribute_map}) {
my $args_key = $self->attribute_map->{$attribute};
$self->$attribute( $args{ $args_key } );
}
}
# return perl hash
sub to_hash {
my $self = shift;
my $_hash = decode_json(JSON->new->convert_blessed->encode($self));
return $_hash;
}
# used by JSON for serialization
sub TO_JSON {
my $self = shift;
my $_data = {};
foreach my $_key (keys %{$self->attribute_map}) {
if (defined $self->{$_key}) {
$_data->{$self->attribute_map->{$_key}} = $self->{$_key};
}
}
return $_data;
}
# from Perl hashref
sub from_hash {
my ($self, $hash) = @_;
# loop through attributes and use openapi_types to deserialize the data
while ( my ($_key, $_type) = each %{$self->openapi_types} ) {
my $_json_attribute = $self->attribute_map->{$_key};
if ($_type =~ /^array\[(.+)\]$/i) { # array
my $_subclass = $1;
my @_array = ();
foreach my $_element (@{$hash->{$_json_attribute}}) {
push @_array, $self->_deserialize($_subclass, $_element);
}
$self->{$_key} = \@_array;
} elsif ($_type =~ /^hash\[string,(.+)\]$/i) { # hash
my $_subclass = $1;
my %_hash = ();
while (my($_key, $_element) = each %{$hash->{$_json_attribute}}) {
$_hash{$_key} = $self->_deserialize($_subclass, $_element);
}
$self->{$_key} = \%_hash;
} elsif (exists $hash->{$_json_attribute}) { #hash(model), primitive, datetime
$self->{$_key} = $self->_deserialize($_type, $hash->{$_json_attribute});
} else {
$log->debugf("Warning: %s (%s) does not exist in input hash\n", $_key, $_json_attribute);
}
}
return $self;
}
# deserialize non-array data
sub _deserialize {
my ($self, $type, $data) = @_;
$log->debugf("deserializing %s with %s",Dumper($data), $type);
if ($type eq 'DateTime') {
return DateTime->from_epoch(epoch => str2time($data));
} elsif ( grep( /^$type$/, ('int', 'double', 'string', 'boolean'))) {
return $data;
} else { # hash(model)
my $_instance = eval "WWW::OpenAPIClient::Object::$type->new()";
return $_instance->from_hash($data);
}
}
__PACKAGE__->class_documentation({description => '',
class => 'AllOfWithSingleRef',
required => [], # TODO
} );
__PACKAGE__->method_documentation({
'username' => {
datatype => 'string',
base_name => 'username',
description => '',
format => '',
read_only => '',
},
'single_ref_type' => {
datatype => 'SingleRefType',
base_name => 'SingleRefType',
description => '',
format => '',
read_only => '',
},
});
__PACKAGE__->openapi_types( {
'username' => 'string',
'single_ref_type' => 'SingleRefType'
} );
__PACKAGE__->attribute_map( {
'username' => 'username',
'single_ref_type' => 'SingleRefType'
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
1;

View File

@@ -17,7 +17,7 @@ Generated by: https://openapi-generator.tech
# Do not edit the class manually.
# Ref: https://openapi-generator.tech
#
package WWW::OpenAPIClient::Object::UserType;
package WWW::OpenAPIClient::Object::SingleRefType;
require 5.6.0;
use strict;
@@ -155,7 +155,7 @@ sub _deserialize {
__PACKAGE__->class_documentation({description => '',
class => 'UserType',
class => 'SingleRefType',
required => [], # TODO
} );

View File

@@ -30,7 +30,6 @@ use Log::Any qw($log);
use Date::Parse;
use DateTime;
use WWW::OpenAPIClient::Object::UserType;
use base ("Class::Accessor", "Class::Data::Inheritable");
@@ -217,13 +216,6 @@ __PACKAGE__->method_documentation({
format => '',
read_only => '',
},
'user_type' => {
datatype => 'UserType',
base_name => 'userType',
description => '',
format => '',
read_only => '',
},
});
__PACKAGE__->openapi_types( {
@@ -234,8 +226,7 @@ __PACKAGE__->openapi_types( {
'email' => 'string',
'password' => 'string',
'phone' => 'string',
'user_status' => 'int',
'user_type' => 'UserType'
'user_status' => 'int'
} );
__PACKAGE__->attribute_map( {
@@ -246,8 +237,7 @@ __PACKAGE__->attribute_map( {
'email' => 'email',
'password' => 'password',
'phone' => 'phone',
'user_status' => 'userStatus',
'user_type' => 'userType'
'user_status' => 'userStatus'
} );
__PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});

View File

@@ -0,0 +1,34 @@
=begin comment
OpenAPI Petstore
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\
The version of the OpenAPI document: 1.0.0
Generated by: https://openapi-generator.tech
=end comment
=cut
#
# NOTE: This class is auto generated by the OpenAPI Generator
# Please update the test cases below to test the model.
# Ref: https://openapi-generator.tech
#
use Test::More tests => 2;
use Test::Exception;
use lib 'lib';
use strict;
use warnings;
use_ok('WWW::OpenAPIClient::Object::AllOfWithSingleRef');
# uncomment below and update the test
#my $instance = WWW::OpenAPIClient::Object::AllOfWithSingleRef->new();
#
#isa_ok($instance, 'WWW::OpenAPIClient::Object::AllOfWithSingleRef');

View File

@@ -25,10 +25,10 @@ use strict;
use warnings;
use_ok('WWW::OpenAPIClient::Object::UserType');
use_ok('WWW::OpenAPIClient::Object::SingleRefType');
# uncomment below and update the test
#my $instance = WWW::OpenAPIClient::Object::UserType->new();
#my $instance = WWW::OpenAPIClient::Object::SingleRefType->new();
#
#isa_ok($instance, 'WWW::OpenAPIClient::Object::UserType');
#isa_ok($instance, 'WWW::OpenAPIClient::Object::SingleRefType');