I have some questions about the new rest doc annotations. For reference,
here's the endpoint I'm working with:
@GET
@Path("/list.json")
@Produces(MediaType.APPLICATION_JSON)
@RestQuery(
description = "Lists the roles as a json array",
returnDescription = "The list of roles as a json array",
pathParameters = {}, queryParameters = {},
reponses = { @RestResponse(responseCode = 200, description = "OK,
roles returned") })
public String getRoles() {...}
1) Am I using this correctly?
2) Do we need both a description and a returnDescription? Is the
returnDescription for a sample of the data returned?
3) I'm forced to include empty arrays for pathParameters and
queryParameters. Can we make these optional?
Thanks,
Josh
_______________________________________________
Matterhorn mailing list
[email protected]
http://lists.opencastproject.org/mailman/listinfo/matterhorn
To unsubscribe please email
[email protected]
_______________________________________________
