54 lines
1.4 KiB
Protocol Buffer
54 lines
1.4 KiB
Protocol Buffer
syntax = "proto3";
|
|
|
|
package subreddits.v1;
|
|
|
|
import "subreddits/v1/types.proto";
|
|
|
|
option go_package = "github.com/tigorlazuardi/bluemage/go/gen/proto/subreddits/v1";
|
|
|
|
message ListSubredditsRequest {
|
|
// Searches the name of the Subreddit.
|
|
// case insensitive.
|
|
//
|
|
// If empty or not given, lists all devices.
|
|
// (Limit, Offset, Order, Sort still applies).
|
|
//
|
|
// default: empty string.
|
|
string search = 1;
|
|
|
|
// disabled, if true, limit the listing subreddits to only
|
|
// to disabled subreddits.
|
|
//
|
|
// if enabled, lists only enabled subreddits.
|
|
//
|
|
// If unspecified, subreddits with either status will be received.
|
|
DisabledFilter disabled = 2;
|
|
|
|
// limits the number of results.
|
|
//
|
|
// if value is 0, negative value, or not given, limit is set to 25.
|
|
//
|
|
// if limit is higher than 100, it is clamped to 100.
|
|
int64 limit = 3;
|
|
|
|
// offset for the given data.
|
|
//
|
|
// If offset is 0, negative value, or not given, the query begins from start.
|
|
int64 offset = 4;
|
|
|
|
// order_by is the field to order the subreddits by.
|
|
//
|
|
// If unspecified, the default is `created_at` and sort is forced to DESC.
|
|
// regardless even if `sort` is set.
|
|
OrderBy order_by = 5;
|
|
|
|
// sort is the direction of the order_by result.
|
|
//
|
|
// If unspecified, the default is `ascending`.
|
|
Sort sort = 6;
|
|
}
|
|
|
|
message ListSubredditsResponse {
|
|
repeated Subreddit subreddits = 1;
|
|
}
|