Migrate API server specification from Swagger 2.0 to OpenAPI 3.1 #4763
Conversation
|
OAS 3.1 spec is rendered without any deprecation or other warnings on https://editor-next.swagger.io/ (mainline version has no OAS 3.1 support, only 3.0). |
Signed-off-by: kanpov <[email protected]>
Signed-off-by: kanpov <[email protected]>
Signed-off-by: kanpov <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4763 +/- ##
==========================================
+ Coverage 84.31% 84.34% +0.02%
==========================================
Files 249 249
Lines 27522 27460 -62
==========================================
- Hits 23206 23160 -46
+ Misses 4316 4300 -16
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
| @@ -18,5 +18,5 @@ def test_firecracker_swagger(): | |||
| """ | |||
| Test that Firecracker swagger specification is valid. | |||
| """ | |||
| swagger_spec = Path("../src/firecracker/swagger/firecracker.yaml") | |||
There was a problem hiding this comment.
I guess we could also rename the file
CHANGELOG.md
Outdated
| @@ -20,6 +20,8 @@ and this project adheres to | |||
| [#4741](https://github.com/firecracker-microvm/firecracker/pull/4741), | |||
| [#4746](https://github.com/firecracker-microvm/firecracker/pull/4746): Added | |||
| official support for 6.1 microVM guest kernels. | |||
| - [#4763](https://github.com/firecracker-microvm/firecracker/pull/4763): Migrated | |||
There was a problem hiding this comment.
Could you run tools/devtool checkstyle, I think mdformat wants to format this differently.
Also, our development practices require some description of the commit in the git commit body. See https://buildkite.com/firecracker/firecracker-pr/builds/10907#0191b1ca-d4ec-47be-965a-f79d5d483664/62-182
There was a problem hiding this comment.
My build directory got corrupted somehow and made mdformat crash, after which I had to delete it entirely and then it ran.
Description of the commit I don't understand though. At the end of the day, all of this can just be squashed before merge with a detailed description, or am I wrong?
Signed-off-by: kanpov <[email protected]>
Signed-off-by: kanpov <[email protected]>
|
I guess this is also blocked by this? #4751 (comment) |
|
This PR will be succeeded by another one that applies these changes in a backwards-compatible manner, i.e. keeps the OAS2 definition as deprecated. |
Changes
Migrate the specification from Swagger 2.0 to OpenAPI 3.1, name the directory with the specification
openapiinstead ofswagger.swagger=>openapiReason
Resolves #4751, see discussion about this change there.
License Acceptance
By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.PR Checklist
PR.
CHANGELOG.md.TODOs link to an issue.contribution quality standards.
rust-vmm.