redoc icon indicating copy to clipboard operation
redoc copied to clipboard

OpenAPI 3.1 support issues

Open RomanHotsiy opened this issue 4 years ago • 16 comments

We've released support for openapi 3.1 in the RC.54

This is an umbrella issue to track the issues about it.

Known issues

  • if/then/else keywords from openapi 3.1 are not supported, https://github.com/Redocly/redoc/pull/1939
  • https://github.com/Redocly/redoc/issues/1643
  • $ref using $id support
  • $ref siblings missing in schemas https://github.com/Redocly/redoc/issues/1727
  • #1727
  • https://github.com/Redocly/openapi-cli/issues/629
  • TBD

RomanHotsiy avatar Aug 06 '21 19:08 RomanHotsiy

#1727

adamaltman avatar Oct 06 '21 03:10 adamaltman

https://github.com/Redocly/redoc/issues/1761 https://github.com/Redocly/redoc/issues/1788

zalesky avatar Oct 12 '21 12:10 zalesky

It would be great if the README could elaborate on what "basic" OpenAPI 3.1 support means. What is it lacking in comparison to the premium variant? It would help understand the limitations better.

m-mohr avatar Nov 03 '21 11:11 m-mohr

@m-mohr the known issues are posted above. Did you find something else? If so, please report the issue and also the link into this tracking issue. Thank you.

adamaltman avatar Nov 03 '21 11:11 adamaltman

@adamaltman No, I have no specific issues, but the README implies that there are limitations in the Redoc community edition:

image

The "(basic)" implies that there are limitations or so to Redoc CE. I'm wondering what the differences are. If there are no differences, I guess the "(basic)" should be removed? Otherwise, it would be nice to document what is missing so that people can understand what is missing and whether it's worth upgrading/switching/PRing or so.

m-mohr avatar Nov 03 '21 11:11 m-mohr

Does propertyName in map works in redoc?

jehanzebqayyum avatar Mar 27 '22 17:03 jehanzebqayyum

It looks like OpenAPI 3.1 added support for scopes in authentication schemes other than oauth (https://github.com/OAI/OpenAPI-Specification/issues/1366)

Using both 0.13.10 as well as the live demo (https://redocly.github.io/redoc/), the rendered HTML file does not seem to include scopes for API Key authentication methods in the list of authentication methods.

Strings included in the individual "route" level security array are rendered in the HTML output.

crossan007 avatar Apr 06 '22 19:04 crossan007

Support for unevaluatedProperties.

https://github.com/Redocly/redoc/issues/1955

adamaltman avatar Apr 08 '22 12:04 adamaltman

https://github.com/Redocly/redoc/issues/1983

AlexVarchuk avatar May 06 '22 14:05 AlexVarchuk

Add support prefixItems and uniqueItems to JSON Schema

AlexVarchuk avatar May 18 '22 12:05 AlexVarchuk

https://github.com/Redocly/redoc/issues/2142

AlexVarchuk avatar Aug 29 '22 07:08 AlexVarchuk

https://github.com/Redocly/redoc/issues/2364

AlexVarchuk avatar Sep 20 '23 14:09 AlexVarchuk

https://github.com/Redocly/redocly-cli/issues/1233#issue-1852036224

jeremyfiel avatar Oct 04 '23 20:10 jeremyfiel