Update schema description to reflect gRPC as communication protocol

This commit is contained in:
Christian Schaible 2024-09-09 13:28:51 +02:00
parent 61ac703743
commit 313486e30b
2 changed files with 8 additions and 8 deletions

View file

@ -1164,11 +1164,11 @@ type AttributeContext_Request struct {
// //
// Required: false // Required: false
Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"` Id *string `protobuf:"bytes,1,opt,name=id,proto3,oneof" json:"id,omitempty"`
// The HTTP request method, such as `GET`, `POST`. // The (HTTP) request method, such as `GET`, `POST`.
// //
// Required: true // Required: true
Method AttributeContext_HttpMethod `protobuf:"varint,2,opt,name=method,proto3,enum=audit.v1.AttributeContext_HttpMethod" json:"method,omitempty"` Method AttributeContext_HttpMethod `protobuf:"varint,2,opt,name=method,proto3,enum=audit.v1.AttributeContext_HttpMethod" json:"method,omitempty"`
// The HTTP request headers. If multiple headers share the same key, they // The (HTTP) request headers / gRPC metadata. If multiple headers share the same key, they
// must be merged according to the HTTP spec. All header keys must be // must be merged according to the HTTP spec. All header keys must be
// lowercased, because HTTP header keys are case-insensitive. // lowercased, because HTTP header keys are case-insensitive.
// //
@ -1176,7 +1176,7 @@ type AttributeContext_Request struct {
// //
// Required: true // Required: true
Headers map[string]string `protobuf:"bytes,3,rep,name=headers,proto3" json:"headers,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"` Headers map[string]string `protobuf:"bytes,3,rep,name=headers,proto3" json:"headers,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
// The HTTP URL path. // The gRPC / HTTP URL path.
// //
// Required: true // Required: true
Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"` Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
@ -1184,7 +1184,7 @@ type AttributeContext_Request struct {
// //
// Required: true // Required: true
Host string `protobuf:"bytes,5,opt,name=host,proto3" json:"host,omitempty"` Host string `protobuf:"bytes,5,opt,name=host,proto3" json:"host,omitempty"`
// The HTTP URL scheme, such as `http` and `https`. // The URL scheme, such as `http`, `https` or `gRPC`.
// //
// Required: true // Required: true
Scheme string `protobuf:"bytes,6,opt,name=scheme,proto3" json:"scheme,omitempty"` Scheme string `protobuf:"bytes,6,opt,name=scheme,proto3" json:"scheme,omitempty"`

View file

@ -435,7 +435,7 @@ message AttributeContext {
// Required: false // Required: false
optional string id = 1; optional string id = 1;
// The HTTP request method, such as `GET`, `POST`. // The (HTTP) request method, such as `GET`, `POST`.
// //
// Required: true // Required: true
HttpMethod method = 2 [ HttpMethod method = 2 [
@ -443,7 +443,7 @@ message AttributeContext {
(buf.validate.field).enum.defined_only = true (buf.validate.field).enum.defined_only = true
]; ];
// The HTTP request headers. If multiple headers share the same key, they // The (HTTP) request headers / gRPC metadata. If multiple headers share the same key, they
// must be merged according to the HTTP spec. All header keys must be // must be merged according to the HTTP spec. All header keys must be
// lowercased, because HTTP header keys are case-insensitive. // lowercased, because HTTP header keys are case-insensitive.
// //
@ -454,7 +454,7 @@ message AttributeContext {
(buf.validate.field).required = true (buf.validate.field).required = true
]; ];
// The HTTP URL path. // The gRPC / HTTP URL path.
// //
// Required: true // Required: true
string path = 4 [ string path = 4 [
@ -471,7 +471,7 @@ message AttributeContext {
(buf.validate.field).string.min_len = 1 (buf.validate.field).string.min_len = 1
]; ];
// The HTTP URL scheme, such as `http` and `https`. // The URL scheme, such as `http`, `https` or `gRPC`.
// //
// Required: true // Required: true
string scheme = 6 [ string scheme = 6 [