Can't reference component.response in operation.response

[artsiommiksiuk]

Defining operation object doesn't allow refs in responses:

export const BadRequestResponseZ = registry.registerComponent("responses", "BadRequest", {
    description: "BadRequest",
    content: {
        "application/json": {
            schema: ErrorSchema,
        }
    }
});

const getUser = (): RouteConfig => ({
        summary: "Get user of an organization",
        tags,
        method: "get",
        operationId: "getOrganizationUser",
        path: "/organization/{organizationId}/users",
        request: {
            params: z.object({
                organizationId: z.string().uuid(),
            })
        },
        responses: {
            "400": { '$ref': '#/components/responses/BadRequest' },
        }
    }),

I see BadRequest registered in components.responses, but neither hardcoded, or referenced properly components allowed on RouteConfig. Not on typing level (TS error), neither in runtime (400 response simply discarded from the output).

[artsiommiksiuk]

My fault. I overlooked the place where I've been testing this.

[artsiommiksiuk]

Typing is not allowing to write something as BadRequestResponseZ.ref though.

[AGalabov]

@artsiommiksiuk thank you for that. I agree that the responses should allow a $ref object (which is what BadRequestResponseZ.ref would be). I can fix that soon.

However schema: ErrorSchema, would not work in your example since we do not support zod schemas there (only raw JSON).

[AGalabov]

I've added the type change in Release v7.3.0. As mentioned we do not plan to support zod schemas within custom components for the forseeable future