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

@@ -6,6 +6,7 @@ Gemfile
README.md
Rakefile
docs/AdditionalPropertiesClass.md
docs/AllOfWithSingleRef.md
docs/Animal.md
docs/AnotherFakeApi.md
docs/ApiResponse.md
@@ -53,12 +54,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/petstore.rb
lib/petstore/api/another_fake_api.rb
@@ -72,6 +73,7 @@ lib/petstore/api_client.rb
lib/petstore/api_error.rb
lib/petstore/configuration.rb
lib/petstore/models/additional_properties_class.rb
lib/petstore/models/all_of_with_single_ref.rb
lib/petstore/models/animal.rb
lib/petstore/models/api_response.rb
lib/petstore/models/array_of_array_of_number_only.rb
@@ -114,10 +116,10 @@ lib/petstore/models/outer_enum_integer_default_value.rb
lib/petstore/models/outer_object_with_enum_property.rb
lib/petstore/models/pet.rb
lib/petstore/models/read_only_first.rb
lib/petstore/models/single_ref_type.rb
lib/petstore/models/special_model_name.rb
lib/petstore/models/tag.rb
lib/petstore/models/user.rb
lib/petstore/models/user_type.rb
lib/petstore/version.rb
petstore.gemspec
spec/api_client_spec.rb

View File

@@ -121,6 +121,7 @@ Class | Method | HTTP request | Description
## Documentation for Models
- [Petstore::AdditionalPropertiesClass](docs/AdditionalPropertiesClass.md)
- [Petstore::AllOfWithSingleRef](docs/AllOfWithSingleRef.md)
- [Petstore::Animal](docs/Animal.md)
- [Petstore::ApiResponse](docs/ApiResponse.md)
- [Petstore::ArrayOfArrayOfNumberOnly](docs/ArrayOfArrayOfNumberOnly.md)
@@ -163,10 +164,10 @@ Class | Method | HTTP request | Description
- [Petstore::OuterObjectWithEnumProperty](docs/OuterObjectWithEnumProperty.md)
- [Petstore::Pet](docs/Pet.md)
- [Petstore::ReadOnlyFirst](docs/ReadOnlyFirst.md)
- [Petstore::SingleRefType](docs/SingleRefType.md)
- [Petstore::SpecialModelName](docs/SpecialModelName.md)
- [Petstore::Tag](docs/Tag.md)
- [Petstore::User](docs/User.md)
- [Petstore::UserType](docs/UserType.md)
## Documentation for Authorization

View File

@@ -0,0 +1,20 @@
# Petstore::AllOfWithSingleRef
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **username** | **String** | | [optional] |
| **single_ref_type** | [**SingleRefType**](SingleRefType.md) | | [optional] |
## Example
```ruby
require 'petstore'
instance = Petstore::AllOfWithSingleRef.new(
username: null,
single_ref_type: null
)
```

View File

@@ -1,4 +1,4 @@
# Petstore::UserType
# Petstore::SingleRefType
## Properties
@@ -10,6 +10,6 @@
```ruby
require 'petstore'
instance = Petstore::UserType.new()
instance = Petstore::SingleRefType.new()
```

View File

