Set depreciated on an entire Router

[jcpunk]

I'm putting my current routes under:

v1_route = Router(
    path="/v1",
    route_handlers=[controller1, controller2],
)

routes = [v1_route]

A few years down the road I expect the v1 API will be end of life. I'd love to be able to just slap a depreciated=True on the Router rather than each of the various @get and @post blocks under all my controllers.

[provinzkraut]

Assuming you mean deprecated, not depreciated, yes, this sounds like a useful feature and should be quite simple to implement. We would need to add the deprecated argument to Router and a deprecated attribute to Controller, remove deprecated from here

litestar/litestar/handlers/http_handlers/base.py

Line 354 in 3da8f86

deprecated=self.deprecated,

and add it there

litestar/litestar/handlers/http_handlers/base.py

Line 367 in 3da8f86

for other in (self, *others): # type: ignore[assignment]

I think the default value can be False, and you can't override the value from a higher layer. This would mean that a router that has deprecated=True includes a route handler that has deprecated=False, the handler is still considered deprecated, but when the same handler is included in a router that has deprecated=False (i.e. the default) it's not deprecated.