aboutsummaryrefslogtreecommitdiffstats
path: root/sonar-ws/src/main/protobuf/ws-permissions.proto
blob: 90a1559231b5e4c70238205e6ee7217f46c869d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// SonarQube, open source software quality management tool.
// Copyright (C) 2008-2015 SonarSource
// mailto:contact AT sonarsource DOT com
//
// SonarQube is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 3 of the License, or (at your option) any later version.
//
// SonarQube is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, write to the Free Software Foundation,
// Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

syntax = "proto2";

package sonarqube.ws.permissions;

import "ws-commons.proto";

option java_package = "org.sonarqube.ws";

option java_outer_classname = "Permissions";

option optimize_for = SPEED;

// WS api/permissions/users for internal use only
message UsersResponse {

  message User {
    optional string login = 1;
    optional string name = 2;
    optional string email = 3;
    optional bool selected = 4;
  }

  repeated User users = 1;
  optional sonarqube.ws.commons.Paging paging = 2;
}

// WS api/permissions/groups for internal use only
message GroupsResponse {

  message Group {
    optional string id = 1;
    optional string name = 2;
    optional string description = 3;
    optional bool selected = 4;
  }

  repeated Group groups = 1;
  optional sonarqube.ws.commons.Paging paging = 2;
}

message Permission {
  optional string key = 1;
  optional string name = 2;
  optional string description = 3;
  optional int32 usersCount = 4;
  optional int32 groupsCount = 5;
}

message SearchGlobalPermissionsResponse {
  repeated Permission permissions = 1;
}

message SearchProjectPermissionsResponse {
  message Project {
    optional string uuid = 1;
    optional string key = 2;
    optional string qualifier = 3;
    optional string name = 4;
    repeated Permission permissions = 5;
  }

  repeated Project projects = 1;
  repeated Permission permissions = 2;
  optional sonarqube.ws.commons.Paging paging = 3;
}