[BUG][RUBY-NEXTGEN] A model with properties and additionalProperties is serialized as {} when nested

Open
#25,714 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
67/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
java, ruby
Domain
api, backend

Research direction

Start by reading the ruby-nextgen model generation and serialization code, especially Serializable.serialize and the template that generates models with additionalProperties; the payload does not name their file paths. Reproduce with the provided OpenAPI schema and the nested Box/Shape example. Done when nested properties and array items serialize with their fields, empty? reflects populated data, and the generated gem passes the reported RuboCop check.

Written by the indexing model from the issue text.

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
Description

A schema that declares both properties and additionalProperties is generated as class Shape < Hash. Its attributes live in instance variables, so the Hash part stays empty. Serializable.serialize tests when Hash before it tries to_hash, so as soon as such a model is nested in another model (a property, or an item of an array), it is serialized as {} and its data never reaches the request body.

Serializing the model on its own works, because to_hash is then called directly.

Two side effects of the same < Hash: shape.empty? is true on a populated model, and the generated gem fails its own RuboCop config (Lint/MissingSuper on initialize).

openapi-generator version

master, 7.28.0-SNAPSHOT, 8a9fb722777e770e2c44b20b00bddbb51a0d525a

OpenAPI declaration file content or url
openapi: 3.0.3
info:
  title: additionalProperties
  version: 1.0.0
paths:
  /boxes:
    post:
      operationId: createBox
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Box'
      responses:
        '200':
          description: OK
components:
  schemas:
    Box:
      type: object
      properties:
        shape:
          $ref: '#/components/schemas/Shape'
        shapes:
          type: array
          items:
            $ref: '#/components/schemas/Shape'
    Shape:
      type: object
      properties:
        kind:
          type: string
      additionalProperties:
        type: string
Generation Details
java -jar openapi-generator-cli.jar generate -g ruby-nextgen -i spec.yaml -o out \
  --additional-properties=gemName=petstore,moduleName=Petstore
Steps to reproduce
$LOAD_PATH.unshift 'out/lib'
require 'petstore'

shape = Petstore::Models::Shape.new(kind: 'round', size: 'big')
puts shape.to_json
puts shape.empty?
puts Petstore::Models::Box.new(shape: shape, shapes: [shape]).to_json

Actual (ruby 4.0.9, faraday 2.15.1):

{"kind":"round","size":"big"}
true
{"shape":{},"shapes":[{}]}

Expected:

{"kind":"round","size":"big"}
false
{"shape":{"kind":"round","size":"big"},"shapes":[{"kind":"round","size":"big"}]}

bin/rubocop lib in the generated gem:

lib/petstore/models/shape.rb:23:7: W: Lint/MissingSuper: Call super to initialize state of the parent class.
Related issues/PRs

None found.

Suggest a fix

Either stop inheriting from Hash for these models (additional_properties already holds the extra keys), or make Serializable.serialize try to_hash on models before the when Hash branch.

Dominant language
Java
Stars
26.9k
Forks
7.8k
Avg merge
2d 23m
Merged PRs (30d)
177

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenAPITools/openapi-generator

All issues in OpenAPITools/openapi-generator

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.