Custom annotations prevent method from showing in doc

[sedax90]

Following the tutorial I created a custom annotation for permission management:

@DecoratorFactory(RequiresPermissionFactoryFunction.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface RequiresPermission {
    String value();
}

When I apply the annotation at the method, eg:

@Get("/list")
    @ProducesJson
    @RequiresPermission(Permissions.CUSTOMER_VIEW)
    public ResponseEntity<List<CustomerResponse>> getCustomers(final ServiceRequestContext ctx,
            final HttpRequest req) throws Exception

this is no longer displayed in the generated doc.

[jrhee17]

Hi, sorry about the late follow-up.

This issue seems like an issue due to the unwrapping behavior of decorators.
DocService unwraps decorators to retrieve the innermost service which can then be parsed and exposed in our documentation service.

I think defining the unwrap behavior for your decorator can be a workaround:

return delegate -> new HttpService() {
    @Override
    public HttpResponse serve(ServiceRequestContext ctx, HttpRequest req) throws Exception {
        return delegate.serve(ctx, req);
    }

    @Override
    public <T> @Nullable T as(Class<T> type) {
        return delegate.as(type);
    }

    @Override
    public Service<? extends Request, ? extends Response> unwrap() {
        return delegate.unwrap();
    }
};

or to be more concise:

return delegate -> new SimpleDecoratingHttpService(delegate) {
    @Override
    public HttpResponse serve(ServiceRequestContext ctx, HttpRequest req) throws Exception {
        return delegate.serve(ctx, req);
    }
};

Regardless of the workaround above, we should probably fix our implementation so that we can unwrap decorators to retrieve the annotated service regardless of how users have defined their decorators.