@RestDoc should be allowed on classes (which model subresources)

[Oliver Kopp]

I'm using classes as subresources, which are instantiated by the parent resource. I tried to annotate that resource class with @RestDoc(resourceDescription = "..."), but the location class is not allowed for @RestDoc.

[Thorsten Hoeger]

RestDoc resources have to be callable endpoints so only methods can be annotated. Subresources are only parts of the endpoint.

[Oliver Kopp]

Maybe, I don't get, what a callable endpoint is :). I have the URL http://.../winery/winerypropertiesdefinition, where I can POST to. Is that an endpoint?

public class WinerysPropertiesDefinitionResource {

    @POST
    @RestDoc(methodDescription = "switches the mode to winery properties")
    public Response onPost() {
        // ...
    }

}

That resource is created by the parent resource.

    @Path("winery/")
    public WinerysPropertiesDefinitionResource getWinerysPropertiesDefinitionResource() {
        return new WinerysPropertiesDefinitionResource();
    }

I see that I could make the annotation there. I currently think it is better positioned at the place where the actual implementation (or interface definition ;)) resides.

[Thorsten Hoeger]

I see the problem, I think I will split resourceDescription and methodDescription into separate annotations. That may solve the problem.

[Oliver Kopp]

👍