OpanApi Union naming?

[zacharyhansen]

Hi all!

Quick question - is there an easy way to name the OpenAPI object when using a zod union within the meta object or somehow using the zod registry?

Something like

oc
	.route({
		method: 'GET',
		path: '/health',
		tags: ['Health'],
		summary: 'Health check',
		description: 'Health check',
	})
	.input(
		z
			.union([schema1, schema2])
	)
	.output(z.object({ status: z.string() }));

to get a nice name within the scalar dropdown (instead of a list of object)

[dosubot[bot]]

There isn’t currently an easy or built-in way in orpc to name OpenAPI objects for zod unions using the meta object or zod registry, so you won’t get a custom name in the Scalar/Swagger dropdown out of the box. orpc doesn’t yet support registering schemas as named OpenAPI components (like #/components/schemas/Item), but this feature is on the roadmap see discussion.

Descriptions for OpenAPI fields are extracted from Zod’s .describe() method, not .meta(), so you can use .describe() for better field documentation details. For advanced OpenAPI metadata or custom schema naming, you’d need to implement a custom schema converter or plugin reference.

You can find more about JSON schema customization in the orpc OpenAPI docs.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}    

[unnoq]

Let's try schema1.meta({ title: 'something' })