OAS 3.1 support?

[Kormyr]

Hello,

I just discovered this wonderful VSCode extension. Thank you for all the work on this.

OpenAPI Specification 3.1 has been released recently (https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0).
Are there already plans to implement it?

[ak1394]

Thanks! Happy you liked the extension. As for 3.1, we plan to support it of course. My guess it will not make it to the next release (which quite close to being published) but one after that.

[ak1394]

I had a closer look at the new spec, and it looks like there are some issues in around schema validation which might delay it a bit.

The JSON schema for 3.1 is WIP OAI/OpenAPI-Specification#2016 but once it's done it'll require 2019-09 schema support in VS Code microsoft/vscode#98724

[spacedsweden]

microsoft/vscode#98724 (comment)

Can we do yaml meanwhile?

[ak1394]

Nope, VS Code uses the same JSON Schema implementation for both YAML and JSON. You're linking to a comment mentioning some other non vs-code implementations of JSON Schema 2020-12, but that doesn't help much as we need VS Code one (which provides auto-completion, etc) to implement the new schema standard.

[amh4r]

Looking forward to 3.1.0 support! Your extension has been a fantastic guardrail for our new-to-OpenAPI engineers, but we have to start using 3.1.0 (to get proper nullable reference schemas: OAI/OpenAPI-Specification#1368)

[ak1394]

@goodoldneon thanks for the feedback! We would like to introduce 3.1 support as soon as we can, the main issue being 2019-09 schema support in VS Code...

[tforster]

I too have switched to 3.1.0 to take advantage of nullable reference schemas. Is it possible to make this extension work with another validator, at least until VSCode catches up?

[ak1394]

@tforster It's hard to do, because the built-in checker not only does validation but drives intellisence/completions as well.

[Guo-Zhang]

Hope that 3.1.0 can be supported! What are the difficulties?

[apkrieg]

Came looking for 3.1.0 support, found sadness. Can't wait for an update.

[spacedsweden]

Any news on this? is the spec stable enough now?

[tforster]

FWIW I have now switched over to Redocly using their free CLI. I am having no issues developing, building, linting and viewing OAS 3.1.0 schemas.

I use two NPM scripts, one to build and lint my schema and the other to open the schema in the Redocly viewer.

"scripts": {
  "buildSchemas": "npx @redocly/openapi-cli lint docs/rest-api/openapi.yaml; npx @redocly/openapi-cli bundle docs/rest-api/openapi.yaml --output src/rest.json",
  "showDocs": "xdg-open http://127.0.0.1:8080; npx @redocly/openapi-cli preview-docs docs/rest-api/openapi.yaml;"
},

[spacedsweden]

I have done the same, i am actually using their vs extension as well. however i do miss the sidepanel i get with 42crunch

[PhilParisot]

Any news? 3.1.0 has been out for a while now.