"required": true for a property. Does the codgen support it?
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 35/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- typescript
- 领域
- devtools
调研方向
Start by tracing how the generator reads Schema Object properties and determines whether each TypeScript property is optional; no source file or test is named in the issue. Compare handling of the object-level required array with property-level required values, then add or update coverage so the supported behavior is explicit in the generated output.
由索引模型根据 Issue 内容生成。
描述
I have a Schema Object
{
"Obj": {
"description": "Obj",
"required": [
"id",
"foo"
],
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"foo": {
"type": "string",
"pattern": "^[0-9a-f]{32}$"
},
"bar": {
"type": "string",
"pattern": "^[0-9a-f]{32}$"
}
}
}
}
With this ShemaObject, a type generates perfectly fine.
/**
* Obj
*/
export type Obj = {
/**
* @pattern ^[0-9a-f]{32}$
*/
id: string;
/**
* @pattern ^[0-9a-f]{32}$
*/
foo: string;
/**
* @pattern ^[0-9a-f]{32}$
*/
bar?: string;
};
But if I move/distribute required to properties like this
{
"Obj": {
"description": "Obj",
"properties": {
"id": {
"type": "string",
"pattern": "^[0-9a-f]{32}$",
"required": true
},
"foo": {
"type": "string",
"pattern": "^[0-9a-f]{32}$",
"required": true
},
"bar": {
"type": "string",
"pattern": "^[0-9a-f]{32}$"
}
}
}
}
It generates this:
/**
* Obj
*/
export type Obj = {
/**
* @pattern ^[0-9a-f]{32}$
*/
id?: string;
/**
* @pattern ^[0-9a-f]{32}$
*/
foo?: string;
/**
* @pattern ^[0-9a-f]{32}$
*/
bar?: string;
};
Conclusion:
It ignores this approach of requiring fields if the required is set at the property level. Is it a bug? Is it possible to set up this approach?
- 主要语言
- TypeScript
- 星标
- 635
- 派生
- 82
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
fabien0102/openapi-codegen 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
fabien0102/openapi-codegen#343 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
fabien0102/openapi-codegen#342 ·
-
难度 5/5 一周以上 新手友好度 30/100
fabien0102/openapi-codegen#356 ·
-
update dependencies & removed unused deprecated可能已有人在做 @el-j 于 20 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 25/100
fabien0102/openapi-codegen#354 · 1 条评论 ·
-
deepMerge mutates its arguments, corrupting request payloads across calls可能已有人在做 @richard-willis-chevin 于 64 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 72/100
fabien0102/openapi-codegen#349 ·
查看 fabien0102/openapi-codegen 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 2/5 1 小时以内 新手友好度 80/100
nuxt-content/nuxt-studio#599 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 79/100
hurttlocker/o8#4997 ·
-
难度 2/5 1-3 小时 新手友好度 76/100
danielmiessler/LifeOS#2413 ·
维护者通常 3 天内回复
-
Plugin: sheet music can't be scrolled by hand before playback可能已有人在做 @snakajima 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 78/100
receptron/jinglescript#51 ·
维护者通常 1 天内回复