Add OpenAPI schema for public REST API #11025
Conversation
S3 Image Test Results (AMD64 / ARM64) 2 files 2 suites 3m 39s ⏱️ Results for commit 75c6201. ♻️ This comment has been updated with latest results. |
013d4df to
c0d4afe
Compare
f12ee63 to
327723c
Compare
6580e0c to
5e5014c
Compare
37892e5 to
1e64817
Compare
There was a problem hiding this comment.
This is a great first iteration, finally introducing a machine-readable spec for all endpoints which are not clearly defined by the AWS APIs! 🚀 🤖
I added quite a few comments, lots of them are just questions (for this and later iterations), but also a few suggestions for changes. Let me know if I can help anywhere!
443f64a to
f94a80f
Compare
…ient in the validations
a23fdd5 to
75c6201
Compare
There was a problem hiding this comment.
Thanks for addressing the comments. The iteration is lookin' great! We now have an opt-out request validator, an opt-in response validator (which is enabled in the tests), and most importantly a package-root openapi spec for all the already existing non-AWS-operation endpoints! 💯
Thanks a lot, @viren-nadkarni and @giograno! This is a great step towards a well defined API used by all kinds of SDKs / tools!
Co-authored-by: Giovanni Grano <me@giograno.com> (cherry picked from commit fcd110d)
Co-authored-by: Giovanni Grano <me@giograno.com> (cherry picked from commit fcd110d)
Co-authored-by: Giovanni Grano <me@giograno.com> (cherry picked from commit fcd110d)
This PR introduces the OpenAPI schema for the internal endpoints in LocalStack.
Contributions:
localstack-core/localstack/openapi) that contains the entire spec for the endpoints in community. The specs have been handcrafted by @viren-nadkarni 🙌 .linttarget. The same check is added also to the pre-commit hooks.OPENAPI_VALIDATE_REQUESTvariable.OPENAPI_VALIDATE_RESPONSEactivates the same check for the responses. It's currently activated by default in our CI pipeline.