@devvit/protos 0.12.1-next-2025-09-08-20-55-43-6ce1b439e.0 → 0.12.1-next-2025-09-09-13-45-18-0f0a506a2.0

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/plugin/redditapi/wiki/wiki_msg.proto

@@ -0,0 +1,217 @@
+syntax = "proto3";
+
+package devvit.plugin.redditapi.wiki;
+
+import "devvit/plugin/redditapi/common/common_msg.proto";
+import "google/protobuf/wrappers.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/redditapi";
+option java_package = "com.reddit.devvit.plugin.redditapi.wiki";
+
+message GetWikiPagesRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+}
+
+message GetWikiPagesResponse {
+  // String value: "wikipagelisting"
+  string kind = 1;
+  // A list of wiki page names.
+  repeated string data = 2;
+}
+
+message GetWikiPageRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+}
+
+message WikiPage {
+  // The markdown content of the wiki page.
+  string content_md = 1;
+  // The HTML content of the wiki page.
+  string content_html = 2;
+  // The revision ID of the wiki page.
+  string revision_id = 3;
+  // The date of the wiki page's last revision.
+  int64 revision_date = 4;
+  // Whether the wiki page can be revised.
+  bool may_revise = 5;
+  // The reason for the wiki page's last revision.
+  google.protobuf.StringValue reason = 6;
+  // The user who last edited the wiki page.
+  devvit.plugin.redditapi.common.WrappedUserObject revision_by = 7;
+}
+
+message GetWikiPageResponse {
+  // String value: "wikipage"
+  string kind = 1;
+  // The data of the wiki page.
+  WikiPage data = 2;
+}
+
+message EditWikiPageRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+  // The new content of the wiki page.
+  string content = 3;
+  // The reason for the edit.
+  string reason = 4;
+}
+
+message HideWikiPageRevisionRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+  // The revision ID to hide.
+  string revision = 3;
+}
+
+message HideWikiPageRevisionResponse {
+  // Whether the revision was hidden.
+  bool status = 1;
+}
+
+message GetWikiPageRevisionsRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+  // Revision ID
+  // Return Revisions in the listing up to this Revision (non-inclusive)
+  // Note: Do not use `before` and `after` in the same request
+  google.protobuf.StringValue after = 3;
+  // Revision ID
+  // Return Revisions in the listing starting after this Revision (non-inclusive)
+  // Note: Do not use `before` and `after` in the same request
+  google.protobuf.StringValue before = 4;
+  // The maximum number of revisions to return.
+  google.protobuf.Int64Value limit = 5;
+  // The number of items seen so far.
+  // Use when fetching subsequent pages with `before` or `after`.
+  google.protobuf.Int64Value count = 6;
+  // (optional) Show all results regardless of user preferences
+  google.protobuf.BoolValue show = 7;
+  // (optional) expand subreddits
+  google.protobuf.BoolValue sr_detail = 8;
+}
+
+message WikiPageRevision {
+  // ID of the revision.
+  string id = 1;
+  // The name of the wiki page.
+  string page = 2;
+  // The date of the revision.
+  int64 timestamp = 3;
+  // The reason for the revision.
+  string reason = 4;
+  // Whether the revision is hidden.
+  bool revision_hidden = 5;
+  // The user who made the revision.
+  devvit.plugin.redditapi.common.WrappedUserObject author = 6;
+}
+
+message WikiPageRevisionListing {
+  message Data {
+    // If present, use this as the `after` parameter when calling the same
+    // API again to fetch the next page
+    google.protobuf.StringValue after = 1;
+    // If present, use this as the `before` parameter when calling the same
+    // API again to fetch the previous page
+    google.protobuf.StringValue before = 2;
+    // Contents of the current page of the listing
+    repeated WikiPageRevision children = 3;
+    // Number of objects in `children`
+    // Note: Only counts immediate entries in `children` and does not count
+    //       nested objects such as comment trees
+    google.protobuf.Int64Value dist = 4;
+  }
+
+  // String value: "Listing"
+  string kind = 1;
+  // The data of the wiki page revision listing.
+  Data data = 2;
+}
+
+message GetWikiRevisionsRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // Revision ID
+  // Return Revisions in the listing up to this Revision (non-inclusive)
+  // Note: Do not use `before` and `after` in the same request
+  google.protobuf.StringValue after = 2;
+  // Revision ID
+  // Return Revisions in the listing starting after this Revision (non-inclusive)
+  // Note: Do not use `before` and `after` in the same request
+  google.protobuf.StringValue before = 3;
+  // The maximum number of revisions to return.
+  google.protobuf.Int64Value limit = 4;
+  // The number of items seen so far.
+  // Use when fetching subsequent pages with `before` or `after`.
+  google.protobuf.Int64Value count = 5;
+  // (optional) Show all results regardless of user preferences
+  google.protobuf.BoolValue show = 6;
+  // (optional) expand subreddits
+  google.protobuf.BoolValue sr_detail = 7;
+}
+
+message RevertWikiPageRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+  // The revision ID to revert to.
+  string revision = 3;
+}
+
+message GetWikiPageSettingsRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+}
+
+message WikiPageSettings {
+  message Data {
+    // The permission level required to edit the wiki page.
+    int32 perm_level = 1;
+    // The users who can edit the wiki page.
+    repeated devvit.plugin.redditapi.common.WrappedUserObject editors = 2;
+    // Whether the wiki page is listed.
+    bool listed = 3;
+  }
+
+  // String value: "wikipagesettings"
+  string kind = 1;
+  // The data of the wiki page settings.
+  Data data = 2;
+}
+
+message UpdateWikiPageSettingsRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+  // The permission level required to edit the wiki page.
+  // 0: Use subreddit wiki permissions
+  // 1: Only approved wiki contributors for this page may edit
+  // 2: Only mods may edit and view
+  int32 permlevel = 3;
+  // Whether the wiki page is listed. "on" to list, empty string to hide.
+  string listed = 4;
+}
+
+message AllowEditorRequest {
+  // The subreddit omitting the r/ prefix.
+  string subreddit = 1;
+  // The name of the wiki page.
+  string page = 2;
+  // Either "add" or "del".
+  string act = 3;
+  // The username of the user to allow or deny.
+  string username = 4;
+}

