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

未关闭
#25,714 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
67/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
java, ruby
领域
api, backend

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
Java
星标
26.9k
派生
7.8k
平均合并
2 天 23 分钟
30 天内合并 PR
177

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

OpenAPITools/openapi-generator 的其他 Issue

查看 OpenAPITools/openapi-generator 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。