forked from loafle/openapi-generator-original
[Ruby][client] Handle enums (and other scalars) in oneOf and anyOf schemas (#17515)
* Handle enums in oneOf and anyOf schemas * Update specs
This commit is contained in:
parent
5c571b0e1f
commit
07a9257ee9
@ -79,7 +79,7 @@
|
|||||||
return model if model
|
return model if model
|
||||||
else
|
else
|
||||||
# raise if data contains keys that are not known to the model
|
# raise if data contains keys that are not known to the model
|
||||||
raise unless (data.keys - const.acceptable_attributes).empty?
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
model = const.build_from_hash(data)
|
model = const.build_from_hash(data)
|
||||||
return model if model
|
return model if model
|
||||||
end
|
end
|
||||||
|
@ -121,7 +121,7 @@
|
|||||||
return model if model
|
return model if model
|
||||||
else
|
else
|
||||||
# raise if data contains keys that are not known to the model
|
# raise if data contains keys that are not known to the model
|
||||||
raise unless (data.keys - const.acceptable_attributes).empty?
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
model = const.build_from_hash(data)
|
model = const.build_from_hash(data)
|
||||||
return model if model
|
return model if model
|
||||||
end
|
end
|
||||||
|
@ -1313,7 +1313,7 @@ paths:
|
|||||||
operationId: getParameterNameMapping
|
operationId: getParameterNameMapping
|
||||||
parameters:
|
parameters:
|
||||||
- name: _type
|
- name: _type
|
||||||
in: header
|
in: header
|
||||||
description: _type
|
description: _type
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
@ -1326,7 +1326,7 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
- name: type_
|
- name: type_
|
||||||
in: header
|
in: header
|
||||||
description: type_
|
description: type_
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
@ -2091,6 +2091,9 @@ components:
|
|||||||
oneOf:
|
oneOf:
|
||||||
- $ref: '#/components/schemas/whale'
|
- $ref: '#/components/schemas/whale'
|
||||||
- $ref: '#/components/schemas/zebra'
|
- $ref: '#/components/schemas/zebra'
|
||||||
|
mamal_with_enum:
|
||||||
|
oneOf:
|
||||||
|
- $ref: '#/components/schemas/cow'
|
||||||
mammal:
|
mammal:
|
||||||
oneOf:
|
oneOf:
|
||||||
- $ref: '#/components/schemas/whale'
|
- $ref: '#/components/schemas/whale'
|
||||||
@ -2122,9 +2125,14 @@ components:
|
|||||||
required:
|
required:
|
||||||
- classname
|
- classname
|
||||||
additionalProperties: true
|
additionalProperties: true
|
||||||
|
cow:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- BlackAndWhiteCow
|
||||||
|
- BrownCow
|
||||||
PropertyNameMapping:
|
PropertyNameMapping:
|
||||||
properties:
|
properties:
|
||||||
http_debug_operation:
|
http_debug_operation:
|
||||||
type: string
|
type: string
|
||||||
_type:
|
_type:
|
||||||
type: string
|
type: string
|
||||||
|
@ -19,6 +19,7 @@ docs/Cat.md
|
|||||||
docs/Category.md
|
docs/Category.md
|
||||||
docs/ClassModel.md
|
docs/ClassModel.md
|
||||||
docs/Client.md
|
docs/Client.md
|
||||||
|
docs/Cow.md
|
||||||
docs/DefaultApi.md
|
docs/DefaultApi.md
|
||||||
docs/DeprecatedObject.md
|
docs/DeprecatedObject.md
|
||||||
docs/Dog.md
|
docs/Dog.md
|
||||||
@ -36,6 +37,7 @@ docs/FormatTest.md
|
|||||||
docs/HasOnlyReadOnly.md
|
docs/HasOnlyReadOnly.md
|
||||||
docs/HealthCheckResult.md
|
docs/HealthCheckResult.md
|
||||||
docs/List.md
|
docs/List.md
|
||||||
|
docs/MamalWithEnum.md
|
||||||
docs/Mammal.md
|
docs/Mammal.md
|
||||||
docs/MammalAnyof.md
|
docs/MammalAnyof.md
|
||||||
docs/MammalWithoutDiscriminator.md
|
docs/MammalWithoutDiscriminator.md
|
||||||
@ -91,6 +93,7 @@ lib/petstore/models/cat.rb
|
|||||||
lib/petstore/models/category.rb
|
lib/petstore/models/category.rb
|
||||||
lib/petstore/models/class_model.rb
|
lib/petstore/models/class_model.rb
|
||||||
lib/petstore/models/client.rb
|
lib/petstore/models/client.rb
|
||||||
|
lib/petstore/models/cow.rb
|
||||||
lib/petstore/models/deprecated_object.rb
|
lib/petstore/models/deprecated_object.rb
|
||||||
lib/petstore/models/dog.rb
|
lib/petstore/models/dog.rb
|
||||||
lib/petstore/models/enum_arrays.rb
|
lib/petstore/models/enum_arrays.rb
|
||||||
@ -105,6 +108,7 @@ lib/petstore/models/format_test.rb
|
|||||||
lib/petstore/models/has_only_read_only.rb
|
lib/petstore/models/has_only_read_only.rb
|
||||||
lib/petstore/models/health_check_result.rb
|
lib/petstore/models/health_check_result.rb
|
||||||
lib/petstore/models/list.rb
|
lib/petstore/models/list.rb
|
||||||
|
lib/petstore/models/mamal_with_enum.rb
|
||||||
lib/petstore/models/mammal.rb
|
lib/petstore/models/mammal.rb
|
||||||
lib/petstore/models/mammal_anyof.rb
|
lib/petstore/models/mammal_anyof.rb
|
||||||
lib/petstore/models/mammal_without_discriminator.rb
|
lib/petstore/models/mammal_without_discriminator.rb
|
||||||
@ -135,4 +139,6 @@ lib/petstore/models/whale.rb
|
|||||||
lib/petstore/models/zebra.rb
|
lib/petstore/models/zebra.rb
|
||||||
lib/petstore/version.rb
|
lib/petstore/version.rb
|
||||||
petstore.gemspec
|
petstore.gemspec
|
||||||
|
spec/models/cow_spec.rb
|
||||||
|
spec/models/mamal_with_enum_spec.rb
|
||||||
spec/spec_helper.rb
|
spec/spec_helper.rb
|
||||||
|
@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
|
|||||||
- [Petstore::Category](docs/Category.md)
|
- [Petstore::Category](docs/Category.md)
|
||||||
- [Petstore::ClassModel](docs/ClassModel.md)
|
- [Petstore::ClassModel](docs/ClassModel.md)
|
||||||
- [Petstore::Client](docs/Client.md)
|
- [Petstore::Client](docs/Client.md)
|
||||||
|
- [Petstore::Cow](docs/Cow.md)
|
||||||
- [Petstore::DeprecatedObject](docs/DeprecatedObject.md)
|
- [Petstore::DeprecatedObject](docs/DeprecatedObject.md)
|
||||||
- [Petstore::Dog](docs/Dog.md)
|
- [Petstore::Dog](docs/Dog.md)
|
||||||
- [Petstore::EnumArrays](docs/EnumArrays.md)
|
- [Petstore::EnumArrays](docs/EnumArrays.md)
|
||||||
@ -150,6 +151,7 @@ Class | Method | HTTP request | Description
|
|||||||
- [Petstore::HasOnlyReadOnly](docs/HasOnlyReadOnly.md)
|
- [Petstore::HasOnlyReadOnly](docs/HasOnlyReadOnly.md)
|
||||||
- [Petstore::HealthCheckResult](docs/HealthCheckResult.md)
|
- [Petstore::HealthCheckResult](docs/HealthCheckResult.md)
|
||||||
- [Petstore::List](docs/List.md)
|
- [Petstore::List](docs/List.md)
|
||||||
|
- [Petstore::MamalWithEnum](docs/MamalWithEnum.md)
|
||||||
- [Petstore::Mammal](docs/Mammal.md)
|
- [Petstore::Mammal](docs/Mammal.md)
|
||||||
- [Petstore::MammalAnyof](docs/MammalAnyof.md)
|
- [Petstore::MammalAnyof](docs/MammalAnyof.md)
|
||||||
- [Petstore::MammalWithoutDiscriminator](docs/MammalWithoutDiscriminator.md)
|
- [Petstore::MammalWithoutDiscriminator](docs/MammalWithoutDiscriminator.md)
|
||||||
|
15
samples/client/petstore/ruby-httpx/docs/Cow.md
Normal file
15
samples/client/petstore/ruby-httpx/docs/Cow.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Petstore::Cow
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Name | Type | Description | Notes |
|
||||||
|
| ---- | ---- | ----------- | ----- |
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
require 'petstore'
|
||||||
|
|
||||||
|
instance = Petstore::Cow.new()
|
||||||
|
```
|
||||||
|
|
47
samples/client/petstore/ruby-httpx/docs/MamalWithEnum.md
Normal file
47
samples/client/petstore/ruby-httpx/docs/MamalWithEnum.md
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
# Petstore::MamalWithEnum
|
||||||
|
|
||||||
|
## Class instance methods
|
||||||
|
|
||||||
|
### `openapi_one_of`
|
||||||
|
|
||||||
|
Returns the list of classes defined in oneOf.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
require 'petstore'
|
||||||
|
|
||||||
|
Petstore::MamalWithEnum.openapi_one_of
|
||||||
|
# =>
|
||||||
|
# [
|
||||||
|
# :'Cow'
|
||||||
|
# ]
|
||||||
|
```
|
||||||
|
|
||||||
|
### build
|
||||||
|
|
||||||
|
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
require 'petstore'
|
||||||
|
|
||||||
|
Petstore::MamalWithEnum.build(data)
|
||||||
|
# => #<Cow:0x00007fdd4aab02a0>
|
||||||
|
|
||||||
|
Petstore::MamalWithEnum.build(data_that_doesnt_match)
|
||||||
|
# => nil
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | ---- | ----------- |
|
||||||
|
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
||||||
|
|
||||||
|
#### Return type
|
||||||
|
|
||||||
|
- `Cow`
|
||||||
|
- `nil` (if no type matches)
|
||||||
|
|
@ -28,6 +28,7 @@ require 'petstore/models/capitalization'
|
|||||||
require 'petstore/models/category'
|
require 'petstore/models/category'
|
||||||
require 'petstore/models/class_model'
|
require 'petstore/models/class_model'
|
||||||
require 'petstore/models/client'
|
require 'petstore/models/client'
|
||||||
|
require 'petstore/models/cow'
|
||||||
require 'petstore/models/deprecated_object'
|
require 'petstore/models/deprecated_object'
|
||||||
require 'petstore/models/enum_arrays'
|
require 'petstore/models/enum_arrays'
|
||||||
require 'petstore/models/enum_class'
|
require 'petstore/models/enum_class'
|
||||||
@ -41,6 +42,7 @@ require 'petstore/models/format_test'
|
|||||||
require 'petstore/models/has_only_read_only'
|
require 'petstore/models/has_only_read_only'
|
||||||
require 'petstore/models/health_check_result'
|
require 'petstore/models/health_check_result'
|
||||||
require 'petstore/models/list'
|
require 'petstore/models/list'
|
||||||
|
require 'petstore/models/mamal_with_enum'
|
||||||
require 'petstore/models/mammal'
|
require 'petstore/models/mammal'
|
||||||
require 'petstore/models/mammal_anyof'
|
require 'petstore/models/mammal_anyof'
|
||||||
require 'petstore/models/mammal_without_discriminator'
|
require 'petstore/models/mammal_without_discriminator'
|
||||||
|
@ -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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'date'
|
||||||
|
require 'time'
|
||||||
|
|
||||||
|
module Petstore
|
||||||
|
class Cow
|
||||||
|
BLACK_AND_WHITE_COW = "BlackAndWhiteCow".freeze
|
||||||
|
BROWN_COW = "BrownCow".freeze
|
||||||
|
|
||||||
|
def self.all_vars
|
||||||
|
@all_vars ||= [BLACK_AND_WHITE_COW, BROWN_COW].freeze
|
||||||
|
end
|
||||||
|
|
||||||
|
# Builds the enum from string
|
||||||
|
# @param [String] The enum value in the form of the string
|
||||||
|
# @return [String] The enum value
|
||||||
|
def self.build_from_hash(value)
|
||||||
|
new.build_from_hash(value)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Builds the enum from string
|
||||||
|
# @param [String] The enum value in the form of the string
|
||||||
|
# @return [String] The enum value
|
||||||
|
def build_from_hash(value)
|
||||||
|
return value if Cow.all_vars.include?(value)
|
||||||
|
raise "Invalid ENUM value #{value} for class #Cow"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
@ -0,0 +1,104 @@
|
|||||||
|
=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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'date'
|
||||||
|
require 'time'
|
||||||
|
|
||||||
|
module Petstore
|
||||||
|
module MamalWithEnum
|
||||||
|
class << self
|
||||||
|
# List of class defined in oneOf (OpenAPI v3)
|
||||||
|
def openapi_one_of
|
||||||
|
[
|
||||||
|
:'Cow'
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Builds the object
|
||||||
|
# @param [Mixed] Data to be matched against the list of oneOf items
|
||||||
|
# @return [Object] Returns the model or the data itself
|
||||||
|
def build(data)
|
||||||
|
# Go through the list of oneOf items and attempt to identify the appropriate one.
|
||||||
|
# Note:
|
||||||
|
# - We do not attempt to check whether exactly one item matches.
|
||||||
|
# - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
|
||||||
|
# due to the way the deserialization is made in the base_object template (it just casts without verifying).
|
||||||
|
# - TODO: scalar values are de facto behaving as if they were nullable.
|
||||||
|
# - TODO: logging when debugging is set.
|
||||||
|
openapi_one_of.each do |klass|
|
||||||
|
begin
|
||||||
|
next if klass == :AnyType # "nullable: true"
|
||||||
|
typed_data = find_and_cast_into_type(klass, data)
|
||||||
|
return typed_data if typed_data
|
||||||
|
rescue # rescue all errors so we keep iterating even if the current item lookup raises
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
openapi_one_of.include?(:AnyType) ? data : nil
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
SchemaMismatchError = Class.new(StandardError)
|
||||||
|
|
||||||
|
# Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
|
||||||
|
def find_and_cast_into_type(klass, data)
|
||||||
|
return if data.nil?
|
||||||
|
|
||||||
|
case klass.to_s
|
||||||
|
when 'Boolean'
|
||||||
|
return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
|
||||||
|
when 'Float'
|
||||||
|
return data if data.instance_of?(Float)
|
||||||
|
when 'Integer'
|
||||||
|
return data if data.instance_of?(Integer)
|
||||||
|
when 'Time'
|
||||||
|
return Time.parse(data)
|
||||||
|
when 'Date'
|
||||||
|
return Date.parse(data)
|
||||||
|
when 'String'
|
||||||
|
return data if data.instance_of?(String)
|
||||||
|
when 'Object' # "type: object"
|
||||||
|
return data if data.instance_of?(Hash)
|
||||||
|
when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
|
||||||
|
if data.instance_of?(Array)
|
||||||
|
sub_type = Regexp.last_match[:sub_type]
|
||||||
|
return data.map { |item| find_and_cast_into_type(sub_type, item) }
|
||||||
|
end
|
||||||
|
when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
|
||||||
|
if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
|
||||||
|
sub_type = Regexp.last_match[:sub_type]
|
||||||
|
return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
|
||||||
|
end
|
||||||
|
else # model
|
||||||
|
const = Petstore.const_get(klass)
|
||||||
|
if const
|
||||||
|
if const.respond_to?(:openapi_one_of) # nested oneOf model
|
||||||
|
model = const.build(data)
|
||||||
|
return model if model
|
||||||
|
else
|
||||||
|
# raise if data contains keys that are not known to the model
|
||||||
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
|
model = const.build_from_hash(data)
|
||||||
|
return model if model
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
raise # if no match by now, raise
|
||||||
|
rescue
|
||||||
|
raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
@ -87,7 +87,7 @@ module Petstore
|
|||||||
return model if model
|
return model if model
|
||||||
else
|
else
|
||||||
# raise if data contains keys that are not known to the model
|
# raise if data contains keys that are not known to the model
|
||||||
raise unless (data.keys - const.acceptable_attributes).empty?
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
model = const.build_from_hash(data)
|
model = const.build_from_hash(data)
|
||||||
return model if model
|
return model if model
|
||||||
end
|
end
|
||||||
|
@ -88,7 +88,7 @@ module Petstore
|
|||||||
return model if model
|
return model if model
|
||||||
else
|
else
|
||||||
# raise if data contains keys that are not known to the model
|
# raise if data contains keys that are not known to the model
|
||||||
raise unless (data.keys - const.acceptable_attributes).empty?
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
model = const.build_from_hash(data)
|
model = const.build_from_hash(data)
|
||||||
return model if model
|
return model if model
|
||||||
end
|
end
|
||||||
|
30
samples/client/petstore/ruby-httpx/spec/models/cow_spec.rb
Normal file
30
samples/client/petstore/ruby-httpx/spec/models/cow_spec.rb
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
=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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'spec_helper'
|
||||||
|
require 'json'
|
||||||
|
require 'date'
|
||||||
|
|
||||||
|
# Unit tests for Petstore::Cow
|
||||||
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
||||||
|
# Please update as you see appropriate
|
||||||
|
describe Petstore::Cow do
|
||||||
|
let(:instance) { Petstore::Cow.new }
|
||||||
|
|
||||||
|
describe 'test an instance of Cow' do
|
||||||
|
it 'should create an instance of Cow' do
|
||||||
|
# uncomment below to test the instance creation
|
||||||
|
#expect(instance).to be_instance_of(Petstore::Cow)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
@ -0,0 +1,32 @@
|
|||||||
|
=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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'spec_helper'
|
||||||
|
require 'json'
|
||||||
|
require 'date'
|
||||||
|
|
||||||
|
# Unit tests for Petstore::MamalWithEnum
|
||||||
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
||||||
|
# Please update as you see appropriate
|
||||||
|
describe Petstore::MamalWithEnum do
|
||||||
|
describe '.openapi_one_of' do
|
||||||
|
it 'lists the items referenced in the oneOf array' do
|
||||||
|
expect(described_class.openapi_one_of).to_not be_empty
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '.build' do
|
||||||
|
it 'returns the correct model' do
|
||||||
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
@ -19,6 +19,7 @@ docs/Cat.md
|
|||||||
docs/Category.md
|
docs/Category.md
|
||||||
docs/ClassModel.md
|
docs/ClassModel.md
|
||||||
docs/Client.md
|
docs/Client.md
|
||||||
|
docs/Cow.md
|
||||||
docs/DefaultApi.md
|
docs/DefaultApi.md
|
||||||
docs/DeprecatedObject.md
|
docs/DeprecatedObject.md
|
||||||
docs/Dog.md
|
docs/Dog.md
|
||||||
@ -36,6 +37,7 @@ docs/FormatTest.md
|
|||||||
docs/HasOnlyReadOnly.md
|
docs/HasOnlyReadOnly.md
|
||||||
docs/HealthCheckResult.md
|
docs/HealthCheckResult.md
|
||||||
docs/List.md
|
docs/List.md
|
||||||
|
docs/MamalWithEnum.md
|
||||||
docs/Mammal.md
|
docs/Mammal.md
|
||||||
docs/MammalAnyof.md
|
docs/MammalAnyof.md
|
||||||
docs/MammalWithoutDiscriminator.md
|
docs/MammalWithoutDiscriminator.md
|
||||||
@ -91,6 +93,7 @@ lib/petstore/models/cat.rb
|
|||||||
lib/petstore/models/category.rb
|
lib/petstore/models/category.rb
|
||||||
lib/petstore/models/class_model.rb
|
lib/petstore/models/class_model.rb
|
||||||
lib/petstore/models/client.rb
|
lib/petstore/models/client.rb
|
||||||
|
lib/petstore/models/cow.rb
|
||||||
lib/petstore/models/deprecated_object.rb
|
lib/petstore/models/deprecated_object.rb
|
||||||
lib/petstore/models/dog.rb
|
lib/petstore/models/dog.rb
|
||||||
lib/petstore/models/enum_arrays.rb
|
lib/petstore/models/enum_arrays.rb
|
||||||
@ -105,6 +108,7 @@ lib/petstore/models/format_test.rb
|
|||||||
lib/petstore/models/has_only_read_only.rb
|
lib/petstore/models/has_only_read_only.rb
|
||||||
lib/petstore/models/health_check_result.rb
|
lib/petstore/models/health_check_result.rb
|
||||||
lib/petstore/models/list.rb
|
lib/petstore/models/list.rb
|
||||||
|
lib/petstore/models/mamal_with_enum.rb
|
||||||
lib/petstore/models/mammal.rb
|
lib/petstore/models/mammal.rb
|
||||||
lib/petstore/models/mammal_anyof.rb
|
lib/petstore/models/mammal_anyof.rb
|
||||||
lib/petstore/models/mammal_without_discriminator.rb
|
lib/petstore/models/mammal_without_discriminator.rb
|
||||||
@ -135,4 +139,6 @@ lib/petstore/models/whale.rb
|
|||||||
lib/petstore/models/zebra.rb
|
lib/petstore/models/zebra.rb
|
||||||
lib/petstore/version.rb
|
lib/petstore/version.rb
|
||||||
petstore.gemspec
|
petstore.gemspec
|
||||||
|
spec/models/cow_spec.rb
|
||||||
|
spec/models/mamal_with_enum_spec.rb
|
||||||
spec/spec_helper.rb
|
spec/spec_helper.rb
|
||||||
|
@ -136,6 +136,7 @@ Class | Method | HTTP request | Description
|
|||||||
- [Petstore::Category](docs/Category.md)
|
- [Petstore::Category](docs/Category.md)
|
||||||
- [Petstore::ClassModel](docs/ClassModel.md)
|
- [Petstore::ClassModel](docs/ClassModel.md)
|
||||||
- [Petstore::Client](docs/Client.md)
|
- [Petstore::Client](docs/Client.md)
|
||||||
|
- [Petstore::Cow](docs/Cow.md)
|
||||||
- [Petstore::DeprecatedObject](docs/DeprecatedObject.md)
|
- [Petstore::DeprecatedObject](docs/DeprecatedObject.md)
|
||||||
- [Petstore::Dog](docs/Dog.md)
|
- [Petstore::Dog](docs/Dog.md)
|
||||||
- [Petstore::EnumArrays](docs/EnumArrays.md)
|
- [Petstore::EnumArrays](docs/EnumArrays.md)
|
||||||
@ -150,6 +151,7 @@ Class | Method | HTTP request | Description
|
|||||||
- [Petstore::HasOnlyReadOnly](docs/HasOnlyReadOnly.md)
|
- [Petstore::HasOnlyReadOnly](docs/HasOnlyReadOnly.md)
|
||||||
- [Petstore::HealthCheckResult](docs/HealthCheckResult.md)
|
- [Petstore::HealthCheckResult](docs/HealthCheckResult.md)
|
||||||
- [Petstore::List](docs/List.md)
|
- [Petstore::List](docs/List.md)
|
||||||
|
- [Petstore::MamalWithEnum](docs/MamalWithEnum.md)
|
||||||
- [Petstore::Mammal](docs/Mammal.md)
|
- [Petstore::Mammal](docs/Mammal.md)
|
||||||
- [Petstore::MammalAnyof](docs/MammalAnyof.md)
|
- [Petstore::MammalAnyof](docs/MammalAnyof.md)
|
||||||
- [Petstore::MammalWithoutDiscriminator](docs/MammalWithoutDiscriminator.md)
|
- [Petstore::MammalWithoutDiscriminator](docs/MammalWithoutDiscriminator.md)
|
||||||
|
15
samples/client/petstore/ruby/docs/Cow.md
Normal file
15
samples/client/petstore/ruby/docs/Cow.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
# Petstore::Cow
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
| Name | Type | Description | Notes |
|
||||||
|
| ---- | ---- | ----------- | ----- |
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
require 'petstore'
|
||||||
|
|
||||||
|
instance = Petstore::Cow.new()
|
||||||
|
```
|
||||||
|
|
47
samples/client/petstore/ruby/docs/MamalWithEnum.md
Normal file
47
samples/client/petstore/ruby/docs/MamalWithEnum.md
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
# Petstore::MamalWithEnum
|
||||||
|
|
||||||
|
## Class instance methods
|
||||||
|
|
||||||
|
### `openapi_one_of`
|
||||||
|
|
||||||
|
Returns the list of classes defined in oneOf.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
require 'petstore'
|
||||||
|
|
||||||
|
Petstore::MamalWithEnum.openapi_one_of
|
||||||
|
# =>
|
||||||
|
# [
|
||||||
|
# :'Cow'
|
||||||
|
# ]
|
||||||
|
```
|
||||||
|
|
||||||
|
### build
|
||||||
|
|
||||||
|
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
|
||||||
|
```ruby
|
||||||
|
require 'petstore'
|
||||||
|
|
||||||
|
Petstore::MamalWithEnum.build(data)
|
||||||
|
# => #<Cow:0x00007fdd4aab02a0>
|
||||||
|
|
||||||
|
Petstore::MamalWithEnum.build(data_that_doesnt_match)
|
||||||
|
# => nil
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | ---- | ----------- |
|
||||||
|
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
||||||
|
|
||||||
|
#### Return type
|
||||||
|
|
||||||
|
- `Cow`
|
||||||
|
- `nil` (if no type matches)
|
||||||
|
|
@ -28,6 +28,7 @@ require 'petstore/models/capitalization'
|
|||||||
require 'petstore/models/category'
|
require 'petstore/models/category'
|
||||||
require 'petstore/models/class_model'
|
require 'petstore/models/class_model'
|
||||||
require 'petstore/models/client'
|
require 'petstore/models/client'
|
||||||
|
require 'petstore/models/cow'
|
||||||
require 'petstore/models/deprecated_object'
|
require 'petstore/models/deprecated_object'
|
||||||
require 'petstore/models/enum_arrays'
|
require 'petstore/models/enum_arrays'
|
||||||
require 'petstore/models/enum_class'
|
require 'petstore/models/enum_class'
|
||||||
@ -41,6 +42,7 @@ require 'petstore/models/format_test'
|
|||||||
require 'petstore/models/has_only_read_only'
|
require 'petstore/models/has_only_read_only'
|
||||||
require 'petstore/models/health_check_result'
|
require 'petstore/models/health_check_result'
|
||||||
require 'petstore/models/list'
|
require 'petstore/models/list'
|
||||||
|
require 'petstore/models/mamal_with_enum'
|
||||||
require 'petstore/models/mammal'
|
require 'petstore/models/mammal'
|
||||||
require 'petstore/models/mammal_anyof'
|
require 'petstore/models/mammal_anyof'
|
||||||
require 'petstore/models/mammal_without_discriminator'
|
require 'petstore/models/mammal_without_discriminator'
|
||||||
|
40
samples/client/petstore/ruby/lib/petstore/models/cow.rb
Normal file
40
samples/client/petstore/ruby/lib/petstore/models/cow.rb
Normal 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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'date'
|
||||||
|
require 'time'
|
||||||
|
|
||||||
|
module Petstore
|
||||||
|
class Cow
|
||||||
|
BLACK_AND_WHITE_COW = "BlackAndWhiteCow".freeze
|
||||||
|
BROWN_COW = "BrownCow".freeze
|
||||||
|
|
||||||
|
def self.all_vars
|
||||||
|
@all_vars ||= [BLACK_AND_WHITE_COW, BROWN_COW].freeze
|
||||||
|
end
|
||||||
|
|
||||||
|
# Builds the enum from string
|
||||||
|
# @param [String] The enum value in the form of the string
|
||||||
|
# @return [String] The enum value
|
||||||
|
def self.build_from_hash(value)
|
||||||
|
new.build_from_hash(value)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Builds the enum from string
|
||||||
|
# @param [String] The enum value in the form of the string
|
||||||
|
# @return [String] The enum value
|
||||||
|
def build_from_hash(value)
|
||||||
|
return value if Cow.all_vars.include?(value)
|
||||||
|
raise "Invalid ENUM value #{value} for class #Cow"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
@ -0,0 +1,104 @@
|
|||||||
|
=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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'date'
|
||||||
|
require 'time'
|
||||||
|
|
||||||
|
module Petstore
|
||||||
|
module MamalWithEnum
|
||||||
|
class << self
|
||||||
|
# List of class defined in oneOf (OpenAPI v3)
|
||||||
|
def openapi_one_of
|
||||||
|
[
|
||||||
|
:'Cow'
|
||||||
|
]
|
||||||
|
end
|
||||||
|
|
||||||
|
# Builds the object
|
||||||
|
# @param [Mixed] Data to be matched against the list of oneOf items
|
||||||
|
# @return [Object] Returns the model or the data itself
|
||||||
|
def build(data)
|
||||||
|
# Go through the list of oneOf items and attempt to identify the appropriate one.
|
||||||
|
# Note:
|
||||||
|
# - We do not attempt to check whether exactly one item matches.
|
||||||
|
# - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
|
||||||
|
# due to the way the deserialization is made in the base_object template (it just casts without verifying).
|
||||||
|
# - TODO: scalar values are de facto behaving as if they were nullable.
|
||||||
|
# - TODO: logging when debugging is set.
|
||||||
|
openapi_one_of.each do |klass|
|
||||||
|
begin
|
||||||
|
next if klass == :AnyType # "nullable: true"
|
||||||
|
typed_data = find_and_cast_into_type(klass, data)
|
||||||
|
return typed_data if typed_data
|
||||||
|
rescue # rescue all errors so we keep iterating even if the current item lookup raises
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
openapi_one_of.include?(:AnyType) ? data : nil
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
SchemaMismatchError = Class.new(StandardError)
|
||||||
|
|
||||||
|
# Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
|
||||||
|
def find_and_cast_into_type(klass, data)
|
||||||
|
return if data.nil?
|
||||||
|
|
||||||
|
case klass.to_s
|
||||||
|
when 'Boolean'
|
||||||
|
return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
|
||||||
|
when 'Float'
|
||||||
|
return data if data.instance_of?(Float)
|
||||||
|
when 'Integer'
|
||||||
|
return data if data.instance_of?(Integer)
|
||||||
|
when 'Time'
|
||||||
|
return Time.parse(data)
|
||||||
|
when 'Date'
|
||||||
|
return Date.parse(data)
|
||||||
|
when 'String'
|
||||||
|
return data if data.instance_of?(String)
|
||||||
|
when 'Object' # "type: object"
|
||||||
|
return data if data.instance_of?(Hash)
|
||||||
|
when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
|
||||||
|
if data.instance_of?(Array)
|
||||||
|
sub_type = Regexp.last_match[:sub_type]
|
||||||
|
return data.map { |item| find_and_cast_into_type(sub_type, item) }
|
||||||
|
end
|
||||||
|
when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
|
||||||
|
if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
|
||||||
|
sub_type = Regexp.last_match[:sub_type]
|
||||||
|
return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
|
||||||
|
end
|
||||||
|
else # model
|
||||||
|
const = Petstore.const_get(klass)
|
||||||
|
if const
|
||||||
|
if const.respond_to?(:openapi_one_of) # nested oneOf model
|
||||||
|
model = const.build(data)
|
||||||
|
return model if model
|
||||||
|
else
|
||||||
|
# raise if data contains keys that are not known to the model
|
||||||
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
|
model = const.build_from_hash(data)
|
||||||
|
return model if model
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
raise # if no match by now, raise
|
||||||
|
rescue
|
||||||
|
raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
@ -87,7 +87,7 @@ module Petstore
|
|||||||
return model if model
|
return model if model
|
||||||
else
|
else
|
||||||
# raise if data contains keys that are not known to the model
|
# raise if data contains keys that are not known to the model
|
||||||
raise unless (data.keys - const.acceptable_attributes).empty?
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
model = const.build_from_hash(data)
|
model = const.build_from_hash(data)
|
||||||
return model if model
|
return model if model
|
||||||
end
|
end
|
||||||
|
@ -88,7 +88,7 @@ module Petstore
|
|||||||
return model if model
|
return model if model
|
||||||
else
|
else
|
||||||
# raise if data contains keys that are not known to the model
|
# raise if data contains keys that are not known to the model
|
||||||
raise unless (data.keys - const.acceptable_attributes).empty?
|
raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
|
||||||
model = const.build_from_hash(data)
|
model = const.build_from_hash(data)
|
||||||
return model if model
|
return model if model
|
||||||
end
|
end
|
||||||
|
30
samples/client/petstore/ruby/spec/models/cow_spec.rb
Normal file
30
samples/client/petstore/ruby/spec/models/cow_spec.rb
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
=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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'spec_helper'
|
||||||
|
require 'json'
|
||||||
|
require 'date'
|
||||||
|
|
||||||
|
# Unit tests for Petstore::Cow
|
||||||
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
||||||
|
# Please update as you see appropriate
|
||||||
|
describe Petstore::Cow do
|
||||||
|
let(:instance) { Petstore::Cow.new }
|
||||||
|
|
||||||
|
describe 'test an instance of Cow' do
|
||||||
|
it 'should create an instance of Cow' do
|
||||||
|
# uncomment below to test the instance creation
|
||||||
|
#expect(instance).to be_instance_of(Petstore::Cow)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
@ -0,0 +1,36 @@
|
|||||||
|
=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: 7.3.0-SNAPSHOT
|
||||||
|
|
||||||
|
=end
|
||||||
|
|
||||||
|
require 'spec_helper'
|
||||||
|
require 'json'
|
||||||
|
require 'date'
|
||||||
|
|
||||||
|
# Unit tests for Petstore::MamalWithEnum
|
||||||
|
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
||||||
|
# Please update as you see appropriate
|
||||||
|
describe Petstore::MamalWithEnum do
|
||||||
|
describe '.openapi_one_of' do
|
||||||
|
it 'lists the items referenced in the oneOf array' do
|
||||||
|
expect(described_class.openapi_one_of).to_not be_empty
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
describe '.build' do
|
||||||
|
it 'returns the correct model' do
|
||||||
|
expect(described_class.build("BlackAndWhiteCow")).to eq(Petstore::Cow::BLACK_AND_WHITE_COW)
|
||||||
|
end
|
||||||
|
|
||||||
|
it 'returns nil for unknown model' do
|
||||||
|
expect(described_class.build({ classname: 'monkey', type: 'gorilla' })).to be_nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
Loading…
x
Reference in New Issue
Block a user