spec-first/connexion

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

Open

#861 opened on 2019年1月29日

GitHub で見る
 (0 comments) (2 reactions) (0 assignees)Python (4,346 stars) (738 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
3-5 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.