Hello.
I’ve created a REST Resource in my plugin and now want it to be documeted. My code looks like this:
@Path(ResourcePatterns.REPOSITORY_URI)
@Singleton
public class MyResource {
/**
* Resource description
* @param myParam this is param description
*/
@GET
@Path("/mypath")
public Response myMethod(@Context ContainerRequest request,
@Context Repository repository,
@PathParam(ResourcePatterns.PROJECT_KEY) String projectKey,
@PathParam(ResourcePatterns.REPOSITORY_SLUG) String repositorySlug,
@QueryParam("myParam") String myParam)
{ return ResponseFactory.ok().build(); }
}
When I install my plugin, I see this resource in Rest Api Browser, but there is no description of a method or its parameter.
This page https://developer.atlassian.com/docs/atlassian-platform-common-components/rest-api-development/documenting-your-apis-with-the-atlassian-rest-api-browser tells that I only need javadoc comment to add a description and I’ve created one.
What is wrong?