Correct handling of `style` and `explode`.
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- typescript
- 领域
- tooling
调研方向
Start by locating the query-parameter generation entry point and its handling of OpenAPI parameter style and explode defaults. Compare the generated TypeScript with the OpenAPI 3.0 Parameter Object rules, then add or update tests so the intended output for form-style query parameters is explicit and covered.
由索引模型根据 Issue 内容生成。
描述
OpenAPI spec:
targets:
get:
tags:
- targets
operationId: getProductTargets
parameters:
- name: searchParameters
description: "Some description"
in: query
required: true
schema:
$ref: "..ProductTargetsSearch"
responses:
200:
description: "Some description"
content:
application/json:
schema:
$ref: "..GetProductTargetsResponse"
400:
description: "Some description"
content:
application/json:
schema:
$ref: "..ErrorDto"
500:
description: "Ошибка на сервере"
content:
application/json:
schema:
$ref: "..ErrorDto"
Generator emits type for queryParams:
export type GetProductTargetsQueryParams = {
/**
* Some description
*/
searchParameters: Schemas.ProductTargetsSearch;
};
But by spec https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#parameter-object
parameter in: query has default value of style - form. So explode default value is true for form style. Spec says:
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map
Should generator emit queryParam type with spreaded params? if no, why?
- 主要语言
- 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 于 19 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 25/100
fabien0102/openapi-codegen#354 ·
-
deepMerge mutates its arguments, corrupting request payloads across calls可能已有人在做 @richard-willis-chevin 于 63 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 72/100
fabien0102/openapi-codegen#349 ·
查看 fabien0102/openapi-codegen 的全部 Issue
相似的 Issue
-
ready
难度 2/5 1-3 小时 新手友好度 63/100
wheresrhys/totf#1214 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
CodeChefVIT/ffcs#281 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 83/100
endora-commerce/endora-commerce#451 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 65/100
vetro-protocol/vetro-monorepo#1007 ·
维护者通常 1 天内回复