Skip to content

Add support for x-oas-draft-alternateSchemas #861

@lsorber

Description

@lsorber

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 (Add support for patternProperties in schemas 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 (JSON request bodies are not strictly validated #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 (OAI/OpenAPI-Specification#1736).

Related issue: Redocly/redoc#482

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions