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

[zod-openapi] Make range definitions available #534

Closed
taku-hatano opened this issue May 20, 2024 · 0 comments · Fixed by #535
Closed

[zod-openapi] Make range definitions available #534

taku-hatano opened this issue May 20, 2024 · 0 comments · Fixed by #535

Comments

@taku-hatano
Copy link
Contributor

Hi team,

Following code occur type error.

export const route = createRoute({
	...
	responses: {
		200: {
			description: "Success",
			content: {
				"application/json": {
					schema: successSchema,
				},
			},
		},
		'4XX': {
			description: "Error",
			content: {
				"application/json": {
					schema: errorSchema,
				},
			},
		},
	},
});
...
app.openapi(route, (c) => {
	...
	return c.json(errorResponse, 400); // type error
})

I think this is because RouteConfigToTypedResponse support only StatusCode but OpenAPI support range definitions(like 4XX, 5XX).
ref. https://swagger.io/docs/specification/describing-responses/

So I suggest extract range definitions to StatusCode.

I will create PR, please check and please comment!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant