search

Redocly / redocly-vs-code

Redocly VS Code extension
35 stars 6 forks source link

docs: update JSON support as of 0.2.0 #15

Open jeremyfiel opened 2 years ago

jeremyfiel commented 2 years ago

What happened?

Reviewing the docs indicates your API definition file is in the YAML format.. JSON support was added in 0.2.0 according to the release notes. What should have happened instead?

https://redoc.ly/docs/redocly-openapi/#troubleshooting

ivana-isadora commented 2 years ago

JSON is still not fully supported by the extension (in the sense that you can't yet do everything with JSON files that you can with YAML files). Only validation and live documentation preview are supported for JSON right now. Almost all other features, including cursor context, are not supported yet. That's why we're still focusing on YAML as the "default" format in the documentation. It would probably be a good idea to make this a bit clearer in the docs, though. :+1: