spec-first/connexion

Add support for `x-oas-draft-alternateSchemas`

Open

#861 创建于 2019年1月29日

在 GitHub 查看
 (0 评论) (2 反应) (0 负责人)Python (4,346 star) (738 fork)batch import
enhancementhelp wanted

描述

OpenAPI lags behind JSON Schema, which means OpenAPI APIs do not benefit from the latest fixes and improvements to the latter.

For example:

  1. JSON Schema Draft 4's patternProperties is not supported in OpenAPI, even though the latter is based on Draft 5 (OAI/OpenAPI-Specification#687).
  2. additionalProperties: false is not compatible with OpenAPI's inheritance model using allOf [1]. This is blocking for strict validation of JSON request bodies that depend on inheritance (#837).
  3. Similar issues exist when combining nullable, readOnly, and writeOnly with OpenAPI's inheritance model.

It would be nice if we could already use x-oas-draft-alternateSchemas to specify other schemas to address some of these issues, until alternativeSchema is available in OpenAPI 3.1 (https://github.com/OAI/OpenAPI-Specification/pull/1736).

Related issue: https://github.com/Rebilly/ReDoc/issues/482

[1] https://stackoverflow.com/questions/22689900/json-schema-allof-with-additionalproperties

贡献者指南

技术栈
pythonrest api
领域
apibackend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
OpenAPI spec understandingJSON Schema basicsPython developmentConnexion framework
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
50
研究方向
Investigate how connexion processes OpenAPI schemas, particularly in the schema validation module. Look at the existing handling of OpenAPI spec extensions. Consider implementing support for the custom extension `x oas draft alternateSchemas` to allow alternative JSON Schema drafts. Review the linked issues (#837, OAI/OpenAPI Specification#687) and the StackOverflow reference. Test with examples that combine allOf and additionalProperties.