@chill-institute/contracts 0.1.0

package/proto/chill/v4/api.proto

@@ -0,0 +1,484 @@
+syntax = "proto3";
+
+package chill.v4;
+
+import "protoc-gen-openapiv2/options/annotations.proto";
+
+option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
+  base_path: "/v4";
+  info: {
+    title: "Chill API v4 RPC";
+    version: "4";
+  };
+  security_definitions: {
+    security: {
+      key: "ApiKeyAuth";
+      value: {
+        type: TYPE_API_KEY;
+        in: IN_HEADER;
+        name: "X-API-Key";
+      };
+    };
+    security: {
+      key: "BearerAuth";
+      value: {
+        type: TYPE_API_KEY;
+        in: IN_HEADER;
+        name: "Authorization";
+      };
+    };
+  };
+};
+
+service CoreService {
+  rpc HealthCheck(HealthCheckRequest) returns (HealthResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "ApiKeyAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "X-API-Key";
+          description: "Core API key";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc GetIndexers(CoreGetIndexersRequest) returns (CoreGetIndexersResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "ApiKeyAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "X-API-Key";
+          description: "Core API key";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc Search(CoreSearchRequest) returns (SearchResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "ApiKeyAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "X-API-Key";
+          description: "Core API key";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc GetTopMoviesBySource(GetTopMoviesBySourceRequest) returns (GetTopMoviesBySourceResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "ApiKeyAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "X-API-Key";
+          description: "Core API key";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+}
+
+service UserService {
+  rpc GetIndexers(UserGetIndexersRequest) returns (UserGetIndexersResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc Search(UserSearchRequest) returns (SearchResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc GetTopMovies(UserGetTopMoviesRequest) returns (UserGetTopMoviesResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc GetUserSettings(GetUserSettingsRequest) returns (UserSettings) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc SaveUserSettings(SaveUserSettingsRequest) returns (UserSettings) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc AddTransfer(AddTransferRequest) returns (AddTransferResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc GetDownloadFolder(GetDownloadFolderRequest) returns (GetDownloadFolderResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc GetFolder(GetFolderRequest) returns (GetFolderResponse) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+  rpc GetUserProfile(GetUserProfileRequest) returns (UserProfile) {
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      security: {
+        security_requirement: {
+          key: "BearerAuth";
+          value: {};
+        };
+      };
+      parameters: {
+        headers: {
+          name: "Authorization";
+          description: "Bearer auth token. Format: Bearer <token>";
+          type: STRING;
+          required: true;
+        };
+      };
+    };
+  }
+}
+
+message HealthCheckRequest {}
+
+message HealthResponse {
+  string status = 1;
+}
+
+message CoreGetIndexersRequest {}
+
+message Indexer {
+  string id = 1;
+  string name = 2;
+}
+
+message CoreGetIndexersResponse {
+  repeated Indexer indexers = 1;
+}
+
+message UserGetIndexersRequest {}
+
+message UserGetIndexersResponse {
+  repeated UserIndexer indexers = 1;
+}
+
+message UserIndexer {
+  string id = 1;
+  string name = 2;
+  bool enabled = 3;
+}
+
+message CoreSearchRequest {
+  string query = 1;
+}
+
+message SearchResult {
+  string id = 1;
+  string title = 2;
+  string indexer = 3;
+  string link = 4;
+  optional string imdb_id = 5;
+  int64 peers = 6;
+  int64 seeders = 7;
+  int64 size = 8;
+  string source = 9;
+  string uploaded_at = 10;
+}
+
+message SearchResponse {
+  string query = 1;
+  repeated SearchResult results = 2;
+}
+
+message UserSearchRequest {
+  string query = 1;
+  optional string indexer_id = 2;
+}
+
+enum TopMoviesSource {
+  TOP_MOVIES_SOURCE_UNSPECIFIED = 0;
+  TOP_MOVIES_SOURCE_IMDB_MOVIEMETER = 1;
+  TOP_MOVIES_SOURCE_IMDB_TOP_250 = 2;
+  TOP_MOVIES_SOURCE_YTS = 3;
+  TOP_MOVIES_SOURCE_ROTTEN_TOMATOES = 4;
+  TOP_MOVIES_SOURCE_TRAKT = 5;
+}
+
+message GetTopMoviesBySourceRequest {
+  TopMoviesSource source = 1;
+}
+
+message TopMovie {
+  string id = 1;
+  string title = 2;
+  int32 year = 3;
+  TopMoviesSource source = 4;
+  string title_pretty = 5;
+  string link = 6;
+  int64 peers = 7;
+  int64 seeders = 8;
+  int64 size = 9;
+  string uploaded_at = 10;
+  string poster_url = 11;
+  double rating = 12;
+  string external_url = 13;
+}
+
+message GetTopMoviesBySourceResponse {
+  TopMoviesSource source = 1;
+  repeated TopMovie movies = 2;
+}
+
+message UserGetTopMoviesRequest {}
+
+message UserGetTopMoviesResponse {
+  TopMoviesSource source = 1;
+  repeated TopMovie movies = 2;
+}
+
+message GetUserSettingsRequest {}
+
+enum ResolutionFilter {
+  RESOLUTION_FILTER_UNSPECIFIED = 0;
+  RESOLUTION_FILTER_720P = 1;
+  RESOLUTION_FILTER_1080P = 2;
+  RESOLUTION_FILTER_2160P = 3;
+}
+
+enum CodecFilter {
+  CODEC_FILTER_UNSPECIFIED = 0;
+  CODEC_FILTER_X264 = 1;
+  CODEC_FILTER_X265 = 2;
+}
+
+enum OtherFilter {
+  OTHER_FILTER_UNSPECIFIED = 0;
+  OTHER_FILTER_HDR = 1;
+}
+
+enum SearchResultDisplayBehavior {
+  SEARCH_RESULT_DISPLAY_BEHAVIOR_UNSPECIFIED = 0;
+  SEARCH_RESULT_DISPLAY_BEHAVIOR_ALL = 1;
+  SEARCH_RESULT_DISPLAY_BEHAVIOR_FASTEST = 2;
+}
+
+enum SearchResultTitleBehavior {
+  SEARCH_RESULT_TITLE_BEHAVIOR_UNSPECIFIED = 0;
+  SEARCH_RESULT_TITLE_BEHAVIOR_LINK = 1;
+  SEARCH_RESULT_TITLE_BEHAVIOR_TEXT = 2;
+}
+
+enum SortBy {
+  SORT_BY_UNSPECIFIED = 0;
+  SORT_BY_TITLE = 1;
+  SORT_BY_SEEDERS = 2;
+  SORT_BY_SIZE = 3;
+  SORT_BY_UPLOADED_AT = 4;
+  SORT_BY_SOURCE = 5;
+}
+
+enum SortDirection {
+  SORT_DIRECTION_UNSPECIFIED = 0;
+  SORT_DIRECTION_ASC = 1;
+  SORT_DIRECTION_DESC = 2;
+}
+
+enum TopMoviesDisplayType {
+  TOP_MOVIES_DISPLAY_TYPE_UNSPECIFIED = 0;
+  TOP_MOVIES_DISPLAY_TYPE_COMPACT = 1;
+  TOP_MOVIES_DISPLAY_TYPE_EXPANDED = 2;
+}
+
+message UserSettings {
+  repeated CodecFilter codec_filters = 1;
+  repeated string disabled_indexer_ids = 2;
+  optional int64 download_folder_id = 3;
+  bool filter_nasty_results = 4;
+  bool filter_results_with_no_seeders = 5;
+  repeated OtherFilter other_filters = 6;
+  bool remember_quick_filters = 7;
+  repeated ResolutionFilter resolution_filters = 8;
+  SearchResultDisplayBehavior search_result_display_behavior = 9;
+  SearchResultTitleBehavior search_result_title_behavior = 10;
+  bool show_pretty_names_for_top_movies = 11;
+  bool show_top_movies = 12;
+  SortBy sort_by = 13;
+  SortDirection sort_direction = 14;
+  TopMoviesDisplayType top_movies_display_type = 15;
+  TopMoviesSource top_movies_source = 16;
+}
+
+message SaveUserSettingsRequest {
+  UserSettings settings = 1;
+}
+
+message AddTransferRequest {
+  string url = 1;
+}
+
+message AddTransferResponse {
+  string status = 1;
+}
+
+message GetDownloadFolderRequest {}
+
+message GetDownloadFolderResponse {
+  UserFile folder = 1;
+}
+
+message GetFolderRequest {
+  int64 id = 1;
+}
+
+message UserFile {
+  int64 id = 1;
+  string name = 2;
+  string file_type = 3;
+  bool is_shared = 4;
+  string created_at = 5;
+}
+
+message GetFolderResponse {
+  UserFile parent = 1;
+  repeated UserFile files = 2;
+}
+
+message GetUserProfileRequest {}
+
+message UserProfile {
+  string user_id = 1;
+  string username = 2;
+  string avatar_url = 3;
+  string email = 4;
+}