@@ -12,7 +12,6 @@
| **password** | **String** | | [optional] |
| **phone** | **String** | | [optional] |
| **user_status** | **Integer** | User Status | [optional] |
| **user_type** | [**UserType**](UserType.md) | | [optional] |
## Example
@@ -27,8 +26,7 @@ instance = Petstore::User.new(
email: null,
password: null,
phone: null,
user_status: null,
user_type: null
user_status: null
)
```

View File

@@ -18,6 +18,7 @@ require 'petstore/configuration'
# Models
require 'petstore/models/additional_properties_class'
require 'petstore/models/all_of_with_single_ref'
require 'petstore/models/animal'
require 'petstore/models/api_response'
require 'petstore/models/array_of_array_of_number_only'
@@ -58,10 +59,10 @@ require 'petstore/models/outer_enum_integer_default_value'
require 'petstore/models/outer_object_with_enum_property'
require 'petstore/models/pet'
require 'petstore/models/read_only_first'
require 'petstore/models/single_ref_type'
require 'petstore/models/special_model_name'
require 'petstore/models/tag'
require 'petstore/models/user'
require 'petstore/models/user_type'
require 'petstore/models/cat'
require 'petstore/models/dog'

View File

@@ -0,0 +1,229 @@
=begin
#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
OpenAPI Generator version: 6.0.0-SNAPSHOT
=end
require 'date'
require 'time'
module Petstore
class AllOfWithSingleRef
attr_accessor :username
attr_accessor :single_ref_type
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:'username' => :'username',
:'single_ref_type' => :'SingleRefType'
}
end
# Returns all the JSON keys this model knows about
def self.acceptable_attributes
attribute_map.values
end
# Attribute type mapping.
def self.openapi_types
{
:'username' => :'String',
:'single_ref_type' => :'SingleRefType'
}
end
# List of attributes with nullable: true
def self.openapi_nullable
Set.new([
:'single_ref_type'
])
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
if (!attributes.is_a?(Hash))
fail ArgumentError, "The input argument (attributes) must be a hash in `Petstore::AllOfWithSingleRef` initialize method"
end
# check to see if the attribute exists and convert string to symbol for hash key
attributes = attributes.each_with_object({}) { |(k, v), h|
if (!self.class.attribute_map.key?(k.to_sym))
fail ArgumentError, "`#{k}` is not a valid attribute in `Petstore::AllOfWithSingleRef`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
end
h[k.to_sym] = v
}
if attributes.key?(:'username')
self.username = attributes[:'username']
end
if attributes.key?(:'single_ref_type')
self.single_ref_type = attributes[:'single_ref_type']
end
end
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properties with the reasons
def list_invalid_properties
invalid_properties = Array.new
invalid_properties
end
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
def valid?
true
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
def ==(o)
return true if self.equal?(o)
self.class == o.class &&
username == o.username &&
single_ref_type == o.single_ref_type
end
# @see the `==` method
# @param [Object] Object to be compared
def eql?(o)
self == o
end
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[username, single_ref_type].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def self.build_from_hash(attributes)
new.build_from_hash(attributes)
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def build_from_hash(attributes)
return nil unless attributes.is_a?(Hash)
attributes = attributes.transform_keys(&:to_sym)
self.class.openapi_types.each_pair do |key, type|
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
self.send("#{key}=", nil)
elsif type =~ /\AArray<(.*)>/i
# check to ensure the input is an array given that the attribute
# is documented as an array but the input is not
if attributes[self.class.attribute_map[key]].is_a?(Array)
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
end
elsif !attributes[self.class.attribute_map[key]].nil?
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
end
end
self
end
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
def _deserialize(type, value)
case type.to_sym
when :Time
Time.parse(value)
when :Date
Date.parse(value)
when :String
value.to_s
when :Integer
value.to_i
when :Float
value.to_f
when :Boolean
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
true
else
false
end
when :Object
# generic object (usually a Hash), return directly
value
when /\AArray<(?<inner_type>.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
k_type = Regexp.last_match[:k_type]
v_type = Regexp.last_match[:v_type]
{}.tap do |hash|
value.each do |k, v|
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
end
end
else # model
# models (e.g. Pet) or oneOf
klass = Petstore.const_get(type)
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
end
end
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
def to_hash
hash = {}
self.class.attribute_map.each_pair do |attr, param|
value = self.send(attr)
if value.nil?
is_nullable = self.class.openapi_nullable.include?(attr)
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
end
hash[param] = _to_hash(value)
end
hash
end
# Outputs non-array value in the form of hash
# For object, use to_hash. Otherwise, just return the value
# @param [Object] value Any valid value
# @return [Hash] Returns the value in the form of hash
def _to_hash(value)
if value.is_a?(Array)
value.compact.map { |v| _to_hash(v) }
elsif value.is_a?(Hash)
{}.tap do |hash|
value.each { |k, v| hash[k] = _to_hash(v) }
end
elsif value.respond_to? :to_hash
value.to_hash
else
value
end
end
end
end

View File

@@ -14,7 +14,7 @@ require 'date'
require 'time'
module Petstore
class UserType
class SingleRefType
ADMIN = "admin".freeze
USER = "user".freeze
@@ -29,8 +29,8 @@ module Petstore
# @param [String] The enum value in the form of the string
# @return [String] The enum value
def build_from_hash(value)
constantValues = UserType.constants.select { |c| UserType::const_get(c) == value }
raise "Invalid ENUM value #{value} for class #UserType" if constantValues.empty?
constantValues = SingleRefType.constants.select { |c| SingleRefType::const_get(c) == value }
raise "Invalid ENUM value #{value} for class #SingleRefType" if constantValues.empty?
value
end
end

View File

@@ -32,8 +32,6 @@ module Petstore
# User Status
attr_accessor :user_status
attr_accessor :user_type
# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
@@ -44,8 +42,7 @@ module Petstore
:'email' => :'email',
:'password' => :'password',
:'phone' => :'phone',
:'user_status' => :'userStatus',
:'user_type' => :'userType'
:'user_status' => :'userStatus'
}
end
@@ -64,15 +61,13 @@ module Petstore
:'email' => :'String',
:'password' => :'String',
:'phone' => :'String',
:'user_status' => :'Integer',
:'user_type' => :'UserType'
:'user_status' => :'Integer'
}
end
# List of attributes with nullable: true
def self.openapi_nullable
Set.new([
:'user_type'
])
end
@@ -122,10 +117,6 @@ module Petstore
if attributes.key?(:'user_status')
self.user_status = attributes[:'user_status']
end
if attributes.key?(:'user_type')
self.user_type = attributes[:'user_type']
end
end
# Show invalid properties with the reasons. Usually used together with valid?
@@ -153,8 +144,7 @@ module Petstore
email == o.email &&
password == o.password &&
phone == o.phone &&
user_status == o.user_status &&
user_type == o.user_type
user_status == o.user_status
end
# @see the `==` method
@@ -166,7 +156,7 @@ module Petstore
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[id, username, first_name, last_name, email, password, phone, user_status, user_type].hash
[id, username, first_name, last_name, email, password, phone, user_status].hash
end
# Builds the object from hash

