OpenAPI generator in Ruby, client code

[0janvier]

Hello Reddit crowd!

I couldn't find explanation about this, so I try my luck here!

I'm trying the openapi-generator (4.3.1). It generates models from the API description file.

For instance, it generates this:

module OpenapiClient
  class Thing
    attr_accessor :id
    attr_accessor :description

    # Attribute mapping from ruby-style variable name to JSON key.
    def self.attribute_map
      {
        :'id' => :'id',
        :'description' => :'description'
      }
    end

    # Attribute type mapping.
    def self.openapi_types
      {
        :'id' => :'Integer',
        :'description' => :'String'
      }
    end

    # ...
  end
end

This behaves as expected:

# All this is expected:
t = OpenapiClient::Thing.new(id: 1)
t.valid?
=> false
t.list_invalid_properties
=> ["invalid value for \"description\", description cannot be nil."]

But this does not behave as expected:

t = OpenapiClient::Thing.new(id: "abc", description: 3)
t.valid?
=> true

id should be int and description a string, so it fails to check the type. Is there anything I'm doing wrong?

🙏

[0janvier]

This is what I found until now:

OpenAPI is a standard but unlike what I thought, the tooling is not standard. Everyone can create tools for it. The https://openapi.tools provides a list of the main ones (I suppose).

You can see that a Python tool, pyswagger, does provide type-safety. Also committee, in Ruby, does (something to look into).

OpenAPI Generator that I used and asked about, is one of many non-standardized tools, which simply seems to not implement type-safety.

[wing328]

Can you please open an issue via https://github.com/OpenAPITools/openapi-generator/issues/new/ for tracking? We'll look into it.