adding an option to flag an api route as deprecated

if this flag is present, it adds an annotation to the route in the
api documentation