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

Consider consistent, better typed OpenAPI support #40

Open
joeduffy opened this issue May 16, 2019 · 0 comments
Open

Consider consistent, better typed OpenAPI support #40

joeduffy opened this issue May 16, 2019 · 0 comments
Labels
area/providers kind/enhancement Improvements or new features

Comments

@joeduffy
Copy link
Member

joeduffy commented May 16, 2019

I found it a little jarring that we accept swaggerString, which is a string, when specifying an OpenAPI specification for the entire API, versus data, which is an any, when specifying the OpenAPI integration object subset of the specification, for RawDataRoutes.

I would have expected them to be consistent. For example, perhaps accept a string | Object and automatically serialize the object as a JSON string if Object is used.

Even nicer than Object, we could actually accept the strongly typed OpenAPI types that we have lurking in this package. I'm not sure it's worth the effort as it may just cause troubles if we don't keep our types up to date, but I could imagine for anybody spelunking at this level, it'd be a nice touch.

Also, a minor nit, we should move away from calling this "Swagger" and instead begin calling it "OpenAPI," since this new name supersedes the old one.

@joeduffy joeduffy added area/providers kind/enhancement Improvements or new features labels May 16, 2019
@danielrbradley danielrbradley transferred this issue from pulumi/pulumi-awsx May 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/providers kind/enhancement Improvements or new features
Projects
None yet
Development

No branches or pull requests

2 participants