spec-first/connexion

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

Open

#861 geöffnet am 29. Jan. 2019

Auf GitHub ansehen
 (0 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Python (4.346 Stars) (738 Forks)batch import
enhancementhelp wanted

Beschreibung

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

Contributor Guide

Tech Stack
pythonrest api
Domain
apibackend
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
OpenAPI spec understandingJSON Schema basicsPython developmentConnexion framework
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50
Research-Richtung
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.