Improve OpenAPI response schemas by marking guaranteed properties as required
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- openapi
调研方向
Start by locating the OpenAPI response schemas and comparing their properties with the actual API responses to identify values that are guaranteed to be present. Review the securitySchemes definitions and the separate secure.soundcloud.com host question as part of the scope. Done means guaranteed response properties have accurate required arrays and the OAuth path decision is documented.
由索引模型根据 Issue 内容生成。
描述
The OpenAPI specification appears to be missing required declarations for many response properties.
For example, properties that appear to be consistently returned by the API are not included in the schema's required arrays. This causes OpenAPI-generated clients and TypeScript types to treat these properties as optional, even though they appear to be guaranteed in actual API responses.
Could the response schemas be reviewed and have properties marked as required where they are guaranteed to be present?
This would make the OpenAPI specification more accurately reflect the actual API contract and would improve the quality of generated clients.
One related question: OAuth is currently represented through the securitySchemes definitions, with the authorization and token URLs hosted at https://secure.soundcloud.com rather than the API host. Is the intention that the OAuth endpoints themselves are intentionally excluded from the OpenAPI paths, since they belong to the separate secure.soundcloud.com service?
- 主要语言
- JavaScript
- 星标
- 253
- 派生
- 53
- 平均合并
- 1 分钟
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
soundcloud/api 的其他 Issue
-
widget
难度 5/5 一周以上 新手友好度 35/100
soundcloud/api#557 · 1 条评论 ·
-
难度 5/5 一周以上 新手友好度 38/100
soundcloud/api#548 ·
-
难度 5/5 一周以上 新手友好度 35/100
soundcloud/api#547 · 2 个 reaction ·
-
难度 5/5 一周以上 新手友好度 35/100
soundcloud/api#545 · 2 条评论 · 1 个 reaction ·
-
bug
难度 4/5 3-5 天 新手友好度 35/100
soundcloud/api#537 · 7 条评论 · 1 个 reaction ·
相似的 Issue
-
check:failed feeds:add
难度 2/5 1-3 小时 新手友好度 72/100
iptv-org/database#36278 · 1 条评论 ·
维护者通常 3 天内回复
-
fix
难度 2/5 1-3 小时 新手友好度 72/100
idean3885/claude-ops-agent#577 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 7 天内回复
-
agent/quality hive/hosted-available-lke648397-260827-5n31 quality testing
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 82/100
notionnext-org/NotionNext#4544 ·
维护者通常 1 天内回复