[Schema Inaccuracy] Duplicate title properties and inline schemas
维护者通常 1 天内回复
@bearcherian 已经在做这个了。
开始于 2025年3月27日。
评估
这个 Issue 还没有评估数据。
描述
Schema Inaccuracy
The schema contains many inline schemas (that should be using re-usable components) and many inline schemas and components that have duplicate title properties
This causes problems when using tools like json-schema-to-typescript where you end up with many TypeScript interfaces named User_3, Repository_1, etc.
Expected
No inline schemas for re-used definitions, or schemas that have the same title
Reproduction Steps
This script logs all duplicate title properties found
import schema from "./packages/openapi-webhooks/generated/api.github.com.json" with { type: "json" };
import { writeFileSync } from "node:fs";
function findDuplicateTitles(schema) {
const seen = new Set();
const duplicates = [];
function traverse(obj, path = []) {
if (typeof obj !== "object" || obj === null) return;
if (obj.title) {
const titlePath = path.join("/");
if (seen.has(obj.title)) {
duplicates.push({ title: obj.title, path: titlePath });
} else {
seen.add(obj.title);
}
}
// Traverse properties like oneOf, anyOf, etc.
for (const [key, value] of Object.entries(obj)) {
if (Array.isArray(value)) {
value.forEach((item, index) => traverse(item, [...path, key, index]));
} else if (typeof value === "object") {
traverse(value, [...path, key]);
}
}
}
traverse(schema);
return duplicates;
}
async function main() {
const duplicates = findDuplicateTitles(schema)
.sort((a, b) => {
if (a.title < b.title) return -1;
if (a.title > b.title) return 1;
return 0;
})
.map(({ title, path }) => `- [ ] Title: ${title}, Path: \`#/${path}\``);
writeFileSync("duplicates.txt", duplicates.join("\n"));
}
main().catch(console.error);
Here is the list of duplicates I have found, which is too long to post directly into the issue body:
duplicates.txt
- 主要语言
- 没有语言数据
- 星标
- 1.6k
- 派生
- 342
- 平均合并
- 2 小时 23 分钟
- 30 天内合并 PR
- 57
环境准备
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
github/rest-api-description 的其他 Issue
-
feature
难度 2/5 1-3 小时 新手友好度 85/100
github/rest-api-description#7220 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 82/100
github/rest-api-description#7201 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 72/100
github/rest-api-description#7163 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 68/100
github/rest-api-description#7162 ·
维护者通常 1 天内回复
-
feature
难度 2/5 1-3 小时 新手友好度 68/100
github/rest-api-description#7135 ·
维护者通常 1 天内回复