Azure / Azure/openapi-diff

Allowing circular references

未关闭
#274 5 条评论 5 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
C#
星标
290
派生
50
平均合并
5 天 13 小时
30 天内合并 PR
5

描述

Is there a way to generate the report allowing for circular dependencies on the parameters?

```
OpenApiDiffErrorImpl [VError]: ReferenceError: Circular $ref pointer found at /builds/#/components/schemas/Content/properties/children/items
at /usr/local/lib/node_modules/openapi-diff/dist/openapi-diff/spec-differ/diff-finder/json-schema-diff.js:27:15
at Generator.throw ()
at rejected (/usr/local/lib/node_modules/openapi-diff/dist/openapi-diff/spec-differ/diff-finder/json-schema-diff.js:6:65) {
jse_shortmsg: 'ReferenceError: Circular $ref pointer found at /builds/#/components/schemas/Content/properties/children/items',
jse_info: {},
code: 'OPENAPI_DIFF_DIFF_ERROR'
}
```

Thank you!

贡献指南

打开贡献指南

调研方向

从报告循环 $ref 错误的 openapi-diff/dist/openapi-diff/spec-differ/diff-finder/json-schema-diff.js 开始,跟踪 Content schema 的比较过程。确定 /components/schemas/Content/properties/children/items 的预期行为,并将完成定义为:生成报告时不会因该循环引用而失败,同时为示例规范提供覆盖。

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

评估

技术栈
javascript, openapi
领域
api, backend-api-design
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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