Reusable error schemas with commonSchemas

[Delarkz]

Is it possible to leverage the new commonSchemas to define a single, reusable Error model that can be referenced across all endpoints, instead of generating separate error schemas for each route?

[dosubot[bot]]

Hi @Delarkz! I'm Dosu and I’m helping the orpc team.

You can use commonSchemas to define reusable schema components (like for user or data models) that are referenced across your OpenAPI spec, but it does not currently support defining a single, reusable Error model that is referenced for all error responses. Instead, the error response schemas are generated dynamically for each error code, with a fixed structure (defined, code, status, message, and data). Only the data property within the error response can leverage a shared schema from commonSchemas—the overall error shape itself cannot be globally referenced or overridden via commonSchemas at this time. See the implementation and docs for details:
openapi-generator.ts
OpenAPI docs

To reply, just mention @dosu.

---

Docs are dead. Just use Dosu.

[dinwwwh]

It can be commonErrors feature, what do you think? Currently, the commonSchemas only works for error.data

[Delarkz]

That would be extremely helpful! Right now there's a ton of duplicated schemas in the generated OpenAPI spec, which makes it a pain to handle errors after generating code for other languages.

[dinwwwh]

oRPC 1.5.2 can solve 50% this problem: https://github.com/unnoq/orpc/releases/tag/v1.5.2

[dinwwwh]

oRPC v2 fixed this problem without additional config