forked from jaegertracing/jaeger
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Seperate proto files and generate unified swagger docs
Signed-off-by: Annanay <[email protected]>
- Loading branch information
Annanay
committed
Mar 1, 2019
1 parent
d22f364
commit 0ee8357
Showing
3 changed files
with
127 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
// Copyright (c) 2018 Uber Technologies, Inc. | ||
// | ||
// 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"; | ||
|
||
package jaeger.api_v2; | ||
|
||
import "model.proto"; | ||
import "gogoproto/gogo.proto"; | ||
import "google/api/annotations.proto"; | ||
import "protoc-gen-swagger/options/annotations.proto"; | ||
|
||
option go_package = "api_v2"; | ||
option java_package = "io.jaegertracing.api_v2"; | ||
|
||
// Enable gogoprotobuf extensions (https://github.com/gogo/protobuf/blob/master/extensions.md). | ||
// Enable custom Marshal method. | ||
option (gogoproto.marshaler_all) = true; | ||
// Enable custom Unmarshal method. | ||
option (gogoproto.unmarshaler_all) = true; | ||
// Enable custom Size method (Required by Marshal and Unmarshal). | ||
option (gogoproto.sizer_all) = true; | ||
// Enable registration with golang/protobuf for the grpc-gateway. | ||
option (gogoproto.goproto_registration) = true; | ||
|
||
option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = { | ||
info: { | ||
version: "1.0"; | ||
}; | ||
external_docs: { | ||
url: "https://github.com/jaegertracing/jaeger"; | ||
description: "Jaeger API"; | ||
} | ||
schemes: HTTP; | ||
schemes: HTTPS; | ||
}; | ||
|
||
|
||
message GetTraceRequest { | ||
bytes trace_id = 1 [ | ||
(gogoproto.nullable) = false, | ||
(gogoproto.customtype) = "github.com/jaegertracing/jaeger/model.TraceID", | ||
(gogoproto.customname) = "TraceID" | ||
]; | ||
} | ||
|
||
message GetTraceResponseStream { | ||
repeated jaeger.api_v2.Span spans = 1 [ | ||
(gogoproto.nullable) = false | ||
]; | ||
} | ||
|
||
service QueryService { | ||
rpc GetTrace(GetTraceRequest) returns (stream GetTraceResponseStream) { | ||
option (google.api.http) = { | ||
get: "/api/v2/traces/{trace_id}" | ||
}; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters