[BUG][RUBY-NEXTGEN] A model with properties and additionalProperties is serialized as {} when nested
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 67/100
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
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenAPITools/openapi-generator
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25768 ·
Maintainers usually reply within 1 day
-
Enhancement: Feature
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OpenAPITools/openapi-generator#25753 ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
OpenAPITools/openapi-generator#25724 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25723 · 1 comment ·
Maintainers usually reply within 1 day
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePossibly taken @Inf1mum claimed this 2 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
OpenAPITools/openapi-generator#25719 · 1 comment ·
Maintainers usually reply within 1 day
All issues in OpenAPITools/openapi-generator
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
eclipse-tradista/tradista#371 ·
Maintainers usually reply within 1 day
-
critical
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
mars-sim/mars-sim#2199 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
primefaces/primefaces#15568 ·
Maintainers usually reply within 1 day
-
崩溃日志只按 CRLF 分行Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PCL-Community/PCL-CE#3872 ·
Maintainers usually reply within 1 day