[BUG][RUBY-NEXTGEN] A model with properties and additionalProperties is serialized as {} when nested
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 67/100
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
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.
- Langage dominant
- Java
- Étoiles
- 26.9k
- Forks
- 7.8k
- Merge moyen
- 2 j 23 min
- PR mergées (30 j)
- 177
Préparer son environnement
Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.
- Fournit un Dockerfile ou un fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OpenAPITools/openapi-generator
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25768 ·
Les mainteneurs répondent en général sous 1 jour
-
Enhancement: Feature
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
OpenAPITools/openapi-generator#25753 ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A non-String value in a pattern-constrained attribute raises NoMethodErrorPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
OpenAPITools/openapi-generator#25724 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] Response#to_hash is advertised and raises when the data is an ArrayPeut-être pris @Inf1mum l’a pris il y a 3 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25723 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG][RUBY-NEXTGEN] A JSON string response raises ApiError because the body is parsed twicePeut-être pris @Inf1mum l’a pris il y a 2 jours. Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 77/100
OpenAPITools/openapi-generator#25719 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de OpenAPITools/openapi-generator
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
eclipse-tradista/tradista#371 ·
Les mainteneurs répondent en général sous 1 jour
-
Failed to start Rescue missionOuvertecritical
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
mars-sim/mars-sim#2199 · 2 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
[BUG-02] Endpoints /assistente/relatorio/*/preview retornam 404 ("Ver na tela" dos relatórios)Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
projeto-ong-amar/projeto-ong-amar-backend#26 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
primefaces/primefaces#15568 ·
Les mainteneurs répondent en général sous 1 jour
-
崩溃日志只按 CRLF 分行Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
PCL-Community/PCL-CE#3872 ·
Les mainteneurs répondent en général sous 1 jour