Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI descriptions needs to be < 3.1.0 #5380

Closed
Tracked by #5162
petrhollayms opened this issue Sep 10, 2024 · 5 comments · Fixed by #5396
Closed
Tracked by #5162

OpenAPI descriptions needs to be < 3.1.0 #5380

petrhollayms opened this issue Sep 10, 2024 · 5 comments · Fixed by #5396
Assignees
Labels
vscode-extension Work related to the vscode-extension
Milestone

Comments

@petrhollayms
Copy link
Contributor

petrhollayms commented Sep 10, 2024

OpenAPI version 3.1.0 shall throw a validation error, given that it is not yet supported in OpenAPI.NET library yet.

Support for 3.1 microsoft/OpenAPI.NET#795 will be released in the upcoming 2.0 version.

@petrhollayms petrhollayms added this to the Kiota v1.18.1 milestone Sep 10, 2024
@sebastienlevert
Copy link
Contributor

sebastienlevert commented Sep 10, 2024

When using the CLI, we're getting this error:

image

We should bubble the same error via the JSON RPC server and making it a toast for developer like all other failures / notifications we share with them.

ACs

  • This should warn the user when version >= 3.1 and send them back to the previous step (API selection)
  • User should never be able to select a v3.1 OpenAPI description

@petrhollayms
Copy link
Contributor Author

@thewahome Can you please add a screenshot and check the ACs above if implemented?
The second one might be something for a follow-up after GA, right?

@calebkiage
Copy link
Contributor

calebkiage commented Sep 12, 2024

@petrhollayms, why should we show a warning instead of failing if we can't generate for OpenAPI 3.1?

@petrhollayms petrhollayms removed the WIP label Sep 13, 2024
@petrhollayms
Copy link
Contributor Author

It will shown an error and stop the generation, @thewahome please confirm.

@thewahome
Copy link
Contributor

Yes. It will show the error stop loading a new document

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
vscode-extension Work related to the vscode-extension
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

6 participants