|
1 | 1 | syntax = "proto3";
|
2 | 2 | package com.coralogix.catalog.v1;
|
3 | 3 |
|
4 |
| -import "com/coralogixapis/apm/common/v2/audit_log.proto"; |
5 | 4 | import "com/coralogix/catalog/v1/common.proto";
|
6 | 5 | import "com/coralogix/catalog/v1/service.proto";
|
7 | 6 | import "com/coralogix/catalog/v1/service_query.proto";
|
8 |
| -import "google/protobuf/wrappers.proto"; |
9 | 7 | import "com/coralogix/schemastore/v1/tracing_fields.proto";
|
10 |
| -import "com/coralogixapis/service_catalog/v1/apm_source.proto"; |
11 | 8 | import "com/coralogixapis/alerts/v3/alert_def.proto";
|
12 | 9 | import "com/coralogixapis/apm/common/v2/alert_meta_label.proto";
|
13 |
| -import "com/coralogixapis/service_catalog/v1/repeated_widgets.proto"; |
| 10 | +import "com/coralogixapis/apm/common/v2/audit_log.proto"; |
14 | 11 | import "com/coralogixapis/apm/widgets/v1/stat.proto";
|
| 12 | +import "com/coralogixapis/service_catalog/v1/apm_source.proto"; |
| 13 | +import "com/coralogixapis/service_catalog/v1/repeated_widgets.proto"; |
| 14 | +import "google/protobuf/wrappers.proto"; |
| 15 | + |
| 16 | +import "com/coralogix/common/v1/audit_log.proto"; |
| 17 | +import "google/api/annotations.proto"; |
| 18 | +import "protoc-gen-openapiv2/options/annotations.proto"; |
| 19 | +import "google/api/http.proto"; |
15 | 20 |
|
16 | 21 | message GetServicesRequest {
|
| 22 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 23 | + json_schema: { |
| 24 | + title: "Get Services Request" |
| 25 | + description: "This data structure represents a request to Get Services." |
| 26 | + required: [ |
| 27 | + "query" |
| 28 | + ] |
| 29 | + } |
| 30 | + external_docs: {} |
| 31 | + }; |
17 | 32 | ServiceQuery query = 1;
|
18 | 33 | }
|
19 | 34 |
|
20 | 35 | message GetServicesResponse {
|
| 36 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 37 | + json_schema: { |
| 38 | + title: "Get Services Response" |
| 39 | + description: "This data structure represents a response to Get Services." |
| 40 | + required: [ |
| 41 | + "query" |
| 42 | + ] |
| 43 | + } |
| 44 | + external_docs: {} |
| 45 | + }; |
21 | 46 | repeated Service services = 1;
|
22 | 47 | }
|
23 | 48 |
|
24 | 49 | message GetServiceRequest {
|
| 50 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 51 | + json_schema: { |
| 52 | + title: "Get Service Request" |
| 53 | + description: "This data structure represents a request to Get Service." |
| 54 | + required: [ |
| 55 | + "service_id", |
| 56 | + "service_name", |
| 57 | + "time_range" |
| 58 | + ] |
| 59 | + } |
| 60 | + external_docs: {} |
| 61 | + }; |
25 | 62 | google.protobuf.StringValue service_id = 1;
|
26 | 63 | google.protobuf.StringValue service_name = 2;
|
27 | 64 | TimeRange time_range = 3;
|
28 | 65 | repeated ApmFilter service_catalog_filters = 4;
|
29 | 66 | }
|
30 | 67 |
|
31 | 68 | message GetServiceResponse {
|
| 69 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 70 | + json_schema: { |
| 71 | + title: "Get Service Response" |
| 72 | + description: "This data structure represents a response to Get Service." |
| 73 | + required: [] |
| 74 | + } |
| 75 | + external_docs: {} |
| 76 | + }; |
32 | 77 | Service service = 1;
|
33 | 78 | }
|
34 | 79 |
|
35 | 80 | message UpdateServiceCatalogFiltersRequest {
|
| 81 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 82 | + json_schema: { |
| 83 | + title: "Update Service Catalog Filters Request" |
| 84 | + description: "This data structure represents a request to Update Service Catalog Filters." |
| 85 | + required: [ |
| 86 | + "service_catalog_filters", |
| 87 | + "apm_source" |
| 88 | + ] |
| 89 | + } |
| 90 | + external_docs: {} |
| 91 | + }; |
36 | 92 | repeated ApmFilter service_catalog_filters = 1;
|
37 | 93 | com.coralogixapis.service_catalog.v1.ApmSource apm_source = 2;
|
38 | 94 | repeated com.coralogixapis.apm.common.v2.AlertMetaLabel alert_label_filters = 3;
|
39 | 95 | }
|
40 | 96 |
|
41 | 97 | message UpdateServiceCatalogFiltersResponse {
|
| 98 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 99 | + json_schema: { |
| 100 | + title: "Update Service Catalog Filters Response" |
| 101 | + description: "This data structure represents a response to Update Service Catalog Filters." |
| 102 | + required: [] |
| 103 | + } |
| 104 | + external_docs: {} |
| 105 | + }; |
42 | 106 | repeated ApmFilter service_catalog_filters = 1;
|
43 | 107 | com.coralogixapis.service_catalog.v1.ApmSource apm_source = 2;
|
44 | 108 | }
|
45 | 109 |
|
46 | 110 | message GetServiceCatalogFiltersRequest {
|
| 111 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 112 | + json_schema: { |
| 113 | + title: "Get Service Catalog Filters Request" |
| 114 | + description: "This data structure represents a request to Get Service Catalog Filters." |
| 115 | + required: [ |
| 116 | + "service_name", |
| 117 | + "time_range" |
| 118 | + ] |
| 119 | + } |
| 120 | + external_docs: {} |
| 121 | + }; |
47 | 122 | google.protobuf.StringValue service_name = 1;
|
48 | 123 | com.coralogixapis.service_catalog.v1.ApmSource apm_source = 2;
|
49 | 124 | TimeRange time_range = 3;
|
50 | 125 | google.protobuf.BoolValue only_errors = 4;
|
51 | 126 | }
|
52 | 127 |
|
53 | 128 | message GetServiceCatalogFiltersResponse {
|
| 129 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 130 | + json_schema: { |
| 131 | + title: "Get Service Catalog Filters Response" |
| 132 | + description: "This data structure represents a request to Get Service Catalog Filters." |
| 133 | + required: [] |
| 134 | + } |
| 135 | + external_docs: {} |
| 136 | + }; |
54 | 137 | repeated ApmFilter service_catalog_filters = 1;
|
55 | 138 | com.coralogixapis.service_catalog.v1.ApmSource apm_source = 2;
|
56 | 139 | }
|
57 | 140 |
|
58 |
| -message GetServicesColumnsStreamRequest{ |
| 141 | +message GetServicesColumnsStreamRequest { |
| 142 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 143 | + json_schema: { |
| 144 | + title: "Get Service Catalog Columns Stream Request" |
| 145 | + description: "This data structure represents a request to Get Service Catalog Columns Stream." |
| 146 | + required: [ |
| 147 | + "query" |
| 148 | + ] |
| 149 | + } |
| 150 | + external_docs: {} |
| 151 | + }; |
59 | 152 | ServiceQuery query = 1;
|
60 | 153 | com.coralogixapis.service_catalog.v1.ApmSource apm_source = 2;
|
61 | 154 | }
|
62 | 155 |
|
63 |
| -message GetServicesColumnsStreamResponse{ |
| 156 | +message GetServicesColumnsStreamResponse { |
| 157 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 158 | + json_schema: { |
| 159 | + title: "Get Service Catalog Columns Stream Response" |
| 160 | + description: "This data structure represents a response to Get Service Catalog Columns Stream." |
| 161 | + required: [] |
| 162 | + } |
| 163 | + external_docs: {} |
| 164 | + }; |
64 | 165 | repeated ServiceData services = 1;
|
65 | 166 | com.coralogixapis.service_catalog.v1.ApmSource apm_source = 2;
|
| 167 | + google.protobuf.StringValue query = 3; |
66 | 168 | }
|
67 | 169 |
|
68 |
| -message GetSpanMetricBucketsRequest {} |
| 170 | +message GetSpanMetricBucketsRequest { |
| 171 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 172 | + json_schema: { |
| 173 | + title: "Get Span Metrics Buckets Request" |
| 174 | + description: "This data structure represents a request to Get span metrics buckets." |
| 175 | + required: [ |
| 176 | + "service_name" |
| 177 | + ] |
| 178 | + } |
| 179 | + external_docs: {} |
| 180 | + }; |
| 181 | + google.protobuf.StringValue service_name = 1; |
| 182 | +} |
69 | 183 |
|
70 | 184 | message GetSpanMetricBucketsResponse {
|
| 185 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 186 | + json_schema: { |
| 187 | + title: "Get Span Metrics Buckets Request" |
| 188 | + description: "This data structure represents a request to Get span metrics buckets." |
| 189 | + required: [] |
| 190 | + } |
| 191 | + external_docs: {} |
| 192 | + }; |
71 | 193 | repeated google.protobuf.StringValue metricBuckets = 1;
|
72 | 194 | }
|
73 | 195 |
|
74 | 196 | message GetAffectedAlertsRequest {
|
| 197 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 198 | + json_schema: { |
| 199 | + title: "Get Affected Alerts Request" |
| 200 | + description: "This data structure represents a request to Get affected alerts." |
| 201 | + required: [] |
| 202 | + } |
| 203 | + external_docs: {} |
| 204 | + }; |
75 | 205 | repeated ApmFilter service_catalog_filters = 1;
|
76 | 206 | repeated com.coralogixapis.apm.common.v2.AlertMetaLabel alert_label_filters = 2;
|
77 | 207 | }
|
78 | 208 |
|
79 | 209 | message GetAffectedAlertsResponse {
|
| 210 | + option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { |
| 211 | + json_schema: { |
| 212 | + title: "Get Affected Alerts Response" |
| 213 | + description: "This data structure represents a response to Get affected alerts." |
| 214 | + required: [] |
| 215 | + } |
| 216 | + external_docs: {} |
| 217 | + }; |
80 | 218 | repeated com.coralogixapis.alerts.v3.AlertDef alerts = 1;
|
81 | 219 | }
|
82 | 220 |
|
83 | 221 | service ServiceCatalogService {
|
84 | 222 | rpc GetServices(GetServicesRequest) returns (GetServicesResponse) {
|
85 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "get services"; |
| 223 | + option (google.api.http) = { |
| 224 | + get: "/v1/service-catalog/services", |
| 225 | + }; |
| 226 | + option (com.coralogix.common.v1.audit_log_description).description = "get services"; |
86 | 227 | }
|
87 | 228 | rpc GetServicesColumnsStream(GetServicesColumnsStreamRequest) returns (stream GetServicesColumnsStreamResponse) {
|
88 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "get services column stream"; |
| 229 | + option (google.api.http) = { |
| 230 | + get: "/v1/service-catalog/services/columns", |
| 231 | + }; |
| 232 | + option (com.coralogix.common.v1.audit_log_description).description = "get services column stream"; |
89 | 233 | }
|
90 | 234 | rpc GetService(GetServiceRequest) returns (GetServiceResponse) {
|
91 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "get service"; |
| 235 | + option (google.api.http) = { |
| 236 | + get: "/v1/service-catalog/services/service", |
| 237 | + }; |
| 238 | + option (com.coralogix.common.v1.audit_log_description).description = "get service"; |
92 | 239 | }
|
93 | 240 |
|
94 | 241 | rpc GetServiceCatalogFilters(GetServiceCatalogFiltersRequest) returns (GetServiceCatalogFiltersResponse) {
|
95 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "get service catalog filters"; |
| 242 | + option (google.api.http) = { |
| 243 | + get: "/v1/service-catalog/services/filters", |
| 244 | + }; |
| 245 | + option (com.coralogix.common.v1.audit_log_description).description = "get service catalog filters"; |
96 | 246 | }
|
97 | 247 |
|
98 | 248 | rpc UpdateServiceCatalogFilters(UpdateServiceCatalogFiltersRequest) returns (UpdateServiceCatalogFiltersResponse) {
|
99 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "update service catalog filters"; |
| 249 | + option (google.api.http) = { |
| 250 | + post: "/v1/service-catalog/services/filters", |
| 251 | + body: "*" |
| 252 | + }; |
| 253 | + option (com.coralogix.common.v1.audit_log_description).description = "update service catalog filters"; |
100 | 254 | }
|
101 | 255 |
|
102 | 256 | rpc GetTracingLabels(com.coralogix.schemastore.v1.TracingFieldsRequest) returns (com.coralogix.schemastore.v1.TracingFieldsResponse) {
|
103 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "get tracing labels under the limitation of cardinality"; |
| 257 | + option (google.api.http) = { |
| 258 | + get: "/v1/service-catalog/tracing-labels", |
| 259 | + }; |
| 260 | + option (com.coralogix.common.v1.audit_log_description).description = "get tracing labels under the limitation of cardinality"; |
104 | 261 | }
|
105 | 262 |
|
106 |
| - rpc GetSpanMetricBuckets(GetSpanMetricBucketsRequest) returns (GetSpanMetricBucketsResponse){ |
107 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "Get Span Metric Buckets"; |
| 263 | + rpc GetSpanMetricBuckets(GetSpanMetricBucketsRequest) returns (GetSpanMetricBucketsResponse) { |
| 264 | + option (google.api.http) = { |
| 265 | + get: "/v1/service-catalog/span-metrics/buckets", |
| 266 | + }; |
| 267 | + option (com.coralogix.common.v1.audit_log_description).description = "Get Span Metric Buckets"; |
108 | 268 | }
|
109 | 269 |
|
110 |
| - rpc GetAffectedAlerts(GetAffectedAlertsRequest) returns (GetAffectedAlertsResponse){ |
111 |
| - option (com.coralogixapis.apm.common.v2.audit_log_description).description = "Get Affected Alerts By Dimension Change"; |
| 270 | + rpc GetAffectedAlerts(GetAffectedAlertsRequest) returns (GetAffectedAlertsResponse) { |
| 271 | + option (google.api.http) = { |
| 272 | + get: "/v1/service-catalog/affected-alerts", |
| 273 | + }; |
| 274 | + option (com.coralogix.common.v1.audit_log_description).description = "Get Affected Alerts By Dimension Change"; |
112 | 275 | }
|
113 |
| - |
114 | 276 | }
|
0 commit comments