syntax = "proto3";

package subreddits.v1;

import "buf/validate/validate.proto";
import "subreddits/v1/create.proto";

option go_package = "github.com/tigorlazuardi/bluemage/go/gen/proto/subreddits/v1";

message GetSubredditRequest {
  // name of the subreddit. Case insensitive.
  //
  // Returns error on not found.
  string name = 1 [(buf.validate.field).string.min_len = 1];
}

message GetSubredditResponse {
  string name = 1;
  bool disable_scheduler = 2;
  // type is never unspecified for this response.
  //
  // It's always either `SUBREDDIT_TYPE_SUBREDDIT`
  // or `SUBREDDIT_TYPE_USER`.
  SubredditType type = 3;
  string schedule = 4;
  uint32 countback = 5;
  // cover_image_id is the id of an image that
  // acts as the cover for this subreddit.
  //
  // May not be present in these kind of situations:
  //
  //  - The background task runner has not run for this subreddit.
  //  - The image that is used as cover is deleted.
  //  - The subreddit does not contain any images.
  //
  // cover_image_id changes after every insert of
  // new images in that subreddit, so avoid
  // caching the image for too long.
  optional uint32 cover_image_id = 6;
  int64 created_at = 7;
  int64 updated_at = 8;
}