annotationspb

type FieldQueryOption int32

type MessageProperties struct {

	// States that given message is comparable to other messages of the same type.
	Comparable bool `protobuf:"varint,1,opt,name=comparable,proto3" json:"comparable,omitempty"`
	// contains filtered or unexported fields
}

type Pagination struct {

	// Is the page size.
	MaxSize int64 `protobuf:"varint,1,opt,name=max_size,json=maxSize,proto3" json:"max_size,omitempty"`
	// Default page size.
	DefaultSize int64 `protobuf:"varint,2,opt,name=default_size,json=defaultSize,proto3" json:"default_size,omitempty"`
	// contains filtered or unexported fields
}

type QueryParameters struct {

	// Pagination parameters that are specific to this message.
	Pagination *Pagination `protobuf:"bytes,1,opt,name=pagination,proto3" json:"pagination,omitempty"`
	// Is a default sorting order of the query.
	// The string format is defined in: https://aip.dev/132#ordering
	// Example:
	//
	//	"name desc, create_time"
	OrderBy string `protobuf:"bytes,2,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// An abstract maximum complexity of the filter that this
	// message supports.
	// This can be used to calculate the complexity of a filter.
	// If served query complexity exceeds this value, the server
	// may return an error with grpc code RESOURCE_EXHAUSTED.
	MaxComplexity int64 `protobuf:"varint,3,opt,name=max_complexity,json=maxComplexity,proto3" json:"max_complexity,omitempty"`
	// The name of the response field that contains resulting
	// resources.
	// This by default is a lower case plural of the resource name.
	// Example:
	//
	//	service FooService {
	//	  rpc ListFoos(ListFoosRequest) returns (ListFoosResponse){
	//	    option (blocky.api.query_params) = {
	//	      results: "foos"
	//	    };
	//
	//	message ListFoosResponse {
	//	  repeated Foo foos = 1;
	//	}
	//	The default value of this field is "foos".
	//
	// This field might be really useful for non-standard
	// pluralization rules i.e. "foos" -> "foo_list".
	Results string `protobuf:"bytes,4,opt,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}