package/schema/.snootobuf/deps/.snootobuf/deps/devvit/plugin/redditapi/wiki/wiki_svc.proto

@@ -0,0 +1,91 @@
+syntax = "proto3";
+
+package devvit.plugin.redditapi.wiki;
+
+import "devvit/plugin/redditapi/common/common_msg.proto";
+import "devvit/plugin/redditapi/wiki/wiki_msg.proto";
+import "google/protobuf/empty.proto";
+
+option go_package = "github.snooguts.net/reddit/reddit-devplatform-monorepo/go-common/generated/protos/types/devvit/plugin/redditapi";
+option java_package = "com.reddit.devvit.plugin.redditapi.wiki";
+
+// WIKI - https://www.reddit.com/dev/api#section_wiki
+service Wiki {
+  // Get a list of wiki pages for a subreddit
+  //
+  // @see {@link https://www.reddit.com/dev/api#GET_wiki_pages}
+  rpc GetWikiPages(GetWikiPagesRequest) returns (GetWikiPagesResponse) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'GET';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/wiki/pages';
+  }
+  // Get a wiki page
+  //
+  // @see {@link https://www.reddit.com/dev/api#GET_wiki_\{page\}}
+  rpc GetWikiPage(GetWikiPageRequest) returns (GetWikiPageResponse) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'GET';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/wiki/{page}';
+    option (devvit.plugin.redditapi.common.api_client_config).use_custom_response_parser = true;
+  }
+  // Edit wiki page
+  //
+  // @see {@link https://www.reddit.com/dev/api#POST_api_wiki_edit}
+  rpc EditWikiPage(EditWikiPageRequest) returns (google.protobuf.Empty) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'POST';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/api/wiki/edit';
+    option (devvit.plugin.redditapi.common.api_client_config).request_body_type = FORM_SNAKE;
+  }
+  // Hide a wiki page revision
+  //
+  // @see {@link https://www.reddit.com/dev/api#POST_api_wiki_hide}
+  rpc HideWikiPageRevision(HideWikiPageRevisionRequest) returns (HideWikiPageRevisionResponse) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'POST';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/api/wiki/hide';
+    option (devvit.plugin.redditapi.common.api_client_config).request_body_type = FORM_SNAKE;
+  }
+  // Get a list of revisions of a wiki page
+  //
+  // @see {@link https://www.reddit.com/dev/api#GET_wiki_revisions_\{page\}}
+  rpc GetWikiPageRevisions(GetWikiPageRevisionsRequest) returns (WikiPageRevisionListing) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'GET';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/wiki/revisions/{page}?after={after}&before={before}&count={count}&limit={limit}&show={show}&sr_detail={sr_detail}';
+  }
+  // Retrieve a list of recently changed wiki pages in this subreddit
+  //
+  // @see {@link https://www.reddit.com/dev/api#GET_wiki_revisions}
+  rpc GetWikiRevisions(GetWikiRevisionsRequest) returns (WikiPageRevisionListing) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'GET';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/wiki/revisions?after={after}&before={before}&count={count}&limit={limit}&show={show}&sr_detail={sr_detail}';
+  }
+  // Revert a wiki page to revision
+  //
+  // @see {@link https://www.reddit.com/dev/api#POST_api_wiki_revert}
+  rpc RevertWikiPage(RevertWikiPageRequest) returns (google.protobuf.Empty) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'POST';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/api/wiki/revert';
+    option (devvit.plugin.redditapi.common.api_client_config).request_body_type = FORM_SNAKE;
+  }
+  // Retrieve the current permission settings for page
+  //
+  // @see {@link https://www.reddit.com/dev/api#GET_wiki_settings_\{page\}}
+  rpc GetWikiPageSettings(GetWikiPageSettingsRequest) returns (WikiPageSettings) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'GET';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/wiki/settings/{page}';
+  }
+  // Update the permissions and visibility of wiki page
+  //
+  // @see {@link https://www.reddit.com/dev/api#POST_wiki_settings_\{page\}}
+  rpc UpdateWikiPageSettings(UpdateWikiPageSettingsRequest) returns (WikiPageSettings) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'POST';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/wiki/settings/{page}';
+    option (devvit.plugin.redditapi.common.api_client_config).request_body_type = FORM_CAMEL;
+  }
+  // Allow/deny username to edit this wiki page
+  // Note act must be either "add" or "del"
+  //
+  // @see {@link https://www.reddit.com/dev/api#POST_api_wiki_alloweditor_\{act\}}
+  rpc AllowEditor(AllowEditorRequest) returns (google.protobuf.Empty) {
+    option (devvit.plugin.redditapi.common.api_client_config).method = 'POST';
+    option (devvit.plugin.redditapi.common.api_client_config).path = '/r/{subreddit}/api/wiki/alloweditor/{act}';
+    option (devvit.plugin.redditapi.common.api_client_config).request_body_type = FORM_SNAKE;
+  }
+}