forked from TheThingsNetwork/lorawan-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapplicationserver_web.proto
More file actions
120 lines (102 loc) · 4.45 KB
/
applicationserver_web.proto
File metadata and controls
120 lines (102 loc) · 4.45 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
// 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 "github.com/envoyproxy/protoc-gen-validate/validate/validate.proto";
import "github.com/gogo/protobuf/gogoproto/gogo.proto";
import "google/api/annotations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
import "lorawan-stack/api/identifiers.proto";
package ttn.lorawan.v3;
option go_package = "go.thethings.network/lorawan-stack/pkg/ttnpb";
message ApplicationWebhookIdentifiers {
ApplicationIdentifiers application_ids = 1 [(gogoproto.embed) = true, (gogoproto.nullable) = false, (validate.rules).message.required = true];
string webhook_id = 2 [(gogoproto.customname) = "WebhookID", (validate.rules).string = {pattern: "^[a-z0-9](?:[-]?[a-z0-9]){2,}$" , max_len: 36}];
}
message ApplicationWebhook {
ApplicationWebhookIdentifiers ids = 1 [(gogoproto.embed) = true, (gogoproto.nullable) = false, (validate.rules).message.required = true];
google.protobuf.Timestamp created_at = 2 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
google.protobuf.Timestamp updated_at = 3 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
// Base URL to which the message's path is appended.
string base_url = 4 [(gogoproto.customname) = "BaseURL", (validate.rules).string.uri = true];
// HTTP headers to use.
map<string,string> headers = 5;
// The format to use for the body.
// Supported values depend on the Application Server configuration.
string format = 6;
message Message {
// Path to append to the base URL.
string path = 1;
}
Message uplink_message = 7;
Message join_accept = 8;
Message downlink_ack = 9;
Message downlink_nack = 10;
Message downlink_sent = 11;
Message downlink_failed = 12;
Message downlink_queued = 13;
Message location_solved = 14;
}
message ApplicationWebhooks {
repeated ApplicationWebhook webhooks = 1;
}
message ApplicationWebhookFormats {
// Format and description.
map<string, string> formats = 1;
}
message GetApplicationWebhookRequest {
ApplicationWebhookIdentifiers ids = 1 [(gogoproto.embed) = true, (gogoproto.nullable) = false, (validate.rules).message.required = true];
google.protobuf.FieldMask field_mask = 2 [(gogoproto.nullable) = false];
}
message ListApplicationWebhooksRequest {
ApplicationIdentifiers application_ids = 1 [(gogoproto.embed) = true, (gogoproto.nullable) = false, (validate.rules).message.required = true];
google.protobuf.FieldMask field_mask = 2 [(gogoproto.nullable) = false];
}
message SetApplicationWebhookRequest {
ApplicationWebhook webhook = 1 [(gogoproto.embed) = true, (gogoproto.nullable) = false, (validate.rules).message.required = true];
google.protobuf.FieldMask field_mask = 2 [(gogoproto.nullable) = false];
}
service ApplicationWebhookRegistry {
rpc GetFormats(google.protobuf.Empty) returns (ApplicationWebhookFormats) {
option (google.api.http) = {
get: "/as/webhook-formats"
};
};
rpc Get(GetApplicationWebhookRequest) returns (ApplicationWebhook) {
option (google.api.http) = {
get: "/as/webhooks/{ids.application_ids.application_id}/{ids.webhook_id}"
};
};
rpc List(ListApplicationWebhooksRequest) returns (ApplicationWebhooks) {
option (google.api.http) = {
get: "/as/webhooks/{application_ids.application_id}"
};
};
rpc Set(SetApplicationWebhookRequest) returns (ApplicationWebhook) {
option (google.api.http) = {
put: "/as/webhooks/{webhook.ids.application_ids.application_id}/{webhook.ids.webhook_id}"
body: "*"
additional_bindings {
post: "/as/webhooks/{webhook.ids.application_ids.application_id}"
body: "*"
}
};
};
rpc Delete(ApplicationWebhookIdentifiers) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/as/webhooks/{application_ids.application_id}/{webhook_id}",
};
};
}