View File

@@ -0,0 +1,40 @@
=begin
#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
OpenAPI Generator version: 6.0.0-SNAPSHOT
=end
require 'spec_helper'
require 'json'
require 'date'
# Unit tests for Petstore::AllOfWithSingleRef
# Automatically generated by openapi-generator (https://openapi-generator.tech)
# Please update as you see appropriate
describe Petstore::AllOfWithSingleRef do
let(:instance) { Petstore::AllOfWithSingleRef.new }
describe 'test an instance of AllOfWithSingleRef' do
it 'should create an instance of AllOfWithSingleRef' do
expect(instance).to be_instance_of(Petstore::AllOfWithSingleRef)
end
end
describe 'test attribute "username"' do
it 'should work' do
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
end
end
describe 'test attribute "single_ref_type"' do
it 'should work' do
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
end
end
end

View File

@@ -6,7 +6,7 @@
The version of the OpenAPI document: 1.0.0
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 5.3.1-SNAPSHOT
OpenAPI Generator version: 6.0.0-SNAPSHOT
=end
@@ -14,15 +14,15 @@ require 'spec_helper'
require 'json'
require 'date'
# Unit tests for Petstore::UserType
# Unit tests for Petstore::SingleRefType
# Automatically generated by openapi-generator (https://openapi-generator.tech)
# Please update as you see appropriate
describe Petstore::UserType do
let(:instance) { Petstore::UserType.new }
describe Petstore::SingleRefType do
let(:instance) { Petstore::SingleRefType.new }
describe 'test an instance of UserType' do
it 'should create an instance of UserType' do
expect(instance).to be_instance_of(Petstore::UserType)
describe 'test an instance of SingleRefType' do
it 'should create an instance of SingleRefType' do
expect(instance).to be_instance_of(Petstore::SingleRefType)
end
end
end