[RFC] Handle OpenAPI 3.1 BC Breaks
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- openapi, php
调研方向
首先阅读现有的 OpenAPI 3.0 规范文件和 pull request 128 中的更改,然后将它们与列出的 OpenAPI 3.1 breaking changes 及链接的 release notes 进行比较。只有在维护者选择并记录一种表示 3.1 的方案,且不会破坏已完成的 3.0 支持之后,此 RFC 才算完成。
由索引模型根据 Issue 内容生成。
描述
It's nice to see the work for the OpenAPI 3.1 standard. I think a big part are the deprecated fields or type changes like:
- The nullable keyword has been removed from the Schema Object (null can be used as a type value).
- the type can be now an array with the type and
null - exclusiveMaximum and exclusiveMinimum cannot accept boolean values (following JSON Schema).
- See more at Stoplight Blog and OpenAPI Release Notes
How would you like to handle these breaking changes?
My first idea was to duplicate the spec files into a 3.0 and 3.1 Folder and use them according to the given OpenAPI version.
The positive parts are that static code analysis or the IDE knows which type of Object is used and the user don't have to handle multiple types. For example the type as string in OpenAPi 3.0 and type as array in OpenAPI 3.1 with null item. Also the spec could be validated and it's not necessary to add version switches for fields that are required or not.
The second Idea is to "convert" the Structure into the existing Spec Files. So a type with two items in OpenAPI would be an oneOf or if the type includes null the nullable flag would be added. But then you need to convert the items back to the new structure if you want to write a OpenAPI 3.1 file. The other part is, that you then support a converter from OpenAPI 3.0 to OpenAPI 3.1 and i don't think this is a feature to maintain in this library.
The last solution is to try to handle both versions into a single file. But that could be hard because of the breaking changes in OpenAPI 3.1. Even OpenAPI 3.1 didn't make a release without breaking changes. It could be complex to handle it here.
My preferred solution is version one because of the strict types and the clear break between Version 3.0 and 3.1
The Version and Specs for Version 3.0 are already feature complete and all changes effects only the new Spec files and couldn't break anything.
I look forward to your opinion. Maybe this should be clear before we make more changes into https://github.com/cebe/php-openapi/pull/128 ?
- 主要语言
- PHP
- 星标
- 500
- 派生
- 99
- PR 合并指标
- 30 天内没有已合并 PR
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
cebe/php-openapi 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 48/100
cebe/php-openapi#250 ·
-
BC break in 1.8 未关闭
难度 5/5 一周以上 新手友好度 25/100
cebe/php-openapi#247 · 1 条评论 · 1 个 reaction ·
-
难度 3/5 1-2 天 新手友好度 58/100
cebe/php-openapi#245 · 3 条评论 ·
-
难度 3/5 1-2 天 新手友好度 52/100
cebe/php-openapi#242 · 6 条评论 · 1 个 reaction ·
-
难度 2/5 1-3 小时 新手友好度 55/100
cebe/php-openapi#238 ·
相似的 Issue
-
tooling
难度 2/5 1-3 小时 新手友好度 75/100
-
UX
难度 2/5 1-3 小时 新手友好度 70/100
ProfessionalWiki/NeoWiki#1525 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
bug customer-reported
难度 2/5 1-3 小时 新手友好度 65/100
MagnaCapax/PMSS#949 ·
-
难度 2/5 1-3 小时 新手友好度 84/100
Automattic/static-site-importer#1829 ·