forked from TheThingsNetwork/lorawan-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapplication_services.proto
More file actions
142 lines (125 loc) · 5.01 KB
/
application_services.proto
File metadata and controls
142 lines (125 loc) · 5.01 KB
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
import "google/api/annotations.proto";
import "google/protobuf/empty.proto";
import "lorawan-stack/api/application.proto";
import "lorawan-stack/api/identifiers.proto";
import "lorawan-stack/api/rights.proto";
package ttn.lorawan.v3;
option go_package = "go.thethings.network/lorawan-stack/v3/pkg/ttnpb";
service ApplicationRegistry {
// Create a new application. This also sets the given organization or user as
// first collaborator with all possible rights.
rpc Create(CreateApplicationRequest) returns (Application) {
option (google.api.http) = {
post: "/users/{collaborator.user_ids.user_id}/applications"
body: "*"
additional_bindings {
post: "/organizations/{collaborator.organization_ids.organization_id}/applications"
body: "*"
}
};
};
// Get the application with the given identifiers, selecting the fields given
// by the field mask. The method may return more or less fields, depending on
// the rights of the caller.
rpc Get(GetApplicationRequest) returns (Application) {
option (google.api.http) = {
get: "/applications/{application_ids.application_id}"
};
};
// List applications. See request message for details.
rpc List(ListApplicationsRequest) returns (Applications) {
option (google.api.http) = {
get: "/applications"
additional_bindings {
get: "/users/{collaborator.user_ids.user_id}/applications"
}
additional_bindings {
get: "/organizations/{collaborator.organization_ids.organization_id}/applications"
}
};
};
rpc Update(UpdateApplicationRequest) returns (Application) {
option (google.api.http) = {
put: "/applications/{application.ids.application_id}"
body: "*"
};
};
rpc Delete(ApplicationIdentifiers) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/applications/{application_id}"
};
};
}
service ApplicationAccess {
rpc ListRights(ApplicationIdentifiers) returns (Rights) {
option (google.api.http) = {
get: "/applications/{application_id}/rights"
};
};
rpc CreateAPIKey(CreateApplicationAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
post: "/applications/{application_ids.application_id}/api-keys"
body: "*"
};
};
rpc ListAPIKeys(ListApplicationAPIKeysRequest) returns (APIKeys) {
option (google.api.http) = {
get: "/applications/{application_ids.application_id}/api-keys"
};
};
rpc GetAPIKey(GetApplicationAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
get: "/applications/{application_ids.application_id}/api-keys/{key_id}"
};
};
// Update the rights of an existing application API key. To generate an API key,
// the CreateAPIKey should be used. To delete an API key, update it
// with zero rights. It is required for the caller to have all assigned or/and removed rights.
rpc UpdateAPIKey(UpdateApplicationAPIKeyRequest) returns (APIKey) {
option (google.api.http) = {
put: "/applications/{application_ids.application_id}/api-keys/{api_key.id}"
body: "*"
};
};
// Get the rights of a collaborator (member) of the application.
// Pseudo-rights in the response (such as the "_ALL" right) are not expanded.
rpc GetCollaborator(GetApplicationCollaboratorRequest) returns (GetCollaboratorResponse) {
option (google.api.http) = {
get: "/applications/{application_ids.application_id}/collaborator"
additional_bindings {
get: "/applications/{application_ids.application_id}/collaborator/user/{collaborator.user_ids.user_id}"
}
additional_bindings {
get: "/applications/{application_ids.application_id}/collaborator/organization/{collaborator.organization_ids.organization_id}"
}
};
}
// Set the rights of a collaborator (member) on the application. It is required for the caller to
// have all assigned or/and removed rights.
// Setting a collaborator without rights, removes them.
rpc SetCollaborator(SetApplicationCollaboratorRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
put: "/applications/{application_ids.application_id}/collaborators"
body: "*"
};
};
rpc ListCollaborators(ListApplicationCollaboratorsRequest) returns (Collaborators) {
option (google.api.http) = {
get: "/applications/{application_ids.application_id}/collaborators"
};
};
}