private static void defineLoginAction(NewController controller) {
NewAction action =
controller
.createAction("login")
.setDescription("Authenticate a user.")
.setSince("6.0")
.setPost(true)
.setHandler(ServletFilterHandler.INSTANCE);
action.createParam("login").setDescription("Login of the user").setRequired(true);
action.createParam("password").setDescription("Password of the user").setRequired(true);
}
private void defineSystemAction(NewController controller) {
NewAction action =
controller
.createAction("index")
.setDescription("Get a list of past measures. Requires Browse permission on project")
.setSince("2.10")
.setHandler(RailsHandler.INSTANCE)
.setResponseExample(
Resources.getResource(this.getClass(), "timemachine-example-index.json"));
action
.createParam("resource")
.setDescription("id or key of the resource (ie: component)")
.setRequired(true)
.setExampleValue(KEY_PROJECT_EXAMPLE_001);
action
.createParam("metrics")
.setDescription(
"Comma-separated list of <a href=\"http://redirect.sonarsource.com/doc/metric-definitions.html\">metric keys/ids</a>")
.setRequired(true)
.setExampleValue("coverage,violations");
action
.createParam("fromDateTime")
.setDescription("ISO-8601 datetime (inclusive)")
.setExampleValue("2010-12-25T23:59:59+0100");
action
.createParam("toDateTime")
.setDescription("ISO-8601 datetime (inclusive)")
.setExampleValue("2010-12-25T23:59:59+0100");
action.createParam("format").setDescription("Response format").setPossibleValues("json", "csv");
}
