stoplightio / elements

Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.

Home Page:https://stoplight.io/open-source/elements/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

NOT Enums Ignored - Supported by JSON Schema

kentbulza opened this issue · comments

To support reserved values, JSON Schema permits the use of "not":{"enum":[...]} syntax. However, nothing displays in Stoplight when this syntax is used. I've attached a sample OpenAPI 3.1 document to demonstrate.

not_permitted_value.json

I suppose this is a bug, but only if one decides all JSON Schema is supported.

Context

I'd like Stoplight to notate the non-permitted values. This is useful for situations like an endpoint that creates a new resource with a caller-defined code, but which has reserved values that cannot be used.

Current Behavior

Nothing displays for NOT enums.

Expected Behavior

Something should display.

Possible Solution(s)

Perhaps display these as strikethrough badges, e.g. the opposite of permitted enums.

As far as I know Elements doesn't support OpenAPI 3.1 documents yet?

this is an enhancement of stoplight's json-schema-viewer

Ok, but what should be displayed?

Just tried the stoplight elements demo, and it generally works, just no information is shown about the restriction.