open-consul/proto-public/pbdns/dns.proto

36 lines
815 B
Protocol Buffer
Raw Normal View History

2022-09-30 04:14:16 +00:00
syntax = "proto3";
package hashicorp.consul.dns;
Protobuf Refactoring for Multi-Module Cleanliness (#16302) Protobuf Refactoring for Multi-Module Cleanliness This commit includes the following: Moves all packages that were within proto/ to proto/private Rewrites imports to account for the packages being moved Adds in buf.work.yaml to enable buf workspaces Names the proto-public buf module so that we can override the Go package imports within proto/buf.yaml Bumps the buf version dependency to 1.14.0 (I was trying out the version to see if it would get around an issue - it didn't but it also doesn't break things and it seemed best to keep up with the toolchain changes) Why: In the future we will need to consume other protobuf dependencies such as the Google HTTP annotations for openapi generation or grpc-gateway usage. There were some recent changes to have our own ratelimiting annotations. The two combined were not working when I was trying to use them together (attempting to rebase another branch) Buf workspaces should be the solution to the problem Buf workspaces means that each module will have generated Go code that embeds proto file names relative to the proto dir and not the top level repo root. This resulted in proto file name conflicts in the Go global protobuf type registry. The solution to that was to add in a private/ directory into the path within the proto/ directory. That then required rewriting all the imports. Is this safe? AFAICT yes The gRPC wire protocol doesn't seem to care about the proto file names (although the Go grpc code does tack on the proto file name as Metadata in the ServiceDesc) Other than imports, there were no changes to any generated code as a result of this.
2023-02-17 21:14:46 +00:00
import "annotations/ratelimit/ratelimit.proto";
2023-01-04 16:07:02 +00:00
2022-09-30 04:14:16 +00:00
option go_package = "github.com/hashicorp/consul/proto-public/pbdns";
service DNSService {
// Query sends a DNS request over to Consul server and returns a DNS reply message.
2023-01-04 16:07:02 +00:00
rpc Query(QueryRequest) returns (QueryResponse) {
option (hashicorp.consul.internal.ratelimit.spec) = {
operation_type: OPERATION_TYPE_READ,
operation_category: OPERATION_CATEGORY_DNS
};
2023-01-04 16:07:02 +00:00
}
2022-09-30 04:14:16 +00:00
}
enum Protocol {
PROTOCOL_UNSET_UNSPECIFIED = 0;
PROTOCOL_TCP = 1;
PROTOCOL_UDP = 2;
}
message QueryRequest {
// msg is the DNS request message.
bytes msg = 1;
// protocol is the protocol of the request
Protocol protocol = 2;
}
message QueryResponse {
// msg is the DNS reply message.
bytes msg = 1;
}