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

Abierto
#25,714 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
67/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
java, ruby
Área
api, backend

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Java
Estrellas
26.9k
Forks
7.8k
Merge medio
2 d 23 min
PR fusionados (30 d)
177

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenAPITools/openapi-generator

Todos los issues de OpenAPITools/openapi-generator

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.