Examples with NewAction org.sonar.api.server.ws.WebService.NewAction used on opensource projects

Example 1 with NewAction

use of org.sonar.api.server.ws.WebService.NewAction in project sonarqube by SonarSource.

the class AuthorsAction method define.

@Override
public void define(WebService.NewController controller) {
    NewAction action = controller.createAction(ACTION_AUTHORS).setSince("5.1").setDescription("Search SCM accounts which match a given query").setResponseExample(Resources.getResource(this.getClass(), "authors-example.json")).setHandler(this);
    action.createParam(Param.TEXT_QUERY).setDescription("A pattern to match SCM accounts against").setExampleValue("luke");
    action.createParam(Param.PAGE_SIZE).setDescription("The size of the list to return").setExampleValue("25").setDefaultValue("10");
}

Example 2 with NewAction

use of org.sonar.api.server.ws.WebService.NewAction in project sonarqube by SonarSource.

the class ComponentTagsAction method define.

@Override
public void define(WebService.NewController controller) {
    NewAction action = controller.createAction(ACTION_COMPONENT_TAGS).setHandler(this).setSince("5.1").setInternal(true).setDescription("List tags for the issues under a given component (including issues on the descendants of the component)").setResponseExample(Resources.getResource(getClass(), "component-tags-example.json"));
    action.createParam(PARAM_COMPONENT_UUID).setDescription("A component UUID").setRequired(true).setExampleValue("7d8749e8-3070-4903-9188-bdd82933bb92");
    action.createParam(PARAM_CREATED_AFTER).setDescription("To retrieve tags on issues created after the given date (inclusive). Format: date or datetime ISO formats").setExampleValue("2013-05-01 (or 2013-05-01T13:00:00+0100)");
    action.createParam(PAGE_SIZE).setDescription("The maximum size of the list to return").setExampleValue("25").setDefaultValue("10");
}

Example 3 with NewAction

use of org.sonar.api.server.ws.WebService.NewAction in project sonarqube by SonarSource.

the class ListAction method define.

void define(WebService.NewController controller) {
    NewAction action = controller.createAction("list").setDescription("List supported programming languages").setSince("5.1").setHandler(this).setResponseExample(Resources.getResource(getClass(), "example-list.json"));
    action.createParam(Param.TEXT_QUERY).setDescription("A pattern to match language keys/names against").setExampleValue("java");
    action.createParam("ps").setDescription("The size of the list to return, 0 for all languages").setExampleValue("25").setDefaultValue("0");
}

Example 4 with NewAction

use of org.sonar.api.server.ws.WebService.NewAction in project sonarqube by SonarSource.

the class AddProjectAction method define.

@Override
public void define(WebService.NewController controller) {
    NewAction action = controller.createAction(ACTION_ADD_PROJECT).setSince("5.2").setDescription("Associate a project with a quality profile.").setHandler(this);
    projectAssociationParameters.addParameters(action);
}

Example 5 with NewAction

use of org.sonar.api.server.ws.WebService.NewAction in project sonarqube by SonarSource.

the class BackupAction method define.

@Override
public void define(WebService.NewController controller) {
    NewAction backup = controller.createAction("backup").setSince("5.2").setDescription("Backup a quality profile in XML form. The exported profile can be restored through api/qualityprofiles/restore.").setResponseExample(getClass().getResource("backup-example.xml")).setHandler(this);
    QProfileRef.defineParams(backup, languages);
}