{ "swagger": "2.0", "info": { "title": "Discourse API Documentation", "x-logo": { "url": "https://discourse-meta.s3-us-west-1.amazonaws.com/optimized/3X/9/d/9d543e92b15b06924249654667a81441a55867eb_1_690x184.png" }, "description": "Documentation on how to use Discourse through API calls.\n\n### Authentication\n\nSome endpoints do not require any authentication, pretty much anything else will\nrequire you to be authenticated.\n\nTo become authenticated you will need to create an API Key from the admin panel.\n\nOnce you have your API Key you can pass it in as a GET url parameter like this:\n\n```\ncurl -X GET \"http://127.0.0.1:3000/admin/users/list/active.json?api_key=714552c6148e1617aeab526d0606184b94a80ec048fc09894ff1a72b740c5f19&api_username=discourse1\"\n```\n\nIf you are making a POST request you can pass them in the body:\n\n```\ncurl -X POST \"Content-Type: multipart/form-data;\" -F \"api_key=714552c6148e1617aeab526d0606184b94a80ec048fc09894ff1a72b740c5f19\" -F \"api_username=discourse1\" -F \"name=89853c20-4409-e91a-a8ea-f6cdff96aaaa\" -F \"color=49d9e9\" -F \"text_color=f0fcfd\" \"http://127.0.0.1:3000/categories\"\n```\n", "version": "latest" }, "host": "discourse.example.com", "schemes": [ "https" ], "basePath": "/", "produces": [ "application/json" ], "paths": { "/categories.json": { "get": { "summary": "Get a list of categories", "description": "The Categories endpoint returns a list of all the categories for\nyour discourse site that you have access to.\n", "parameters": [], "tags": [ "Categories" ], "responses": { "200": { "description": "A category_list object that contains an array of categories\n", "schema": { "type": "object", "properties": { "category_list": { "type": "object", "properties": { "can_create_category": { "type": "boolean" }, "can_create_topic": { "type": "boolean" }, "draft": { "type": "boolean" }, "draft_key": { "type": "string" }, "draft_sequence": { "type": "integer" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "text_color": { "type": "string" }, "slug": { "type": "string" }, "topic_count": { "type": "integer" }, "post_count": { "type": "integer" }, "position": { "type": "integer" }, "description": { "type": "string" }, "description_text": { "type": "string" }, "topic_url": { "type": "string" }, "logo_url": { "type": "string" }, "background_url": { "type": "string" }, "read_restricted": { "type": "boolean" }, "permission": { "type": "integer" }, "notification_level": { "type": "string" }, "can_edit": { "type": "boolean" }, "topic_template": { "type": "string" }, "has_children": { "type": "boolean" }, "topics_day": { "type": "integer" }, "topics_week": { "type": "integer" }, "topics_month": { "type": "integer" }, "topics_year": { "type": "integer" }, "topics_all_time": { "type": "integer" }, "description_excerpt": { "type": "string" } } } } } } } } } } }, "post": { "description": "Create a new category", "parameters": [ { "name": "name", "in": "body", "required": true, "schema": { "type": "object", "required": [ "name", "color", "text_color" ], "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "text_color": { "type": "string" } } } } ], "tags": [ "Categories" ], "responses": { "200": { "description": "category response", "schema": { "type": "object", "properties": { "category": { "type": "object", "properties": { "id": { "type": "integer", "description": "The id for the category" }, "name": { "type": "string", "description": null }, "color": { "type": "string", "description": null }, "text_color": { "type": "string", "description": null }, "slug": { "type": "string" }, "topic_count": { "type": "integer" }, "post_count": { "type": "integer" }, "position": { "type": "integer" }, "description": { "type": "string" }, "description_text": { "type": "string" }, "topic_url": { "type": "string" }, "logo_url": { "type": "string" }, "background_url": { "type": "string" }, "read_restricted": { "type": "boolean" }, "permission": { "type": "string" }, "notification_level": { "type": "string" }, "can_edit": { "type": "boolean" }, "topic_template": { "type": "string" }, "has_children": { "type": "boolean" }, "available_groups": { "type": "array" }, "auto_close_hours": { "type": "integer" }, "auto_close_based_on_last_post": { "type": "boolean" }, "group_permissions": { "type": "array" }, "email_in": { "type": "boolean" }, "email_in_allow_strangers": { "type": "boolean" }, "suppress_from_homepage": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "cannot_delete_reason": { "type": "string" }, "allow_badges": { "type": "boolean" }, "custom_fields": { "type": "object" } } } } } } } } }, "/c/{id}.json": { "get": { "description": "Get a single category\n", "tags": [ "Categories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "category response", "schema": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "username": { "type": "string" }, "avatar_template": { "type": "string" } } } }, "topic_list": { "type": "object", "properties": { "can_create_topic": { "type": "boolean" }, "draft": { "type": "boolean" }, "draft_key": { "type": "string" }, "draft_sequence": { "type": "integer" }, "per_page": { "type": "integer" }, "topics": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "fancy_title": { "type": "string" }, "slug": { "type": "string" }, "posts_count": { "type": "integer" }, "reply_count": { "type": "integer" }, "highest_post_number": { "type": "integer" }, "image_url": { "type": "string" }, "created_at": { "type": "string" }, "last_posted_at": { "type": "string" }, "bumped": { "type": "boolean" }, "bumped_at": { "type": "string" }, "unseen": { "type": "boolean" }, "pinned": { "type": "boolean" }, "unpinned": { "type": "boolean" }, "excerpt": { "type": "string" }, "visible": { "type": "boolean" }, "closed": { "type": "boolean" }, "archived": { "type": "boolean" }, "bookmarked": { "type": "object" }, "liked": { "type": "object" }, "views": { "type": "integer" }, "like_count": { "type": "integer" }, "has_summary": { "type": "boolean" }, "archetype": { "type": "string" }, "last_poster_username": { "type": "string" }, "category_id": { "type": "integer" }, "pinned_globally": { "type": "boolean" }, "posters": { "type": "array", "items": { "type": "object", "properties": { "extras": { "type": "string" }, "description": { "type": "string" }, "user_id": { "type": "integer" } } } } } } } } } } } } } } }, "/categories/{id}": { "put": { "description": "Update a single category\n", "tags": [ "Categories" ], "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "required": [ "name", "color", "text_color" ], "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "text_color": { "type": "string" } } } } ], "responses": { "200": { "description": "update category response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "success": { "type": "string", "minLength": 1 }, "category": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string", "minLength": 1 }, "color": { "type": "string", "minLength": 1 }, "text_color": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "topic_count": { "type": "number" }, "post_count": { "type": "number" }, "position": { "type": "number" }, "description": { "type": "object" }, "description_text": { "type": "object" }, "topic_url": { "type": "string", "minLength": 1 }, "logo_url": { "type": "string" }, "background_url": { "type": "string" }, "read_restricted": { "type": "boolean" }, "permission": { "type": "object" }, "notification_level": { "type": "object" }, "can_edit": { "type": "boolean" }, "topic_template": { "type": "string" }, "has_children": { "type": "object" }, "available_groups": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "auto_close_hours": { "type": "object" }, "auto_close_based_on_last_post": { "type": "boolean" }, "group_permissions": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "permission_type", "group_name" ], "properties": { "permission_type": { "type": "number" }, "group_name": { "type": "string", "minLength": 1 } } } }, "email_in": { "type": "object" }, "email_in_allow_strangers": { "type": "boolean" }, "suppress_from_homepage": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "cannot_delete_reason": { "type": "object" }, "allow_badges": { "type": "boolean" }, "custom_fields": { "type": "object" } } } } } } } } }, "/posts": { "post": { "description": "Create a new topic, a new post, or a private message\n", "tags": [ "Topics", "Posts" ], "parameters": [ { "name": "body", "in": "body", "required": false, "schema": { "type": "object", "required": [ "raw" ], "properties": { "title": { "type": "string", "description": "required if creating a new topic or new private message\n" }, "topic_id": { "type": "integer", "description": "required if creating a new post" }, "raw": { "type": "string" }, "category": { "type": "integer", "description": "optional if creating a new topic,\nignored if creating a new post\n" }, "target_usernames": { "type": "string", "description": "required for private message, comma separated\n", "example": "discourse1,discourse2" }, "archetype": { "type": "string", "description": "required for private message\n", "example": "private_message", "enum": [ "private_message" ] } } } } ], "responses": { "200": { "description": "new topic response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "cooked": { "type": "string", "minLength": 1 }, "post_number": { "type": "number" }, "post_type": { "type": "number" }, "updated_at": { "type": "string", "minLength": 1 }, "reply_count": { "type": "number" }, "reply_to_post_number": { "type": null }, "quote_count": { "type": "number" }, "avg_time": { "type": null }, "incoming_link_count": { "type": "number" }, "reads": { "type": "number" }, "score": { "type": "number" }, "yours": { "type": "boolean" }, "topic_id": { "type": "number" }, "topic_slug": { "type": "string", "minLength": 1 }, "display_username": { "type": "string" }, "primary_group_name": { "type": null }, "primary_group_flair_url": { "type": null }, "primary_group_flair_bg_color": { "type": null }, "primary_group_flair_color": { "type": null }, "version": { "type": "number" }, "can_edit": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_recover": { "type": "boolean" }, "can_wiki": { "type": "boolean" }, "user_title": { "type": null }, "actions_summary": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "hidden", "can_act" ], "properties": { "id": { "type": "number" }, "hidden": { "type": "boolean" }, "can_act": { "type": "boolean" } } } }, "moderator": { "type": "boolean" }, "admin": { "type": "boolean" }, "staff": { "type": "boolean" }, "user_id": { "type": "number" }, "draft_sequence": { "type": "number" }, "hidden": { "type": "boolean" }, "hidden_reason_id": { "type": null }, "trust_level": { "type": "number" }, "deleted_at": { "type": null }, "user_deleted": { "type": "boolean" }, "edit_reason": { "type": null }, "can_view_edit_history": { "type": "boolean" }, "wiki": { "type": "boolean" } } } } } } }, "/posts/{id}": { "get": { "description": "Get a single post\n", "tags": [ "Posts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "post response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "cooked": { "type": "string", "minLength": 1 }, "post_number": { "type": "number" }, "post_type": { "type": "number" }, "updated_at": { "type": "string", "minLength": 1 }, "reply_count": { "type": "number" }, "reply_to_post_number": { "type": "object" }, "quote_count": { "type": "number" }, "avg_time": { "type": "object" }, "incoming_link_count": { "type": "number" }, "reads": { "type": "number" }, "score": { "type": "number" }, "yours": { "type": "boolean" }, "topic_id": { "type": "number" }, "topic_slug": { "type": "string", "minLength": 1 }, "display_username": { "type": "string" }, "primary_group_name": { "type": "object" }, "primary_group_flair_url": { "type": "object" }, "primary_group_flair_bg_color": { "type": "object" }, "primary_group_flair_color": { "type": "object" }, "version": { "type": "number" }, "can_edit": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_recover": { "type": "boolean" }, "can_wiki": { "type": "boolean" }, "user_title": { "type": "object" }, "raw": { "type": "string", "minLength": 1 }, "actions_summary": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "moderator": { "type": "boolean" }, "admin": { "type": "boolean" }, "staff": { "type": "boolean" }, "user_id": { "type": "number" }, "hidden": { "type": "boolean" }, "hidden_reason_id": { "type": "object" }, "trust_level": { "type": "number" }, "deleted_at": { "type": "object" }, "user_deleted": { "type": "boolean" }, "edit_reason": { "type": "object" }, "can_view_edit_history": { "type": "boolean" }, "wiki": { "type": "boolean" } } } } } }, "put": { "description": "Update a single post\n", "tags": [ "Posts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" }, { "name": "body", "in": "body", "schema": { "type": "object", "properties": { "post[raw]": { "type": "string" } } } } ], "responses": { "200": { "description": "update post response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "post": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "cooked": { "type": "string", "minLength": 1 }, "post_number": { "type": "number" }, "post_type": { "type": "number" }, "updated_at": { "type": "string", "minLength": 1 }, "reply_count": { "type": "number" }, "reply_to_post_number": { "type": "object" }, "quote_count": { "type": "number" }, "avg_time": { "type": "object" }, "incoming_link_count": { "type": "number" }, "reads": { "type": "number" }, "score": { "type": "number" }, "yours": { "type": "boolean" }, "topic_id": { "type": "number" }, "topic_slug": { "type": "string", "minLength": 1 }, "display_username": { "type": "string" }, "primary_group_name": { "type": "object" }, "primary_group_flair_url": { "type": "object" }, "primary_group_flair_bg_color": { "type": "object" }, "primary_group_flair_color": { "type": "object" }, "version": { "type": "number" }, "can_edit": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_recover": { "type": "boolean" }, "can_wiki": { "type": "boolean" }, "user_title": { "type": "object" }, "actions_summary": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "hidden", "can_act" ], "properties": { "id": { "type": "number" }, "hidden": { "type": "boolean" }, "can_act": { "type": "boolean" } } } }, "moderator": { "type": "boolean" }, "admin": { "type": "boolean" }, "staff": { "type": "boolean" }, "user_id": { "type": "number" }, "draft_sequence": { "type": "number" }, "hidden": { "type": "boolean" }, "hidden_reason_id": { "type": "object" }, "trust_level": { "type": "number" }, "deleted_at": { "type": "object" }, "user_deleted": { "type": "boolean" }, "edit_reason": { "type": "object" }, "can_view_edit_history": { "type": "boolean" }, "wiki": { "type": "boolean" } }, "required": [ "id", "name", "username", "avatar_template", "created_at", "cooked", "post_number", "post_type", "updated_at", "reply_count", "quote_count", "incoming_link_count", "reads", "score", "yours", "topic_id", "topic_slug", "display_username", "version", "can_edit", "can_delete", "can_recover", "can_wiki", "actions_summary", "moderator", "admin", "staff", "user_id", "draft_sequence", "hidden", "trust_level", "user_deleted", "can_view_edit_history", "wiki" ] } } } } } } }, "/post_actions": { "post": { "description": "Like a post and other actions\n", "tags": [ "Posts" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "id", "post_action_type_id" ], "properties": { "id": { "type": "integer" }, "post_action_type_id": { "type": "integer" }, "flag_topic": { "type": "boolean" } } } } ] } }, "/post_actions/{id}": { "delete": { "description": "Un-like a post\n", "tags": [ "Posts" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" }, { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "post_action_type_id" ], "properties": { "post_action_type_id": { "type": "integer" } } } } ] } }, "/t/{id}.json": { "get": { "description": "Get a single topic\n", "tags": [ "Topics" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "topic response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "post_stream": { "type": "object", "properties": { "posts": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "name", "username", "avatar_template", "created_at", "cooked", "post_number", "post_type", "updated_at", "reply_count", "quote_count", "incoming_link_count", "reads", "score", "yours", "topic_id", "topic_slug", "display_username", "version", "can_edit", "can_delete", "can_recover", "can_wiki", "read", "moderator", "admin", "staff", "user_id", "hidden", "trust_level", "user_deleted", "can_view_edit_history", "wiki" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "cooked": { "type": "string", "minLength": 1 }, "post_number": { "type": "number" }, "post_type": { "type": "number" }, "updated_at": { "type": "string", "minLength": 1 }, "reply_count": { "type": "number" }, "reply_to_post_number": { "type": "object" }, "quote_count": { "type": "number" }, "avg_time": { "type": "object" }, "incoming_link_count": { "type": "number" }, "reads": { "type": "number" }, "score": { "type": "number" }, "yours": { "type": "boolean" }, "topic_id": { "type": "number" }, "topic_slug": { "type": "string", "minLength": 1 }, "display_username": { "type": "string" }, "primary_group_name": { "type": "object" }, "primary_group_flair_url": { "type": "object" }, "primary_group_flair_bg_color": { "type": "object" }, "primary_group_flair_color": { "type": "object" }, "version": { "type": "number" }, "can_edit": { "type": "boolean" }, "can_delete": { "type": "boolean" }, "can_recover": { "type": "boolean" }, "can_wiki": { "type": "boolean" }, "read": { "type": "boolean" }, "user_title": { "type": "object" }, "actions_summary": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "moderator": { "type": "boolean" }, "admin": { "type": "boolean" }, "staff": { "type": "boolean" }, "user_id": { "type": "number" }, "hidden": { "type": "boolean" }, "hidden_reason_id": { "type": "object" }, "trust_level": { "type": "number" }, "deleted_at": { "type": "object" }, "user_deleted": { "type": "boolean" }, "edit_reason": { "type": "object" }, "can_view_edit_history": { "type": "boolean" }, "wiki": { "type": "boolean" } } } }, "stream": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } } }, "required": [ "posts", "stream" ] }, "timeline_lookup": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "properties": { "0": { "type": "array", "uniqueItems": true, "minItems": null, "items": { "type": "object" } } } } }, "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "fancy_title": { "type": "string", "minLength": 1 }, "posts_count": { "type": "number" }, "created_at": { "type": "string", "minLength": 1 }, "views": { "type": "number" }, "reply_count": { "type": "number" }, "participant_count": { "type": "number" }, "like_count": { "type": "number" }, "last_posted_at": { "type": "object" }, "visible": { "type": "boolean" }, "closed": { "type": "boolean" }, "archived": { "type": "boolean" }, "has_summary": { "type": "boolean" }, "archetype": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "category_id": { "type": "number" }, "word_count": { "type": "object" }, "deleted_at": { "type": "object" }, "user_id": { "type": "number" }, "draft": { "type": "object" }, "draft_key": { "type": "string", "minLength": 1 }, "draft_sequence": { "type": "object" }, "unpinned": { "type": "object" }, "pinned_globally": { "type": "boolean" }, "pinned": { "type": "boolean" }, "pinned_at": { "type": "string", "minLength": 1 }, "pinned_until": { "type": "object" }, "details": { "type": "object", "properties": { "auto_close_at": { "type": "object" }, "auto_close_hours": { "type": "object" }, "auto_close_based_on_last_post": { "type": "boolean" }, "created_by": { "type": "object", "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } }, "required": [ "id", "username", "avatar_template" ] }, "last_poster": { "type": "object", "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } }, "required": [ "id", "username", "avatar_template" ] }, "participants": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "username", "avatar_template", "post_count" ], "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "post_count": { "type": "number" } } } }, "suggested_topics": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "title", "fancy_title", "slug", "posts_count", "reply_count", "highest_post_number", "image_url", "created_at", "last_posted_at", "bumped", "bumped_at", "unseen", "pinned", "excerpt", "visible", "closed", "archived", "archetype", "like_count", "views", "category_id" ], "properties": { "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "fancy_title": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "posts_count": { "type": "number" }, "reply_count": { "type": "number" }, "highest_post_number": { "type": "number" }, "image_url": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "last_posted_at": { "type": "string", "minLength": 1 }, "bumped": { "type": "boolean" }, "bumped_at": { "type": "string", "minLength": 1 }, "unseen": { "type": "boolean" }, "pinned": { "type": "boolean" }, "unpinned": { "type": "object" }, "excerpt": { "type": "string", "minLength": 1 }, "visible": { "type": "boolean" }, "closed": { "type": "boolean" }, "archived": { "type": "boolean" }, "bookmarked": { "type": "object" }, "liked": { "type": "object" }, "archetype": { "type": "string", "minLength": 1 }, "like_count": { "type": "number" }, "views": { "type": "number" }, "category_id": { "type": "number" }, "posters": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "extras", "description" ], "properties": { "extras": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } }, "required": [ "id", "username", "avatar_template" ] } } } } } } }, "notification_level": { "type": "number" }, "can_flag_topic": { "type": "boolean" } }, "required": [ "auto_close_based_on_last_post", "created_by", "last_poster", "participants", "suggested_topics", "notification_level", "can_flag_topic" ] }, "highest_post_number": { "type": "number" }, "deleted_by": { "type": "object" }, "actions_summary": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "count", "hidden", "can_act" ], "properties": { "id": { "type": "number" }, "count": { "type": "number" }, "hidden": { "type": "boolean" }, "can_act": { "type": "boolean" } } } }, "chunk_size": { "type": "number" }, "bookmarked": { "type": "object" } } } } } }, "delete": { "description": "Remove a single topic\n", "tags": [ "Topics" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "delete topic response is empty, just a status code\n" } } } }, "/t/{slug}/{id}.json": { "put": { "description": "Update a single topic\n", "tags": [ "Topics" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "integer" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "title": { "type": "string" }, "category_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "update topic response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "basic_topic": { "type": "object", "properties": { "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "fancy_title": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "posts_count": { "type": "number" } }, "required": [ "id", "title", "fancy_title", "slug", "posts_count" ] } } } } } } }, "/t/{topic_id}/invite": { "post": { "description": "Invite user to topic\n", "tags": [ "Invites", "Topics" ], "parameters": [ { "name": "topic_id", "in": "path", "required": true, "type": "integer" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "required": [ "username" ], "properties": { "username": { "type": "string" } } } } ], "responses": { "200": { "description": "invite response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } }, "required": [ "id", "username", "avatar_template" ] } } } } } } }, "/topics/private-messages/{username}.json": { "get": { "description": "Get a list of private messages for a user\n", "tags": [ "Private Messages" ], "responses": { "200": { "description": "list of private messages response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "topic_list": { "type": "object", "properties": { "can_create_topic": { "type": "boolean" }, "draft": { "type": null }, "draft_key": { "type": "string", "minLength": 1 }, "draft_sequence": { "type": "number" }, "per_page": { "type": "number" }, "topics": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "required": { "type": null }, "properties": { "type": null } } } }, "required": [ "can_create_topic", "draft_key", "draft_sequence", "per_page", "topics" ] } } } } } } }, "/topics/private-messages-sent/{username}.json": { "get": { "description": "Get a list of private messages sent\n", "tags": [ "Private Messages" ], "responses": { "200": { "description": "private messages sent response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "users": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "username", "avatar_template" ], "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } } } }, "topic_list": { "type": "object", "properties": { "can_create_topic": { "type": "boolean" }, "draft": { "type": "object" }, "draft_key": { "type": "string", "minLength": 1 }, "draft_sequence": { "type": "number" }, "per_page": { "type": "number" }, "topics": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "title", "fancy_title", "slug", "posts_count", "reply_count", "highest_post_number", "created_at", "last_posted_at", "bumped", "bumped_at", "unseen", "last_read_post_number", "unread", "new_posts", "pinned", "visible", "closed", "archived", "notification_level", "bookmarked", "liked", "views", "like_count", "has_summary", "archetype", "last_poster_username", "pinned_globally" ], "properties": { "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "fancy_title": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "posts_count": { "type": "number" }, "reply_count": { "type": "number" }, "highest_post_number": { "type": "number" }, "image_url": { "type": "object" }, "created_at": { "type": "string", "minLength": 1 }, "last_posted_at": { "type": "string", "minLength": 1 }, "bumped": { "type": "boolean" }, "bumped_at": { "type": "string", "minLength": 1 }, "unseen": { "type": "boolean" }, "last_read_post_number": { "type": "number" }, "unread": { "type": "number" }, "new_posts": { "type": "number" }, "pinned": { "type": "boolean" }, "unpinned": { "type": "object" }, "visible": { "type": "boolean" }, "closed": { "type": "boolean" }, "archived": { "type": "boolean" }, "notification_level": { "type": "number" }, "bookmarked": { "type": "boolean" }, "liked": { "type": "boolean" }, "views": { "type": "number" }, "like_count": { "type": "number" }, "has_summary": { "type": "boolean" }, "archetype": { "type": "string", "minLength": 1 }, "last_poster_username": { "type": "string", "minLength": 1 }, "category_id": { "type": "object" }, "pinned_globally": { "type": "boolean" }, "posters": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "extras", "description", "user_id" ], "properties": { "extras": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "user_id": { "type": "number" } } } }, "participants": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "user_id" ], "properties": { "extras": { "type": "object" }, "description": { "type": "object" }, "user_id": { "type": "number" } } } } } } } }, "required": [ "can_create_topic", "draft_key", "draft_sequence", "per_page", "topics" ] } } } } } } }, "/notifications.json": { "get": { "description": "Get some notifications\n", "tags": [ "Notifications" ], "responses": { "200": { "description": "notifications response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "notifications": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "total_rows_notifications": { "type": "number" }, "seen_notification_id": { "type": "number" }, "load_more_notifications": { "type": "string", "minLength": 1 } } } } } } }, "/invites": { "post": { "description": "Invite a user by email to join your Discourse forum\n", "tags": [ "Invites" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" }, "group_names": { "type": "string" }, "custom_message": { "type": "string" } } } } ], "responses": { "200": { "description": "response", "schema": { "type": "object", "properties": { "success": { "type": "string" } } } } } } }, "/invites/disposable": { "post": { "description": "Create disposable invite token\n", "tags": [ "Invites" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "username" ], "properties": { "username": { "type": "string" }, "email": { "type": "string" }, "quantity": { "type": "integer" }, "group_names": { "type": "string" } } } } ], "responses": { "200": { "description": "disposable invites response", "schema": { "type": "array", "items": { "type": "string" } } }, "429": { "description": "rate limit response", "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } }, "error_type": { "type": "string" } } } } } } }, "/users/{username}.json": { "get": { "description": "Get a single user by username\n", "tags": [ "Users" ], "parameters": [ { "name": "username", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "get user response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "user_badges": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "name": { "type": "object" }, "last_posted_at": { "type": "string", "minLength": 1 }, "last_seen_at": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "website_name": { "type": "object" }, "can_edit": { "type": "boolean" }, "can_edit_username": { "type": "boolean" }, "can_edit_email": { "type": "boolean" }, "can_edit_name": { "type": "boolean" }, "can_send_private_messages": { "type": "boolean" }, "can_send_private_message_to_user": { "type": "boolean" }, "trust_level": { "type": "number" }, "moderator": { "type": "boolean" }, "admin": { "type": "boolean" }, "title": { "type": "object" }, "uploaded_avatar_id": { "type": "object" }, "badge_count": { "type": "number" }, "custom_fields": { "type": "object" }, "pending_count": { "type": "number" }, "profile_view_count": { "type": "number" }, "primary_group_name": { "type": "object" }, "primary_group_flair_url": { "type": "object" }, "primary_group_flair_bg_color": { "type": "object" }, "primary_group_flair_color": { "type": "object" }, "invited_by": { "type": "object" }, "groups": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "automatic", "name", "user_count", "alias_level", "visible", "automatic_membership_retroactive", "primary_group", "has_messages", "is_member", "mentionable" ], "properties": { "id": { "type": "number" }, "automatic": { "type": "boolean" }, "name": { "type": "string", "minLength": 1 }, "user_count": { "type": "number" }, "alias_level": { "type": "number" }, "visible": { "type": "boolean" }, "automatic_membership_email_domains": { "type": "object" }, "automatic_membership_retroactive": { "type": "boolean" }, "primary_group": { "type": "boolean" }, "title": { "type": "object" }, "grant_trust_level": { "type": "object" }, "notification_level": { "type": "object" }, "has_messages": { "type": "boolean" }, "is_member": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "flair_url": { "type": "object" }, "flair_bg_color": { "type": "object" }, "flair_color": { "type": "object" } } } }, "featured_user_badge_ids": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "card_badge": { "type": "object" } }, "required": [ "id", "username", "avatar_template", "last_posted_at", "last_seen_at", "created_at", "can_edit", "can_edit_username", "can_edit_email", "can_edit_name", "can_send_private_messages", "can_send_private_message_to_user", "trust_level", "moderator", "admin", "badge_count", "custom_fields", "pending_count", "profile_view_count", "groups", "featured_user_badge_ids" ] } } } } } } }, "/uploads.json": { "post": { "description": "Upload an image or avatar\n", "tags": [ "Upload" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string", "example": "upload", "description": "a lowercase string with numbers but no spaces. Set to 'avatar' if uploading an avatar\n" }, "user_id": { "type": "integer", "example": 1, "description": "required if uploading an avatar" }, "synchronous": { "type": "boolean", "example": true, "description": "use this flag to return an id and url" } } } }, { "name": "files[]", "required": true, "type": "file" } ], "responses": { "200": { "description": "if async will return '{ success: true}'\n", "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "original_filename": { "type": "string" }, "filesize": { "type": "integer" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "url": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "sha1": { "type": "string" }, "origin": { "type": null }, "retain_hours": { "type": null } } } } } } }, "/users/{username}/preferences/avatar/pick": { "put": { "description": "update avatar\n", "tags": [ "Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "upload_id", "type" ], "properties": { "upload_id": { "type": "integer", "example": 4 }, "type": { "type": "string", "example": "uploaded" } } } } ] } }, "/users": { "post": { "description": "Creates a new user\n", "tags": [ "Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "name", "email", "password", "username" ], "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } } } } ], "responses": { "200": { "description": "new user response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "success": { "type": "boolean" }, "active": { "type": "boolean" }, "message": { "type": "string", "minLength": 1 }, "user_id": { "type": "number" } } } } } } }, "/tags": { "get": { "description": "get a list of tags (requires the tag plugin)\n", "tags": [ "Tags" ], "responses": { "200": { "description": "tag list response\n" } } } }, "/tags/{tag}": { "get": { "description": "Get a specific tag (requires the tag plugin)\n", "tags": [ "Tags" ], "parameters": [ { "name": "tag", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "tag response\n" } } } }, "/search/query": { "get": { "description": "Search for something\n", "tags": [ "Search" ], "parameters": [ { "name": "term", "in": "path", "required": true, "type": "string" }, { "name": "include_blurbs", "in": "path", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "search response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "posts": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "username", "avatar_template", "created_at", "cooked", "like_count", "blurb", "post_number", "topic_id" ], "properties": { "id": { "type": "number" }, "name": { "type": "object" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "cooked": { "type": "string", "minLength": 1 }, "like_count": { "type": "number" }, "blurb": { "type": "string", "minLength": 1 }, "post_number": { "type": "number" }, "topic_id": { "type": "number" } } } }, "topics": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "title", "fancy_title", "slug", "posts_count", "reply_count", "highest_post_number", "created_at", "last_posted_at", "bumped", "bumped_at", "unseen", "pinned", "visible", "closed", "archived", "views", "like_count", "has_summary", "archetype", "category_id", "pinned_globally" ], "properties": { "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "fancy_title": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "posts_count": { "type": "number" }, "reply_count": { "type": "number" }, "highest_post_number": { "type": "number" }, "image_url": { "type": "object" }, "created_at": { "type": "string", "minLength": 1 }, "last_posted_at": { "type": "string", "minLength": 1 }, "bumped": { "type": "boolean" }, "bumped_at": { "type": "string", "minLength": 1 }, "unseen": { "type": "boolean" }, "pinned": { "type": "boolean" }, "unpinned": { "type": "object" }, "visible": { "type": "boolean" }, "closed": { "type": "boolean" }, "archived": { "type": "boolean" }, "bookmarked": { "type": "object" }, "liked": { "type": "object" }, "views": { "type": "number" }, "like_count": { "type": "number" }, "has_summary": { "type": "boolean" }, "archetype": { "type": "string", "minLength": 1 }, "last_poster_username": { "type": "object" }, "category_id": { "type": "number" }, "pinned_globally": { "type": "boolean" }, "posters": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } } } } }, "users": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "categories": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "grouped_search_result": { "type": "object", "properties": { "more_posts": { "type": "object" }, "more_users": { "type": "object" }, "more_categories": { "type": "object" }, "post_ids": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "user_ids": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "category_ids": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } } }, "required": [ "post_ids", "user_ids", "category_ids" ] } } } } } } }, "/admin/users/{id}/suspend": { "put": { "description": "Suspend a user\n", "tags": [ "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "empty response body" } } } }, "/admin/users/{id}/unsuspend": { "put": { "description": "Unsuspend a user\n", "tags": [ "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "empty response body" } } } }, "/admin/users/{id}/activate": { "put": { "description": "Activate a user\n", "tags": [ "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "activate user response", "schema": { "type": "object", "properties": { "success": { "type": "string" } } } } } } }, "/admin/users/{id}/generate_api_key": { "post": { "description": "Generate/Regenerate api_key for a user\n", "tags": [ "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "generate api key response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "api_key": { "type": "object", "properties": { "id": { "type": "number" }, "key": { "type": "string", "minLength": 1 }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } }, "required": [ "id", "username", "avatar_template" ] } }, "required": [ "id", "key", "user" ] } } } } } } }, "/admin/users/list/{flag}.json": { "get": { "description": "returns a list of users\n", "tags": [ "Admin", "Users" ], "parameters": [ { "name": "flag", "in": "path", "required": true, "type": "string", "enum": [ "active", "new", "staff", "suspended", "blocked", "suspect" ] } ], "responses": { "200": { "description": "list of users response", "schema": { "type": "array", "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "required": [ "id", "username", "avatar_template", "email", "active", "admin", "moderator", "last_seen_at", "last_emailed_at", "created_at", "last_seen_age", "last_emailed_age", "created_at_age", "username_lower", "trust_level", "trust_level_locked", "flag_level", "blocked", "time_read", "staged", "days_visited", "posts_read_count", "topics_entered", "post_count" ], "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 }, "email": { "type": "string", "minLength": 1 }, "active": { "type": "boolean" }, "admin": { "type": "boolean" }, "moderator": { "type": "boolean" }, "last_seen_at": { "type": "string", "minLength": 1 }, "last_emailed_at": { "type": "string", "minLength": 1 }, "created_at": { "type": "string", "minLength": 1 }, "last_seen_age": { "type": "string", "minLength": 1 }, "last_emailed_age": { "type": "string", "minLength": 1 }, "created_at_age": { "type": "string", "minLength": 1 }, "username_lower": { "type": "string", "minLength": 1 }, "trust_level": { "type": "number" }, "trust_level_locked": { "type": "boolean" }, "flag_level": { "type": "number" }, "title": null, "suspended_at": { "type": "object" }, "suspended_till": { "type": "object" }, "suspended": { "type": "object" }, "blocked": { "type": "boolean" }, "time_read": { "type": "string", "minLength": 1 }, "staged": { "type": "boolean" }, "days_visited": { "type": "number" }, "posts_read_count": { "type": "number" }, "topics_entered": { "type": "number" }, "post_count": { "type": "number" } } } } } } } }, "/admin/groups.json": { "get": { "description": "Get some groups\n", "tags": [ "Admin", "Groups" ], "responses": { "200": { "description": "groups response", "schema": { "type": "array", "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "minItems": 1, "uniqueItems": true, "items": { "type": "object", "required": [ "id", "automatic", "name", "user_count", "alias_level", "visible", "automatic_membership_retroactive", "primary_group", "notification_level", "has_messages", "is_member", "mentionable" ], "properties": { "id": { "type": "number" }, "automatic": { "type": "boolean" }, "name": { "type": "string", "minLength": 1 }, "user_count": { "type": "number" }, "alias_level": { "type": "number" }, "visible": { "type": "boolean" }, "automatic_membership_email_domains": { "type": "object" }, "automatic_membership_retroactive": { "type": "boolean" }, "primary_group": { "type": "boolean" }, "title": { "type": "object" }, "grant_trust_level": { "type": "object" }, "incoming_email": { "type": "object" }, "notification_level": { "type": "number" }, "has_messages": { "type": "boolean" }, "is_member": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "flair_url": { "type": "object" }, "flair_bg_color": { "type": "object" }, "flair_color": { "type": "object" } } } } } } } }, "/admin/groups": { "post": { "description": "Create a group\n", "tags": [ "Admin", "Groups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "create group response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "basic_group": { "type": "object", "properties": { "id": { "type": "number" }, "automatic": { "type": "boolean" }, "name": { "type": "string", "minLength": 1 }, "user_count": { "type": "number" }, "alias_level": { "type": "number" }, "visible": { "type": "boolean" }, "automatic_membership_email_domains": { "type": "object" }, "automatic_membership_retroactive": { "type": "boolean" }, "primary_group": { "type": "boolean" }, "title": { "type": "object" }, "grant_trust_level": { "type": "object" }, "incoming_email": { "type": "object" }, "notification_level": { "type": "object" }, "has_messages": { "type": "boolean" }, "is_member": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "flair_url": { "type": "object" }, "flair_bg_color": { "type": "object" }, "flair_color": { "type": "object" } }, "required": [ "id", "automatic", "name", "user_count", "alias_level", "visible", "automatic_membership_retroactive", "primary_group", "has_messages", "is_member", "mentionable" ] } } } } } } }, "/admin/groups/{group_id}.json": { "delete": { "description": "Delete a group\n", "tags": [ "Admin", "Groups" ], "responses": { "200": { "description": "delete group response", "schema": { "type": "object", "properties": { "success": { "type": "string" } } } } } } }, "/groups/{group_name}/members.json": { "get": { "description": "Get some group members\n", "tags": [ "Admin", "Groups" ], "responses": { "200": { "description": "group members response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "members": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "username", "avatar_template", "last_seen_at" ], "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } } } }, "owners": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } }, "meta": { "type": "object", "properties": { "total": { "type": "number" }, "limit": { "type": "number" }, "offset": { "type": "number" } }, "required": [ "total", "limit", "offset" ] } } } } } } }, "/groups/{group_id}/members.json": { "put": { "description": "Add users to a group (comma separated)\n", "tags": [ "Admin", "Groups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "usernames" ], "properties": { "usernames": { "type": "string" } } } } ], "responses": { "200": { "description": "add user to group response\n", "schema": { "type": "object", "properties": { "success": { "type": "string" } } } } } }, "delete": { "description": "Delete a user from a group\n", "tags": [ "Admin", "Groups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "user_id" ], "properties": { "user_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "delete user from group response", "schema": { "type": "object", "properties": { "success": { "type": "string" } } } } } } }, "/latest.json": { "get": { "description": "Get the latest topics\n", "tags": [ "Topics" ], "parameters": [ { "name": "order", "in": "path", "required": false, "type": "string", "enum": [ "default", "created", "activity", "views", "posts", "category" ] } ], "responses": { "200": { "description": "latest topics response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "users": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "username", "avatar_template" ], "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } } } }, "topic_list": { "type": "object", "properties": { "can_create_topic": { "type": "boolean" }, "draft": { "type": "object" }, "draft_key": { "type": "string", "minLength": 1 }, "draft_sequence": { "type": "object" }, "per_page": { "type": "number" }, "topics": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "title", "fancy_title", "slug", "posts_count", "reply_count", "highest_post_number", "created_at", "last_posted_at", "bumped", "bumped_at", "unseen", "pinned", "excerpt", "visible", "closed", "archived", "views", "like_count", "has_summary", "archetype", "last_poster_username", "category_id", "pinned_globally" ], "properties": { "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "fancy_title": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "posts_count": { "type": "number" }, "reply_count": { "type": "number" }, "highest_post_number": { "type": "number" }, "image_url": { "type": "object" }, "created_at": { "type": "string", "minLength": 1 }, "last_posted_at": { "type": "string", "minLength": 1 }, "bumped": { "type": "boolean" }, "bumped_at": { "type": "string", "minLength": 1 }, "unseen": { "type": "boolean" }, "pinned": { "type": "boolean" }, "unpinned": { "type": "object" }, "excerpt": { "type": "string", "minLength": 1 }, "visible": { "type": "boolean" }, "closed": { "type": "boolean" }, "archived": { "type": "boolean" }, "bookmarked": { "type": "object" }, "liked": { "type": "object" }, "views": { "type": "number" }, "like_count": { "type": "number" }, "has_summary": { "type": "boolean" }, "archetype": { "type": "string", "minLength": 1 }, "last_poster_username": { "type": "string", "minLength": 1 }, "category_id": { "type": "number" }, "pinned_globally": { "type": "boolean" }, "posters": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "extras", "description", "user_id" ], "properties": { "extras": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "user_id": { "type": "number" } } } } } } } }, "required": [ "can_create_topic", "draft_key", "per_page", "topics" ] } } } } } } }, "/top.json": { "get": { "description": "Get the top topics\n", "tags": [ "Topics" ], "responses": { "200": { "description": "top topics response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "users": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "username", "avatar_template" ], "properties": { "id": { "type": "number" }, "username": { "type": "string", "minLength": 1 }, "avatar_template": { "type": "string", "minLength": 1 } } } }, "topic_list": { "type": "object", "properties": { "can_create_topic": { "type": "boolean" }, "draft": { "type": "object" }, "draft_key": { "type": "string", "minLength": 1 }, "draft_sequence": { "type": "number" }, "for_period": { "type": "string", "minLength": 1 }, "per_page": { "type": "number" }, "topics": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "id", "title", "fancy_title", "slug", "posts_count", "reply_count", "highest_post_number", "created_at", "last_posted_at", "bumped", "bumped_at", "unseen", "last_read_post_number", "unread", "new_posts", "pinned", "visible", "closed", "archived", "notification_level", "bookmarked", "liked", "views", "like_count", "has_summary", "archetype", "last_poster_username", "category_id", "pinned_globally" ], "properties": { "id": { "type": "number" }, "title": { "type": "string", "minLength": 1 }, "fancy_title": { "type": "string", "minLength": 1 }, "slug": { "type": "string", "minLength": 1 }, "posts_count": { "type": "number" }, "reply_count": { "type": "number" }, "highest_post_number": { "type": "number" }, "image_url": { "type": "object" }, "created_at": { "type": "string", "minLength": 1 }, "last_posted_at": { "type": "string", "minLength": 1 }, "bumped": { "type": "boolean" }, "bumped_at": { "type": "string", "minLength": 1 }, "unseen": { "type": "boolean" }, "last_read_post_number": { "type": "number" }, "unread": { "type": "number" }, "new_posts": { "type": "number" }, "pinned": { "type": "boolean" }, "unpinned": { "type": "object" }, "visible": { "type": "boolean" }, "closed": { "type": "boolean" }, "archived": { "type": "boolean" }, "notification_level": { "type": "number" }, "bookmarked": { "type": "boolean" }, "liked": { "type": "boolean" }, "views": { "type": "number" }, "like_count": { "type": "number" }, "has_summary": { "type": "boolean" }, "archetype": { "type": "string", "minLength": 1 }, "last_poster_username": { "type": "string", "minLength": 1 }, "category_id": { "type": "number" }, "pinned_globally": { "type": "boolean" }, "posters": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "extras", "description", "user_id" ], "properties": { "extras": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "user_id": { "type": "number" } } } } } } } }, "required": [ "can_create_topic", "draft_key", "draft_sequence", "for_period", "per_page", "topics" ] } } } } } } }, "/top/{flag}.json": { "get": { "description": "Get the top topics filtered by specified flag\n", "tags": [ "Topics" ], "parameters": [ { "name": "flag", "in": "path", "required": false, "type": "string", "enum": [ "all", "yearly", "quarterly", "monthly", "weekly", "daily" ] } ] } }, "/session/forgot_password": { "post": { "description": "Send password reset email\n", "tags": [ "Password Reset" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "login" ], "properties": { "login": { "type": "string" } } } } ], "responses": { "200": { "description": "send password reset email response\n", "schema": { "type": "object", "properties": { "result": { "type": "string" }, "user_found": { "type": "boolean" } } } } } } }, "/users/password-reset/{token}": { "put": { "description": "create a new password\n", "tags": [ "Password Reset" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "username", "password" ], "properties": { "username": { "type": "string" }, "password": { "type": "string" } } } } ], "responses": { "200": { "description": "password has been reset response\n" } } } }, "/admin/site_settings.json": { "get": { "description": "show site settings\n", "tags": [ "Admin" ], "responses": { "200": { "description": "show site settings response", "schema": { "$schema": "http://json-schema.org/draft-04/schema#", "description": "", "type": "object", "properties": { "site_settings": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "setting", "description", "default", "type", "value", "category", "preview", "translate_names" ], "properties": { "setting": { "type": "string", "minLength": 1 }, "description": { "type": "string", "minLength": 1 }, "default": { "type": "string", "minLength": 1 }, "type": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 }, "category": { "type": "string", "minLength": 1 }, "preview": { "type": "string", "minLength": 1 }, "valid_values": { "type": "array", "uniqueItems": true, "minItems": 1, "items": { "required": [ "name", "value" ], "properties": { "name": { "type": "string", "minLength": 1 }, "value": { "type": "string", "minLength": 1 } } } }, "translate_names": { "type": "boolean" }, "choices": { "type": "array", "uniqueItems": null, "minItems": null, "items": { "type": "object" } } } } }, "diags": { "type": "object", "properties": { "last_message_processed": { "type": "object" } } } } } } } } }, "/admin/site_settings/title": { "put": { "description": "Update the site title\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "title" ], "properties": { "title": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/site_description": { "put": { "description": "Update the site description\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "site_description" ], "properties": { "site_description": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/contact_email": { "put": { "description": "Update the contact email\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "contact_email" ], "properties": { "contact_email": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" }, "422": { "description": "Invalid email address\n", "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "string" } } } } } } } }, "/admin/site_settings/contact_url": { "put": { "description": "Update the contact url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "contact_url" ], "properties": { "contact_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/notification_email": { "put": { "description": "Update the notification email\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "notification_email" ], "properties": { "notification_email": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/site_contact_username": { "put": { "description": "Update the site contact username\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "site_contact_username" ], "properties": { "site_contact_username": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/logo_url": { "put": { "description": "Update logo url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "logo_url" ], "properties": { "logo_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/logo_small_url": { "put": { "description": "Update the small logo url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "logo_small_url" ], "properties": { "logo_small_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/digest_logo_url": { "put": { "description": "Update the digest logo url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "digest_logo_url" ], "properties": { "digest_logo_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/mobile_logo_url": { "put": { "description": "Update the mobile logo url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "mobile_logo_url" ], "properties": { "mobile_logo_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/favicon_url": { "put": { "description": "Update the favicon url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "favicon_url" ], "properties": { "favicon_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/apple_touch_icon_url": { "put": { "description": "Update the apple touch icon url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "apple_touch_icon_url" ], "properties": { "apple_touch_icon_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_opengraph_image_url": { "put": { "description": "Update the default opengraph image url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_opengraph_image_url" ], "properties": { "default_opengraph_image_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/twitter_summary_large_image_url": { "put": { "description": "Update the twitter summary large image url\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "twitter_summary_large_image_url" ], "properties": { "twitter_summary_large_image_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/exclude_rel_nofollow_domains": { "put": { "description": "Update the exclude rel nofollow domains\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "exclude_rel_nofollow_domains" ], "properties": { "exclude_rel_nofollow_domains": { "description": "pipe delimited\n", "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/company_short_name": { "put": { "description": "Update the company short name\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "company_short_name" ], "properties": { "company_short_name": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/company_full_name": { "put": { "description": "Update the company full name\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "company_full_name" ], "properties": { "company_full_name": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/company_domain": { "put": { "description": "Update the company domain\n", "tags": [ "Site Settings Required" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "company_domain" ], "properties": { "company_domain": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_locale": { "put": { "description": "Update the default locale\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_locale" ], "properties": { "default_locale": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_user_locale": { "put": { "description": "Update allow user locale\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_user_locale" ], "properties": { "allow_user_locale": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/set_locale_from_accept_language_header": { "put": { "description": "Update set locale from accept language header\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "set_locale_from_accept_language_header" ], "properties": { "set_locale_from_accept_language_header": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/categories_topics": { "put": { "description": "Update the number of topics to show\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "categories_topics" ], "properties": { "categories_topics": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/suggested_topics": { "put": { "description": "Update the number of suggested topics\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "suggested_topics" ], "properties": { "suggested_topics": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/limit_suggested_to_category": { "put": { "description": "Update show topics from the current category\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "limit_suggested_to_category" ], "properties": { "limit_suggested_to_category": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/suggested_topics_max_days_old": { "put": { "description": "Update suggested topics max days old\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "suggested_topics_max_days_old" ], "properties": { "suggested_topics_max_days_old": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/track_external_right_clicks": { "put": { "description": "Update track external right clicks\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "track_external_right_clicks" ], "properties": { "track_external_right_clicks": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/ga_universal_tracking_code": { "put": { "description": "Update Google Universal Analytics tracking code\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "ga_universal_tracking_code" ], "properties": { "ga_universal_tracking_code": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/ga_universal_domain_name": { "put": { "description": "Update Google Universal Analytics domain name\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "ga_universal_domain_name" ], "properties": { "ga_universal_domain_name": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/ga_tracking_code": { "put": { "description": "Update the OBSOLETE ga tracking code\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "ga_tracking_code" ], "properties": { "ga_tracking_code": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/ga_domain_name": { "put": { "description": "Update the OBSOLETE ga domain name\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "ga_domain_name" ], "properties": { "ga_domain_name": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/gtm_container_id": { "put": { "description": "Update Google Tag Manager container id\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "gtm_container_id" ], "properties": { "gtm_container_id": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/top_menu": { "put": { "description": "Update the homepage navigation\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "top_menu" ], "properties": { "top_menu": { "description": "pipe delimited", "example": "latest|new|unread|top|categories|read", "type": "string", "enum": [ "latest", "new", "unread", "top", "categories", "read", "posted", "bookmarks" ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/post_menu": { "put": { "description": "Update the post menu items\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "post_menu" ], "properties": { "post_menu": { "description": "pipe delimited", "example": "like|edit|flag|delete|share|bookmark|reply", "type": "string", "enum": [ "like-count", "like", "share", "flag", "edit", "bookmark", "delete", "admin", "reply" ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/post_menu_hidden_items": { "put": { "description": "Update the post menu hidden items\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "post_menu_hidden_items" ], "properties": { "post_menu_hidden_items": { "description": "pipe delimited", "example": "like|edit|flag|delete|share|bookmark|reply", "type": "string", "enum": [ "like", "share", "flag", "edit", "bookmark", "delete", "admin", "reply" ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/desktop_category_page_style": { "put": { "description": "Update the visual style for the /categories page\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "desktop_category_page_style" ], "properties": { "desktop_category_page_style": { "type": "string", "enum": [ "categories_only", "categories_with_featured_topics", "categories_and_latest_topics" ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/category_colors": { "put": { "description": "Update a list of hexadecimal color values\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "category_colors" ], "properties": { "category_colors": { "description": "pipe delimited", "example": "BF1E2E|F1592A|F7941D", "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/category_style": { "put": { "description": "Update the category style\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "category_style" ], "properties": { "category_style": { "type": "string", "enum": [ "bar", "box", "bullet" ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_mobile_theme": { "put": { "description": "Update enable mobile theme\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_mobile_theme" ], "properties": { "enable_mobile_theme": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/relative_date_duration": { "put": { "description": "Update relative date duration\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "relative_date_duration" ], "properties": { "relative_date_duration": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/fixed_category_positions": { "put": { "description": "Update fixed category positions\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "fixed_category_positions" ], "properties": { "fixed_category_positions": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/fixed_category_positions_on_create": { "put": { "description": "Update fixed category positions on create\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "fixed_category_positions_on_create" ], "properties": { "fixed_category_positions_on_create": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_subcategory_list": { "put": { "description": "Update show subcategory list\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_subcategory_list" ], "properties": { "show_subcategory_list": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_badges": { "put": { "description": "Update enable the badge system\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_badges" ], "properties": { "enable_badges": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_whispers": { "put": { "description": "Update enable whispers\n", "tags": [ "Site Settings Basic Setup" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_whispers" ], "properties": { "enable_whispers": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/invite_only": { "put": { "description": "Update invite only\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "invite_only" ], "properties": { "invite_only": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/login_required": { "put": { "description": "Update login required\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "login_required" ], "properties": { "login_required": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/must_approve_users": { "put": { "description": "Update must approve users\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "must_approve_users" ], "properties": { "must_approve_users": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_local_logins": { "put": { "description": "Update enable_local_logins\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_local_logins" ], "properties": { "enable_local_logins": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_new_registrations": { "put": { "description": "Update allow new registrations\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_new_registrations" ], "properties": { "allow_new_registrations": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_signup_cta": { "put": { "description": "Update enable signup cta\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_signup_cta" ], "properties": { "enable_signup_cta": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_google_oauth2_logins": { "put": { "description": "Update enable Google Oauth2 authentication\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_google_oath2_logins" ], "properties": { "enable_google_oath2_logins": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/google_oath2_client_id": { "put": { "description": "Update google oauth2 client id\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "google_oath2_client_id" ], "properties": { "google_oath2_client_id": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/google_oath2_client_secret": { "put": { "description": "Update google oauth2 client secret\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "google_oath2_client_secret" ], "properties": { "google_oath2_client_secret": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_yahoo_logins": { "put": { "description": "Update enable yahoo logins\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_yahoo_logins" ], "properties": { "enable_yahoo_logins": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_twitter_logins": { "put": { "description": "Enable twitter logins\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_twitter_logins" ], "properties": { "enable_twitter_logins": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/twitter_consumer_key": { "put": { "description": "twitter consumer key\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "twitter_consumer_key" ], "properties": { "twitter_consumer_key": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/twitter_consumer_secret": { "put": { "description": "twitter consumer secret\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "twitter_consumer_secret" ], "properties": { "twitter_consumer_secret": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_instagram_logins": { "put": { "description": "enable instagram logins\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_instagram_logins" ], "properties": { "enable_instagram_logins": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/instagram_consumer_key": { "put": { "description": "instagram consumer key\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "instagram_consumer_key" ], "properties": { "instagram_consumer_key": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/instagram_consumer_secret": { "put": { "description": "instagram consumer secret\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "instagram_consumer_secret" ], "properties": { "instagram_consumer_secret": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_facebook_logins": { "put": { "description": "enable facebook logins\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_facebook_logins" ], "properties": { "enable_facebook_logins": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/facebook_app_id": { "put": { "description": "facebook app id\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "facebook_app_id" ], "properties": { "facebook_app_id": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/facebook_app_secret": { "put": { "description": "facebook app secret\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "facebook_app_secret" ], "properties": { "facebook_app_secret": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/facebook_request_extra_profile_details": { "put": { "description": "facebook request extra profile details\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "facebook_request_extra_profile_details" ], "properties": { "facebook_request_extra_profile_details": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_github_logins": { "put": { "description": "enable github logins\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_github_logins" ], "properties": { "enable_github_logins": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/github_client_id": { "put": { "description": "github client id\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "github_client_id" ], "properties": { "github_client_id": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/github_client_secret": { "put": { "description": "github client secret\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "github_client_secret" ], "properties": { "github_client_secret": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_sso": { "put": { "description": "enable sso\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_sso" ], "properties": { "enable_sso": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_allows_all_return_paths": { "put": { "description": "sso allows all return paths\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_allows_all_return_paths" ], "properties": { "ss_allows_all_return_paths": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_sso_provider": { "put": { "description": "enable sso provider\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_sso_provider" ], "properties": { "enable_sso_provider": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/verbose_sso_logging": { "put": { "description": "verbose sso logging\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "verbose_sso_logging" ], "properties": { "verbose_sso_logging": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_url": { "put": { "description": "sso url\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_url" ], "properties": { "sso_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_secret": { "put": { "description": "sso secret\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_secret" ], "properties": { "sso_secret": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_overrides_bio": { "put": { "description": "sso overrides bio\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_overrides_bio" ], "properties": { "sso_overrides_bio": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_overrides_email": { "put": { "description": "sso overrides email\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_overrides_email" ], "properties": { "sso_overrides_email": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_overrides_username": { "put": { "description": "sso overrides username\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_overrides_username" ], "properties": { "sso_overrides_username": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_overrides_name": { "put": { "description": "sso overrides name\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_overrides_name" ], "properties": { "sso_overrides_name": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_overrides_avatar": { "put": { "description": "sso overrides avatar\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_overrides_avatar" ], "properties": { "sso_overrides_avatar": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sso_not_approved_url": { "put": { "description": "sso not approved url\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sso_not_approved_url" ], "properties": { "sso_not_approved_url": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_domains_blacklist": { "put": { "description": "email domains blacklist\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_domains_blacklist" ], "properties": { "email_domains_blacklist": { "description": "pipe delimited\n", "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_domains_whitelist": { "put": { "description": "email domains whitelist\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_domains_whitelist" ], "properties": { "email_domains_whitelist": { "description": "pipe delimited\n", "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/forgot_password_strict": { "put": { "description": "forgot password strict\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "forgot_password_strict" ], "properties": { "forgot_password_strict": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/log_out_strict": { "put": { "description": "log out strict\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "log_out_strict" ], "properties": { "log_out_strict": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pending_users_reminder_delay": { "put": { "description": "pending users reminder delay\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pending_users_reminder_delay" ], "properties": { "pending_users_reminder_delay": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/maximum_session_age": { "put": { "description": "maximum session age\n", "tags": [ "Site Settings Login" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "maximum_session_age" ], "properties": { "maximum_session_age": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_username_length": { "put": { "description": "min username length\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_username_length" ], "properties": { "min_username_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_username_length": { "put": { "description": "max username length\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_username_length" ], "properties": { "max_username_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/reserved_usernames": { "put": { "description": "reserved usernames\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "reserved_usernames" ], "properties": { "reserved_usernames": { "description": "pipe delimited\n", "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_password_length": { "put": { "description": "min password length\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_password_length" ], "properties": { "min_password_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_admin_password_length": { "put": { "description": "min admin password length\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_admin_password_length" ], "properties": { "min_admin_password_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/block_common_passwords": { "put": { "description": "block common passwords\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "block_common_passwords" ], "properties": { "block_common_passwords": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/username_change_period": { "put": { "description": "username change period\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "username_change_period" ], "properties": { "username_change_period": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_editable": { "put": { "description": "email editable\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_editable" ], "properties": { "email_editable": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/logout_redirect": { "put": { "description": "logout redirect\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "logout_redirect" ], "properties": { "logout_redirect": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/full_name_required": { "put": { "description": "full name required\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "full_name_required" ], "properties": { "full_name_required": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_names": { "put": { "description": "enable names\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_names" ], "properties": { "enable_names": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/invite_expiry_days": { "put": { "description": "invite expiry days\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "invite_expiry_days" ], "properties": { "invite_expiry_days": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/invite_passthrough_hours": { "put": { "description": "invite passthrough hours\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "invite_passthrough_hours" ], "properties": { "invite_passthrough_hours": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/invites_per_page": { "put": { "description": "invites per page\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "invites_per_page" ], "properties": { "invites_per_page": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/delete_user_max_post_age": { "put": { "description": "delete user max post age\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "delete_user_max_post_age" ], "properties": { "delete_user_max_post_age": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/delete_all_posts_max": { "put": { "description": "delete all posts max\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "delete_all_posts_max" ], "properties": { "delete_all_posts_max": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/redirect_users_to_top_page": { "put": { "description": "redirect users to top page\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "redirect_users_to_top_page" ], "properties": { "redirect_users_to_top_page": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_email_on_profile": { "put": { "description": "show email on profile\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_email_on_profile" ], "properties": { "show_email_on_profile": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/prioritize_username_in_ux": { "put": { "description": "prioritize username in ux\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "prioritize_username_in_ux" ], "properties": { "prioritize_username_in_ux": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_token_valid_hours": { "put": { "description": "email token valid hours\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_token_valid_hours" ], "properties": { "email_token_valid_hours": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/purge_unactivated_users_grace_period_days": { "put": { "description": "purge unactivated users grace period days\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "purge_unactivated_users_grace_period_days" ], "properties": { "purge_unactivated_users_grace_period_days": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/public_user_custom_fields": { "put": { "description": "public user custom fields\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "public_user_custom_fields" ], "properties": { "public_user_custom_fields": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/staff_users_custom_fields": { "put": { "description": "staff user custom fields\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "staff_users_custom_fields" ], "properties": { "staff_users_custom_fields": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_user_directory": { "put": { "description": "enable user directory\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_user_directory" ], "properties": { "enable_user_directory": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_anonymous_posting": { "put": { "description": "allow anonymous posting\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_anonymous_posting" ], "properties": { "allow_anonymous_posting": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/anonymous_posting_min_trust_level": { "put": { "description": "anonymous posting min trust level\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "anonymous_posting_min_trust_level" ], "properties": { "anonymous_posting_min_trust_level": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/anonymous_account_duration_minutes": { "put": { "description": "anonymous account duration minutes\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "anonymous_account_duration_minutes" ], "properties": { "anonymous_account_duration_minutes": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/hide_user_profiles_from_public": { "put": { "description": "hide user profiles from public\n", "tags": [ "Site Settings Users" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "hide_user_profiles_from_public" ], "properties": { "hide_user_profiles_from_public": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_post_length": { "put": { "description": "min post length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_post_length" ], "properties": { "min_post_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_first_post_length": { "put": { "description": "min first post length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_first_post_length" ], "properties": { "min_first_post_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_private_message_post_length": { "put": { "description": "min private message post length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_private_message_post_length" ], "properties": { "min_private_message_post_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_post_length": { "put": { "description": "max post length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_post_length" ], "properties": { "max_post_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_featured_link_enabled": { "put": { "description": "topic featured link enabled\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_featured_link_enabled" ], "properties": { "topic_featured_link_enabled": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/body_min_entropy": { "put": { "description": "body min entropy\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "body_min_entropy" ], "properties": { "body_min_entropy": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_topic_title_length": { "put": { "description": "min topic title length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_topic_title_length" ], "properties": { "min_topic_title_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_topic_title_length": { "put": { "description": "max topic title length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_topic_title_length" ], "properties": { "max_topic_title_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/title_min_entropy": { "put": { "description": "title min entropy\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "title_min_entropy" ], "properties": { "title_min_entropy": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_uppercase_posts": { "put": { "description": "allow_uppercase_posts\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_uppercase_posts" ], "properties": { "allow_uppercase_posts": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/title_prettify": { "put": { "description": "title_prettify\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "title_prettify" ], "properties": { "title_prettify": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/title_fancy_entities": { "put": { "description": "title fancy entities\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "title_fancy_entities" ], "properties": { "title_fancy_entities": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_private_message_title_length": { "put": { "description": "min private message title length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_private_message_title_length" ], "properties": { "min_private_message_title_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_uncategorized_topics": { "put": { "description": "allow uncategorized topics\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_uncategorized_topics" ], "properties": { "allow_uncategorized_topics": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_duplicate_topic_titles": { "put": { "description": "allow duplicate topic titles\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_duplicate_topic_titles" ], "properties": { "allow_duplicate_topic_titles": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_title_similar_length": { "put": { "description": "min_title_similar_length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_title_similar_length" ], "properties": { "min_title_similar_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_body_title_length": { "put": { "description": "min body title length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_body_title_length" ], "properties": { "min_body_title_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_private_messages": { "put": { "description": "enable private messages\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_private_messages" ], "properties": { "enable_private_messages": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/editing_grace_period": { "put": { "description": "editing grace period\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "editing_grace_period" ], "properties": { "editing_grace_period": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/post_edit_time_limit": { "put": { "description": "post edit time limit\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "post_edit_time_limit" ], "properties": { "post_edit_time_limit": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/edit_history_visible_to_public": { "put": { "description": "edit history visible to public\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "edit_history_visible_to_public" ], "properties": { "edit_history_visible_to_public": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/delete_removed_posts_after": { "put": { "description": "delete removed posts after\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "delete_removed_posts_after" ], "properties": { "delete_removed_posts_after": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/traditional_markdown_linebreaks": { "put": { "description": "traditional markdown linebreaks\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "traditional_markdown_linebreaks" ], "properties": { "traditional_markdown_linebreaks": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_html_tables": { "put": { "description": "allow html tables\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_html_tables" ], "properties": { "allow_html_tables": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/suppress_reply_directly_below": { "put": { "description": "suppress reply directly below\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "suppress_reply_directly_below" ], "properties": { "suppress_reply_directly_below": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/suppress_reply_directly_above": { "put": { "description": "suppress reply directly above\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "suppress_reply_directly_above" ], "properties": { "suppress_reply_directly_above": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/suppress_reply_when_quoting": { "put": { "description": "suppress reply when quoting\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "suppress_reply_when_quoting" ], "properties": { "suppress_reply_when_quoting": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_reply_history": { "put": { "description": "max reply history\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_reply_history" ], "properties": { "max_reply_history": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/post_undo_action_window_mins": { "put": { "description": "post undo action window mins\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "post_undo_action_window_mins" ], "properties": { "post_undo_action_window_mins": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_mentions_per_post": { "put": { "description": "max mentions per post\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_mentions_per_post" ], "properties": { "max_mentions_per_post": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_users_notified_per_group_mention": { "put": { "description": "max users notified per group mention\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_users_notified_per_group_mention" ], "properties": { "max_users_notified_per_group_mention": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/newuser_max_replies_per_topic": { "put": { "description": "newuser max replies per topic\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "newuser_max_replies_per_topic" ], "properties": { "newuser_max_replies_per_topic": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/newuser_max_mentions_per_post": { "put": { "description": "newuser max mentions per post\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "newuser_max_mentions_per_post" ], "properties": { "newuser_max_mentions_per_post": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/title_max_word_length": { "put": { "description": "title max word length\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "title_max_word_length" ], "properties": { "title_max_word_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/newuser_max_links": { "put": { "description": "newuser max links\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "newuser_max_links" ], "properties": { "newuser_max_links": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/newuser_max_images": { "put": { "description": "newuser max images\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "newuser_max_images" ], "properties": { "newuser_max_images": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/newuser_max_attachments": { "put": { "description": "newuser max attachments\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "newuser_max_attachments" ], "properties": { "newuser_max_attachments": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/post_excerpt_maxlength": { "put": { "description": "post excerpt maxlength\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "post_excerpt_maxlength" ], "properties": { "post_excerpt_maxlength": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_pinned_excerpt_mobile": { "put": { "description": "show pinned excerpt mobile\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_pinned_excerpt_mobile" ], "properties": { "show_pinned_excerpt_mobile": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_pinned_excerpt_desktop": { "put": { "description": "show pinned excerpt desktop\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_pinned_excerpt_desktop" ], "properties": { "show_pinned_excerpt_desktop": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/display_name_on_posts": { "put": { "description": "display name on posts\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "display_name_on_posts" ], "properties": { "display_name_on_posts": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_time_gap_days": { "put": { "description": "show time gap days\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_time_gap_days" ], "properties": { "show_time_gap_days": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/short_progress_text_threshold": { "put": { "description": "short progress text threshold\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "short_progress_text_threshold" ], "properties": { "short_progress_text_threshold": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_code_lang": { "put": { "description": "default code lang\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_code_lang" ], "properties": { "default_code_lang": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/warn_reviving_old_topic_age": { "put": { "description": "warn reviving old topic age\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "warn_reviving_old_topic_age" ], "properties": { "warn_reviving_old_topic_age": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/autohighlight_all_code": { "put": { "description": "autohighlight all code\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "autohighlight_all_code" ], "properties": { "autohighlight_all_code": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/highlighted_languages": { "put": { "description": "highlighted languages\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "highlighted_languages" ], "properties": { "highlighted_languages": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/delete_old_hidden_posts": { "put": { "description": "delete old hidden posts\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "delete_old_hidden_posts" ], "properties": { "delete_old_hidden_posts": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/censored_words": { "put": { "description": "censored words\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "censored_words" ], "properties": { "censored_words": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/censored_pattern": { "put": { "description": "censored pattern\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "censored_pattern" ], "properties": { "censored_pattern": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_emoji": { "put": { "description": "enable emoji\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_emoji" ], "properties": { "enable_emoji": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/emoji_set": { "put": { "description": "emoji set\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "emoji_set" ], "properties": { "emoji_set": { "type": "string", "enum": [ "apple", "google", "twitter", "emoji_one", "win10" ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enforce_square_emoji": { "put": { "description": "enforce square emoji\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enforce_square_emoji" ], "properties": { "enforce_square_emoji": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/approve_post_count": { "put": { "description": "approve post count\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "approve_post_count" ], "properties": { "approve_post_count": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/approve_unless_trust_level": { "put": { "description": "approve unless trust level\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "approve_unless_trust_level" ], "properties": { "approve_unless_trust_level": { "type": "integer", "enum": [ 0, 1, 2, 3, 4 ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/approve_new_topics_unless_trust_level": { "put": { "description": "approve new topics unless trust level\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "approve_new_topics_unless_trust_level" ], "properties": { "approve_new_topics_unless_trust_level": { "type": "integer", "enum": [ 0, 1, 2, 3, 4 ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/notify_about_queued_posts_after": { "put": { "description": "notify about queued posts after\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "notify_about_queued_posts_after" ], "properties": { "notify_about_queued_posts_after": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/auto_close_messages_post_count": { "put": { "description": "auto close messages post count\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "auto_close_messages_post_count" ], "properties": { "auto_close_messages_post_count": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/auto_close_topics_post_count": { "put": { "description": "auto close topics post count\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "auto_close_topics_post_count" ], "properties": { "auto_close_topics_post_count": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/code_formatting_style": { "put": { "description": "code formatting style\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "code_formatting_style" ], "properties": { "code_formatting_style": { "type": "string", "enum": [ "4-spaces-indent", "code-fences" ] } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/embed_truncate": { "put": { "description": "embed truncate\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "embed_truncate" ], "properties": { "embed_truncate": { "type": "boolean" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allowed_href_schemes": { "put": { "description": "allowed href schemes\n", "tags": [ "Site Settings Posting" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allowed_href_schemes" ], "properties": { "allowed_href_schemes": { "type": "string" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_time_window_mins": { "put": { "description": "email time window mins\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_time_window_mins" ], "properties": { "email_time_window_mins": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/private_email_time_window_seconds": { "put": { "description": "private email time window seconds\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "private_email_time_window_seconds" ], "properties": { "private_email_time_window_seconds": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_posts_context": { "put": { "description": "email posts context\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_posts_context" ], "properties": { "email_posts_context": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/digest_min_excerpt_length": { "put": { "description": "digest min excerpt length\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "digest_min_excerpt_length" ], "properties": { "digest_min_excerpt_length": { "type": "integer" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/digest_topics": { "put": { "description": "digest topics\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "digest_topics" ], "properties": { "digest_topics": { "type": "integer", "example": 5 } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/digest_posts": { "put": { "description": "digest posts\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "digest_posts" ], "properties": { "digest_posts": { "type": "integer", "example": 3 } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/digest_other_topics": { "put": { "description": "digest other topics\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "digest_other_topics" ], "properties": { "digest_other_topics": { "type": "integer", "example": 5 } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/delete_digest_email_after_days": { "put": { "description": "delete digest email after days\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "delete_digest_email_after_days" ], "properties": { "delete_digest_email_after_days": { "type": "integer", "example": 365 } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/digest_suppress_categories": { "put": { "description": "digest suppress categories\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "digest_suppress_categories" ], "properties": { "digest_suppress_categories": { "type": "string", "description": "pipe delimited category_id's", "example": "3|1" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/disable_digest_emails": { "put": { "description": "disable digest emails\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "disable_digest_emails" ], "properties": { "digest_digest_emails": { "type": "boolean", "example": false } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_accent_bg_color": { "put": { "description": "email accent bg color\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_accent_bg_color" ], "properties": { "email_accent_bg_color": { "type": "string", "example": "#2F70AD", "description": "Enter a color name ('red') or hex value ('#FF000').\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_accent_fg_color": { "put": { "description": "email accent fg color\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_accent_fg_color" ], "properties": { "email_accent_fg_color": { "type": "string", "example": "#FFFFFF", "description": "Enter a color name ('white') or hex value ('#FFFFFF').\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_link_color": { "put": { "description": "email link color\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_link_color" ], "properties": { "email_link_color": { "type": "string", "example": "#006699", "description": "Enter a color name ('blue') or hex value ('#0000FF').\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_topic_featured_link_in_digest": { "put": { "description": "show topic featured link in digest\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_topic_featured_link_in_digest" ], "properties": { "show_topic_featured_link_in_digest": { "type": "boolean", "example": false } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_custom_headers": { "put": { "description": "email custom headers\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_custom_headers" ], "properties": { "email_custom_headers": { "type": "string", "example": "Auto-Submitted: auto-generated", "description": "A pipe-delimited list of custom email headers" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_subject": { "put": { "description": "email subject\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_subject" ], "properties": { "email_subject": { "type": "string", "example": "[%{site_name}] %{optional_pm}%{optional_cat}%{topic_title}", "description": "Customizable subject format for standard emails." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/reply_by_email_enabled": { "put": { "description": "reply by email enabled\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "reply_by_email_enabled" ], "properties": { "reply_by_email_enabled": { "type": "boolean", "example": false, "description": "`reply_by_email_address` needs to be set first" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/reply_by_email_address": { "put": { "description": "reply by email address\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "reply_by_email_address" ], "properties": { "reply_by_email_address": { "type": "string", "example": "%{reply_key}@reply.example.com or replies+%{reply_key}@example.com", "description": "Template for reply by email incoming email address." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/alternative_reply_by_email_addresses": { "put": { "description": "alternative reply by email addresses\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "alternative_reply_by_email_addresses" ], "properties": { "alternative_reply_by_email_addresses": { "type": "string", "example": "%{reply_key}@reply.example.com|replies+%{reply_key}@example.com", "description": "List of alternative templates for reply by email incoming email addresses." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/manual_polling_enabled": { "put": { "description": "manual polling enabled\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "manual_polling_enabled" ], "properties": { "manual_polling_enabled": { "type": "boolean", "example": false } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_enabled": { "put": { "description": "pop3 polling enabled\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_enabled" ], "properties": { "pop3_polling_enabled": { "type": "boolean", "example": false, "description": "You must set a 'pop3 polling host' before enabling POP3 polling" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_ssl": { "put": { "description": "pop3 polling ssl\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_ssl" ], "properties": { "pop3_polling_ssl": { "type": "boolean", "example": true, "description": "Use SSL while connecting to the POP3 server" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_openssl_verify": { "put": { "description": "pop3 polling openssl verify\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_openssl_verify" ], "properties": { "pop3_polling_openssl_verify": { "type": "boolean", "example": true, "description": "Verify TLS server certificate" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_period_mins": { "put": { "description": "pop3 polling period mins\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_period_mins" ], "properties": { "pop3_polling_period_mins": { "type": "integer", "example": 5, "description": "\"The period in minutes between checking the POP3 account for email. NOTE: requires restart.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_host": { "put": { "description": "pop3 polling host\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_host" ], "properties": { "pop3_polling_host": { "type": "string", "description": "The host to poll for email via POP3" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_port": { "put": { "description": "pop3 polling port\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_port" ], "properties": { "pop3_polling_port": { "type": "integer", "example": 995, "description": "The port to poll a POP3 account on" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_username": { "put": { "description": "pop3 polling username\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_username" ], "properties": { "pop3_polling_username": { "type": "string", "description": "The username for the POP3 account to poll for email." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/pop3_polling_password": { "put": { "description": "pop3 polling password\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "pop3_polling_password" ], "properties": { "pop3_polling_password": { "type": "string", "description": "The password for the POP3 account to poll for email." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/log_mail_processing_failures": { "put": { "description": "log mail processing failures\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "log_mail_processing_failures" ], "properties": { "log_mail_processing_failures": { "type": "boolean", "description": "Log all email processing failures to http://yoursite.com/logs" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/incoming_email_prefer_html": { "put": { "description": "incoming email prefer html\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "incoming_email_prefer_html" ], "properties": { "incoming_email_prefer_html": { "type": "boolean", "description": "Use the HTML instead of the text for incoming email. May cause unexpected formatting issues!\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_in": { "put": { "description": "email in\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_in" ], "properties": { "email_in": { "type": "boolean", "description": "'Allow users to post new topics via email (requires pop3 polling). Configure the addresses in the \"Settings\" tab of each category.'\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_in_min_trust": { "put": { "description": "email in min trust\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_in_min_trust" ], "properties": { "email_in_min_trust": { "type": "integer", "enum": [ 0, 1, 2, 3, 4 ], "description": "The minimum trust level a user needs to have to be allowed to post new topics via email.\n", "example": 2 } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_prefix": { "put": { "description": "email prefix\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_prefix" ], "properties": { "email_prefix": { "type": "string", "description": "\"The [label] used in the subject of emails. It will default to 'title' if not set.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/email_site_title": { "put": { "description": "email site title\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "email_site_title" ], "properties": { "email_site_title": { "type": "string", "description": "The title of the site used as the sender of emails from the site. Default to 'title' if not set. If your 'title' contains characters that are not allowed in email sender strings, use this setting.\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/disable_emails": { "put": { "description": "disable emails\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "disable_emails" ], "properties": { "disable_emails": { "type": "boolean", "example": false, "description": "Prevent Discourse from sending any kind of emails\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/strip_images_from_short_emails": { "put": { "description": "strip images from short emails\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "strip_images_from_short_emails" ], "properties": { "strip_images_from_short_emails": { "type": "boolean", "example": true, "description": "Strip images from emails having size less than 2800 Bytes" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/short_email_length": { "put": { "description": "short email length\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "short_email_length" ], "properties": { "short_email_length": { "type": "integer", "example": 2800, "description": "Short email length in Bytes" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/display_name_on_email_from": { "put": { "description": "display name on email from\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "display_name_on_email_from" ], "properties": { "display_name_on_email_from": { "type": "boolean", "example": true, "description": "Display full names on email from fields\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/unsubscribe_via_email": { "put": { "description": "unsubscribe via email\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "unsubscribe_via_email" ], "properties": { "unsubscribe_via_email": { "type": "boolean", "example": true, "description": "Allow users to unsubscribe from emails by sending an email with 'unsubscribe' in the subject or body\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/unsubscribe_via_email_footer": { "put": { "description": "unsubscribe via email footer\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "unsubscribe_via_email_footer" ], "properties": { "unsubscribe_via_email_footer": { "type": "boolean", "example": false, "description": "Attach an unsubcribe via email mailto: link to the footer of sent email" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/delete_email_logs_after_days": { "put": { "description": "delete email logs after days\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "delete_email_logs_after_days" ], "properties": { "delete_email_logs_after_days": { "type": "integer", "exampe": 365, "description": "Delete email logs after (N) days. 0 to keep indefinitely\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_emails_per_day_per_user": { "put": { "description": "max emails per day per user\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_emails_per_day_per_user" ], "properties": { "max_emails_per_day_per_user": { "type": "integer", "example": 100, "description": "Maximum number of emails to send users per day. 0 to disable the limit" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_staged_users": { "put": { "description": "enable staged users\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_staged_users" ], "properties": { "enable_staged_users": { "type": "boolean", "example": true, "description": "Automatically create staged users when processing incoming emails." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/maximum_staged_users_per_email": { "put": { "description": "maximum staged users per email\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "maximum_staged_users_per_email" ], "properties": { "maximum_staged_users_per_email": { "type": "integer", "example": 10, "description": "Maximum number of staged users created when processing an incoming email." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/auto_generated_whitelist": { "put": { "description": "auto generated whitelist\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "auto_generated_whitelist" ], "properties": { "auto_generated_whitelist": { "type": "string", "example": "foo@bar.com|discourse@bar.com", "description": "List of email addresses that won't be checked for auto-generated content." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/block_auto_generated_emails": { "put": { "description": "block auto generated emails\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "block_auto_generated_emails" ], "properties": { "block_auto_generated_emails": { "type": "boolean", "example": true, "description": "Block incoming emails identified as being auto generated." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/ignore_by_title": { "put": { "description": "ignore by title\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "ignore_by_title" ], "properties": { "ignore_by_title": { "type": "string", "example": "", "description": "pipe delimited list" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/mailgun_api_key": { "put": { "description": "mailgun api key\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "mailgun_api_key" ], "properties": { "mailgun_api_key": { "type": "string", "example": "", "description": "Mailgun Secret API key used to verify webhook messages." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/bounce_score_threshold": { "put": { "description": "bounce score threshold\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "bounce_score_threshold" ], "properties": { "bounce_score_threshold": { "type": "integer", "example": 4, "description": "Max bounce score before we will stop emailing a user." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/bounce_score_threshold_deactivate": { "put": { "description": "bounce score threshold deactive\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "bounce_score_threshold_deactivate" ], "properties": { "bounce_score_threshold_deactivate": { "type": "integer", "example": 30, "description": "Max bounce score before we will deactivate a user." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/soft_bounce_score": { "put": { "description": "soft bounce score\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "soft_bounce_score" ], "properties": { "soft_bounce_score": { "type": "integer", "example": 1, "description": "Bounce score added to the user when a temporary bounce happens." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/hard_bounce_score": { "put": { "description": "hard bounce score\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "hard_bounce_score" ], "properties": { "hard_bounce_score": { "type": "integer", "example": 2, "description": "Bounce score added to the user when a permanent bounce happens." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/reset_bounce_score_after_days": { "put": { "description": "reset bounce score after days\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "reset_bounce_score_after_days" ], "properties": { "reset_bounce_score_after_days": { "type": "integer", "example": 31, "description": "Automatically reset bounce score after X days." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/attachment_content_type_blacklist": { "put": { "description": "attachment content type blacklist\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "attachment_content_type_blacklist" ], "properties": { "attachment_content_type_blacklist": { "type": "string", "example": "pkcs7|x-vcard", "description": "Pipe delimited list of keywords used to blacklist attachments based on the content type." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/attachment_filename_blacklist": { "put": { "description": "attachment filename blacklist\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "attachment_filename_blacklist" ], "properties": { "attachment_filename_blacklist": { "type": "string", "example": "smime.p7s|signature.asc", "description": "Pipe delimited list of keywords used to blacklist attachments based on the filename." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_forwarded_emails": { "put": { "description": "enable forwarded emails\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_forwarded_emails" ], "properties": { "enable_forwarded_emails": { "type": "boolean", "example": false, "description": "[BETA] Allow users to create a topic by forwarding an email in." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/always_show_trimmed_content": { "put": { "description": "always show trimmed content\n", "tags": [ "Site Settings Email" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "always_show_trimmed_content" ], "properties": { "always_show_trimmed_content": { "type": "boolean", "example": false, "description": "Always show trimmed part of incoming emails. WARNING: might reveal email addresses." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_image_size_kb": { "put": { "description": "max image size kb\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_image_size_kb" ], "properties": { "max_image_size_kb": { "type": "integer", "example": 3072, "description": "The maximum image upload size in kB. This must be configured in nginx {client_max_body_size} / apache or proxy as well." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_attachment_size_kb": { "put": { "description": "max attachment size kb\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_attachment_size_kb" ], "properties": { "max_image_size_kb": { "type": "integer", "example": 3072, "description": "The maximum attachment upload size in kB. This must be configured in nginx {client_max_body_size} / apache or proxy as well." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_image_megapixels": { "put": { "description": "max image megapixels\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_image_megapixels" ], "properties": { "max_image_megapixels": { "type": "integer", "example": 40, "description": "Maximum number of megapixels allowed for an image" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/authorized_extensions": { "put": { "description": "authorized extensions\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "authorized_extensions" ], "properties": { "authorized_extensions": { "type": "string", "example": "jpg|jpeg|png|gif", "description": "A pipe delimited list of file extensions allowed for upload (use \"*\" to enable all file types)" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/crawl_images": { "put": { "description": "crawl images\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "crawl_images" ], "properties": { "crawl_images": { "type": "boolean", "example": true, "description": "Retrieve images from remote URLs to insert the correct width and height dimensions." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_image_width": { "put": { "description": "max image width\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_image_width" ], "properties": { "max_image_width": { "type": "integer", "example": 690, "description": "Maximum thumbnail width of images in a post" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_image_height": { "put": { "description": "max image height\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_image_height" ], "properties": { "max_image_height": { "type": "integer", "example": 500, "description": "Maximum thumbnail height of images in a post" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/download_remote_images_to_local": { "put": { "description": "download remote images to local\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "download_remote_images_to_local" ], "properties": { "max_image_width": { "type": "boolean", "example": true, "description": "Convert remote images to local images by downloading them; this prevents broken images." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/download_remote_images_threshold": { "put": { "description": "download remote images threshold\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "download_remote_images_threshold" ], "properties": { "download_remote_images_threshold": { "type": "integer", "example": 10, "description": "Minimum disk space necessary to download remote images locally (in percent)" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/download_remote_images_max_days_old": { "put": { "description": "download remote images max days old\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "download_remote_images_max_days_old" ], "properties": { "download_remote_images_max_days_old": { "type": "integer", "example": 30, "description": "Don't download remote images for posts that are more than n days old." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/disabled_image_download_domains": { "put": { "description": "disabled image download domains\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "disabled_image_download_domains" ], "properties": { "disabled_image_download_domains": { "type": "string", "example": "", "description": "Remote images will never be downloaded from these domains. Pipe-delimited list." } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/create_thumbnails": { "put": { "description": "create thumbnails\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "create_thumbnails" ], "properties": { "create_thumbnails": { "type": "boolean", "example": true, "description": "\"Create thumbnails and lightbox images that are too large to fit in a post\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/clean_up_uploads": { "put": { "description": "clean up uploads\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "clean_up_uploads" ], "properties": { "clean_up_uploads": { "type": "boolean", "example": true, "description": "\"Remove orphan unreferenced uploads to prevent illegal hosting. WARNING: you may want to back up of your /uploads directory before enabling this setting.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/clean_orphan_uploads_grace_period_hours": { "put": { "description": "clean orphan uploads grace period hours\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "clean_orphan_uploads_grace_period_hours" ], "properties": { "clean_orphan_uploads_grace_period_hours": { "type": "integer", "example": 48, "description": "\"Grace period (in hours) before an orphan upload is removed.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/purge_deleted_uploads_grace_period_days": { "put": { "description": "purge deleted uploads grace period days\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "purge_deleted_uploads_grace_period_days" ], "properties": { "purge_deleted_uploads_grace_period_days": { "type": "integer", "example": 30, "description": "\"Grace period (in days) before a deleted upload is erased.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/prevent_anons_from_downloading_files": { "put": { "description": "prevent anons from downloading files\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "prevent_anons_from_downloading_files" ], "properties": { "prevent_anons_from_downloading_files": { "type": "boolean", "example": false, "description": "\"Prevent anonymous users from downloading attachments. WARNING: this will prevent any non-image site assets posted as attachments from working.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_s3_uploads": { "put": { "description": "enable s3 uploads\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_s3_uploads" ], "properties": { "enable_s3_uploads": { "type": "boolean", "example": false, "description": "\"Place uploads on Amazon S3 storage. IMPORTANT: requires valid S3 credentials (both access key id & secret access key).\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_use_iam_profile": { "put": { "description": "s3 use iam profile\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_use_iam_profile" ], "properties": { "s3_use_iam_profile": { "type": "boolean", "example": false, "description": "'Use AWS EC2 IAM role to retrieve keys. NOTE: enabling will override \"s3 access key id\" and \"s3 secret access key\" settings.'\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_access_key_id": { "put": { "description": "s3 access key id\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_access_key_id" ], "properties": { "s3_access_key_id": { "type": "string", "example": "", "description": "\"The Amazon S3 access key id that will be used to upload images.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_secret_access_key": { "put": { "description": "s3 secret access key\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_secret_access_key" ], "properties": { "s3_secret_access_key": { "type": "string", "example": "", "description": "\"The Amazon S3 secret access key that will be used to upload images.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_region": { "put": { "description": "s3 region\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_region" ], "properties": { "s3_region": { "type": "string", "enum": [ "ap-northeast-1", "ap-northeast-2", "ap-south-1", "ap-southeast-1", "ap-southeast-2", "cn-north-1", "eu-central-1", "eu-west-1", "sa-east-1", "us-east-1", "us-gov-west-1", "us-west-1", "us-west-2" ], "example": "us-west-2", "description": "\"The Amazon S3 region name that will be used to upload images.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_upload_bucket": { "put": { "description": "s3 upload bucket\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_upload_bucket" ], "properties": { "s3_upload_bucket": { "type": "string", "example": "", "description": "\"The Amazon S3 bucket name that files will be uploaded into. WARNING: must be lowercase, no periods, no underscores.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_cdn_url": { "put": { "description": "s3 cdn url\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_cdn_url" ], "properties": { "s3_cdn_url": { "type": "string", "example": "", "description": "\"The CDN URL to use for all s3 assets (for example: https://cdn.somewhere.com). WARNING: after changing this setting you must rebake all old posts.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_profile_backgrounds": { "put": { "description": "allow profile backgrounds\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_profile_backgrounds" ], "properties": { "allow_profile_backgrounds": { "type": "boolean", "example": true, "description": "\"Allow users to upload profile backgrounds.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/automatically_download_gravatars": { "put": { "description": "automatically download gravatars\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "automatically_download_gravatars" ], "properties": { "automatically_download_gravatars": { "type": "boolean", "example": true, "description": "\"Download Gravatars for users upon account creation or email change.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_uploaded_avatars": { "put": { "description": "allow uploaded avatars\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_uploaded_avatars" ], "properties": { "allow_uploaded_avatars": { "type": "boolean", "example": true, "description": "\"Allow users to upload custom profile pictures.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_animated_avatars": { "put": { "description": "allow animated avatars\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_animated_avatars" ], "properties": { "allow_animated_avatars": { "type": "boolean", "example": false, "description": "\"Allow users to use animated gif profile pictures. WARNING: run the avatars:refresh rake task after changing this setting.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_animated_thumbnails": { "put": { "description": "allow animated thumbnails\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_animated_thumbnails" ], "properties": { "allow_animated_thumbnails": { "type": "boolean", "example": true, "description": "\"Generate animated thumbnails of animated gifs.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_avatars": { "put": { "description": "default avatars\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_avatars" ], "properties": { "default_avatars": { "type": "string", "example": "", "description": "\"URLs to avatars that will be used by default for new users until they change them.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/avatar_sizes": { "put": { "description": "avatar sizes\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "avatar_sizes" ], "properties": { "avatar_sizes": { "type": "string", "example": "20|25|32|45|60|120", "description": "\"List of automatically generated avatar sizes.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/external_system_avatars_enabled": { "put": { "description": "external system avatars enabled\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "external_system_avatars_enabled" ], "properties": { "external_system_avatars_enabled": { "type": "boolean", "example": true, "description": "\"Use external system avatars service.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/external_system_avatars_url": { "put": { "description": "external system avatars url\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "external_system_avatars_url" ], "properties": { "external_system_avatars_url": { "type": "string", "example": "/letter_avatar_proxy/v2/letter/{first_letter}/{color}/{size}.png", "description": "\"URL of the external system avatars service. Allowed substitutions are {username} {first_letter} {color} {size}\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_all_attachments_for_group_messages": { "put": { "description": "allow all attachments for group messages\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_all_attachments_for_group_messages" ], "properties": { "allow_all_attachments_for_group_messages": { "type": "boolean", "example": false, "description": "\"Allow all email attachments for group messages.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/convert_pasted_images_to_hq_jpg": { "put": { "description": "convert pasted images to hq jpg\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "convert_pasted_images_to_hq_jpg" ], "properties": { "convert_pasted_images_to_hq_jpg": { "type": "boolean", "example": true, "description": "\"Convert pasted images to high-quality JPG files.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/convert_pasted_images_quality": { "put": { "description": "convert pasted images quality\n", "tags": [ "Site Settings Files" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "convert_pasted_images_quality" ], "properties": { "convert_pasted_images_quality": { "type": "integer", "example": 95, "description": "\"Quality of the converted JPG file (1 is lowest quality, 100 is best quality).\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_trust_level": { "put": { "description": "default trust level\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_trust_level" ], "properties": { "default_trust_level": { "type": "integer", "example": 0, "enum": [ 0, 1, 2, 3, 4 ], "description": "\"Default trust level (0-4) for all new users. WARNING! Changing this will put you at serious risk for spam.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_invitee_trust_level": { "put": { "description": "default invitee trust level\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_invitee_trust_level" ], "properties": { "default_invitee_trust_level": { "type": "integer", "example": 1, "enum": [ 0, 1, 2, 3, 4 ], "description": "\"Default trust level (0-4) for invited users.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_to_create_topic": { "put": { "description": "min trust to create topic\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_to_create_topic" ], "properties": { "min_trust_to_create_topic": { "type": "integer", "example": 0, "enum": [ 0, 1, 2, 3, 4 ], "description": "\"The minimum trust level required to create a new topic\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_to_edit_wiki_post": { "put": { "description": "min trust to edit wiki post\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_to_edit_wiki_post" ], "properties": { "min_trust_to_edit_wiki_post": { "type": "integer", "example": 1, "enum": [ 0, 1, 2, 3, 4 ], "description": "\"The minimum trust level required to edit post marked as wiki.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_to_edit_post": { "put": { "description": "min trust to edit post\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_to_edit_post" ], "properties": { "min_trust_to_edit_post": { "type": "integer", "example": 0, "enum": [ 0, 1, 2, 3, 4 ], "description": "\"The minimum trust level required to edit posts.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_to_allow_self_wiki": { "put": { "description": "min trust to allow self wiki\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_to_allow_self_wiki" ], "properties": { "min_trust_to_allow_self_wiki": { "type": "integer", "example": 3, "enum": [ 0, 1, 2, 3, 4 ], "description": "\"The minimum trust level required to make user's own post wiki.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_to_send_messages": { "put": { "description": "min trust to send messages\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_to_send_messages" ], "properties": { "min_trust_to_send_messages": { "type": "integer", "example": 0, "enum": [ 0, 1, 2, 3, 4 ], "description": "\"The minimum trust level required to create new private messages.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl1_requires_topics_entered": { "put": { "description": "tl1 requires topics entered\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl1_requires_topics_entered" ], "properties": { "tl1_requires_topics_entered": { "type": "integer", "example": 5, "description": "\"How many topics a new user must enter before promotion to trust level 1.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl1_requires_read_posts": { "put": { "description": "tl1 requires read posts\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl1_requires_read_posts" ], "properties": { "tl1_requires_read_posts": { "type": "integer", "example": 30, "description": "\"How many posts a new user must read before promotion to trust level 1.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl1_requires_time_spent_mins": { "put": { "description": "tl1 requires time spent mins\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl1_requires_time_spent_mins" ], "properties": { "tl1_requires_time_spent_mins": { "type": "integer", "example": 10, "description": "\"How many minutes a new user must read posts before promotion to trust level 1.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_requires_topics_entered": { "put": { "description": "tl2 requires topics entered\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_requires_topics_entered" ], "properties": { "tl2_requires_topics_entered": { "type": "integer", "example": 20, "description": "\"How many topics a user must enter before promotion to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_requires_read_posts": { "put": { "description": "tl2 requires read posts\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_requires_read_posts" ], "properties": { "tl2_requires_read_posts": { "type": "integer", "example": 100, "description": "\"How many posts a user must read before promotion to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_requires_time_spent_mins": { "put": { "description": "tl2 requires time spent mins\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_requires_time_spent_mins" ], "properties": { "tl2_requires_time_spent_mins": { "type": "integer", "example": 60, "description": "\"How many minutes a user must read posts before promotion to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_requires_days_visited": { "put": { "description": "tl2 requires days visited\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_requires_days_visited" ], "properties": { "tl2_requires_days_visited": { "type": "integer", "example": 15, "description": "\"How many days a user must visit the site before promotion to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_requires_likes_received": { "put": { "description": "tl2 requires likes received\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_requires_likes_received" ], "properties": { "tl2_requires_likes_received": { "type": "integer", "example": 1, "description": "\"How many likes a user must receive before promotion to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_requires_likes_given": { "put": { "description": "tl2 requires likes given\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_requires_likes_given" ], "properties": { "tl2_requires_likes_given": { "type": "integer", "example": 1, "description": "\"How many likes a user must cast before promotion to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_requires_topic_reply_count": { "put": { "description": "tl2 requires topic reply count\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_requires_topic_reply_count" ], "properties": { "tl2_requires_topic_reply_count": { "type": "integer", "example": 3, "description": "\"How many topics user must reply to before promotion to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_time_period": { "put": { "description": "tl2 time period\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_time_period" ], "properties": { "tl3_time_period": { "type": "integer", "example": 100, "description": "\"Trust Level 3 requirements time period (in days)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_days_visited": { "put": { "description": "tl3 requires days visited\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_days_visited" ], "properties": { "tl3_requires_days_visited": { "type": "integer", "example": 50, "description": "\"Minimum number of days that a user needs to have visited the site in the last (tl3 time period) days to qualify for promotion to trust level 3. Set higher than tl3 time period to disable promotions to tl3. (0 or higher)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_topics_replied_to": { "put": { "description": "tl3 requires topics replied to\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_topics_replied_to" ], "properties": { "tl3_requires_topics_replied_to": { "type": "integer", "example": 10, "description": "\"Minimum number of topics a user needs to have replied to in the last (tl3 time period) days to qualify for promotion to trust level 3. (0 or higher)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_topics_viewed": { "put": { "description": "tl3 requires topics viewed\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_topics_viewed" ], "properties": { "tl3_requires_topics_viewed": { "type": "integer", "example": 25, "description": "\"The percentage of topics created in the last (tl3 time period) days that a user needs to have viewed to qualify for promotion to trust level 3. (0 to 100)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_topics_viewed_cap": { "put": { "description": "tl3 requires topics viewed cap\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_topics_viewed_cap" ], "properties": { "tl3_requires_topics_viewed_cap": { "type": "integer", "example": 500, "description": "\"The maximum required number of topics viewed in the last (tl3 time period) days.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_posts_read": { "put": { "description": "tl3 requires posts read\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_posts_read" ], "properties": { "tl3_requires_posts_read": { "type": "integer", "example": 25, "description": "\"The percentage of posts created in the last (tl3 time period) days that a user needs to have viewed to qualify for promotion to trust level 3. (0 to 100)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_posts_read_cap": { "put": { "description": "tl3 requires posts read cap\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_posts_read_cap" ], "properties": { "tl3_requires_posts_read_cap": { "type": "integer", "example": 20000, "description": "\"The maximum required number of posts read in the last (tl3 time period) days.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_topics_viewed_all_time": { "put": { "description": "tl3 requires topics viewed all time\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_viewed_all_time" ], "properties": { "tl3_requires_viewed_all_time": { "type": "integer", "example": 200, "description": "\"The minimum total number of topics a user must have viewed to qualify for trust level 3.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_posts_read_all_time": { "put": { "description": "tl3 requires posts read all time\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_posts_read_all_time" ], "properties": { "tl3_requires_posts_read_all_time": { "type": "integer", "example": 500, "description": "\"The minimum total number of posts a user must have read to qualify for trust level 3.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_max_flagged": { "put": { "description": "tl3 requires max flagged\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_max_flagged" ], "properties": { "tl3_requires_max_flagged": { "type": "integer", "example": 5, "description": "\"User must not have had more than x posts flagged by x different users in the last (tl3 time period) days to qualify for promotion to trust level 3, where x is this setting's value. (0 or higher)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_promotion_min_duration": { "put": { "description": "tl3 promotion min duration\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_promotion_min_duration" ], "properties": { "tl3_promotion_min_duration": { "type": "integer", "example": 14, "description": "\"The minimum number of days that a promotion to trust level 3 lasts before a user can be demoted back to trust level 2.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_likes_given": { "put": { "description": "tl3 requires likes given\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_likes_given" ], "properties": { "tl3_requires_likes_given": { "type": "integer", "example": 30, "description": "\"The minimum number of likes that must be given in the last (tl3 time period) days to qualify for promotion to trust level 3.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_requires_likes_received": { "put": { "description": "tl3 requires likes received\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_requires_likes_received" ], "properties": { "tl3_requires_likes_received": { "type": "integer", "example": 20, "description": "\"The minimum number of likes that must be received in the last (tl3 time period) days to qualify for promotion to trust level 3.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_links_no_follow": { "put": { "description": "tl3 links no follow\n", "tags": [ "Site Settings Trust Levels" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_links_no_follow" ], "properties": { "tl3_links_no_follow": { "type": "boolean", "example": false, "description": "\"Do not remove rel=nofollow from links posted by trust level 3 users.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/force_https": { "put": { "description": "force https\n", "tags": [ "Site Settings Security" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "force_https" ], "properties": { "force_https": { "type": "boolean", "example": false, "description": "\"Force your site to use HTTPS only. WARNING: do NOT enable this until you verify HTTPS is fully set up and working absolutely everywhere! Did you check your CDN, all social logins, and any external logos / dependencies to make sure they are all HTTPS compatible, too?\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_escaped_fragments": { "put": { "description": "enable escaped fragments\n", "tags": [ "Site Settings Security" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_escaped_fragments" ], "properties": { "enable_escaped_fragments": { "type": "boolean", "example": true, "description": "\"Fall back to Google's Ajax-Crawling API if no webcrawler is detected. See https://developers.google.com/webmasters/ajax-crawling/docs/learn-more\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_index_in_robots_txt": { "put": { "description": "allow index in robots txt\n", "tags": [ "Site Settings Security" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_index_in_robots_txt" ], "properties": { "allow_index_in_robots_txt": { "type": "boolean", "example": true, "description": "\"Specify in robots.txt that this site is allowed to be indexed by web search engines.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_noscript_support": { "put": { "description": "enable noscript support\n", "tags": [ "Site Settings Security" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_noscript_support" ], "properties": { "enable_noscript_support": { "type": "boolean", "example": true, "description": "\"Enable standard webcrawler search engine support via the noscript tag\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_moderators_to_create_categories": { "put": { "description": "allow moderators to create categories\n", "tags": [ "Site Settings Security" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_moderators_to_create_categories" ], "properties": { "allow_moderators_to_create_categories": { "type": "boolean", "example": false, "description": "\"Allow moderators to create new categories\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/cors_origins": { "put": { "description": "cors origins\n", "tags": [ "Site Settings Security" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "cors_origins" ], "properties": { "cors_origins": { "type": "string", "example": "", "description": "\"Allowed origins for cross-origin requests (CORS). Each origin must include http:// or https://. The DISCOURSE_ENABLE_CORS env variable must be set to true to enable CORS.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/use_admin_ip_whitelist": { "put": { "description": "use admin ip whitelist\n", "tags": [ "Site Settings Security" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "use_admin_ip_whitelist" ], "properties": { "use_admin_ip_whitelist": { "type": "boolean", "example": false, "description": "\"Admins can only log in if they are at an IP address defined in the Screened IPs list (Admin > Logs > Screened Ips).\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_flash_video_onebox": { "put": { "description": "enable flash video onebox\n", "tags": [ "Site Settings Onebox" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_flash_video_onebox" ], "properties": { "enable_flash_video_onebox": { "type": "boolean", "example": false, "description": "\"Enable embedding of swf and flv (Adobe Flash) links in oneboxes. WARNING: may introduce security risks.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/post_onebox_maxlength": { "put": { "description": "post onebox maxlength\n", "tags": [ "Site Settings Onebox" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "post_onebox_maxlength" ], "properties": { "post_onebox_maxlength": { "type": "integer", "example": 500, "description": "\"Maximum length of a oneboxed Discourse post in characters.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/onebox_domains_blacklist": { "put": { "description": "onebox domains blacklist\n", "tags": [ "Site Settings Onebox" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "onebox_domains_blacklist" ], "properties": { "onebox_domains_blacklist": { "type": "string", "example": "", "description": "\"A list of domains that will never be oneboxed.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_oneboxes_per_post": { "put": { "description": "max oneboxes per post\n", "tags": [ "Site Settings Onebox" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_oneboxes_per_post" ], "properties": { "max_oneboxes_per_post": { "type": "integer", "example": 50, "description": "\"Enable embedding of swf and flv (Adobe Flash) links in oneboxes. WARNING: may introduce security risks.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/add_rel_nofollow_to_user_content": { "put": { "description": "add rel nofollow to user content\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "add_rel_nofollow_to_user_content" ], "properties": { "add_rel_nofollow_to_user_content": { "type": "boolean", "example": true, "description": "'Add rel nofollow to all submitted user content, except for internal links (including parent domains). If you change this, you must rebake all posts with: \"rake posts:rebake\"'\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/flags_required_to_hide_post": { "put": { "description": "flags required to hide post\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "flags_required_to_hide_post" ], "properties": { "flags_required_to_hide_post": { "type": "integer", "example": 3, "description": "\"Number of flags that cause a post to be automatically hidden and message sent to the user (0 for never)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/cooldown_minutes_after_hiding_posts": { "put": { "description": "cooldown minutes after hiding posts\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "cooldown_minutes_after_hiding_posts" ], "properties": { "cooldown_minutes_after_hiding_posts": { "type": "integer", "example": 10, "description": "\"Number of minutes a user must wait before they can edit a post hidden via community flagging\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/num_spam_flags_to_block_new_user": { "put": { "description": "num spam flags to block new user\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "num_spam_flags_to_block_new_user" ], "properties": { "num_spam_flags_to_block_new_user": { "type": "integer", "example": 3, "description": "\"If a new user's posts get this many spam flags from num_users_to_block_new_user different users, hide all their posts and prevent future posting. 0 to disable.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/num_users_to_block_new_user": { "put": { "description": "num users to block new user\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "num_users_to_block_new_user" ], "properties": { "num_users_to_block_new_user": { "type": "integer", "example": 3, "description": "\"If a new user's posts get num_spam_flags_to_block_new_user spam flags from this many different users, hide all their posts and prevent future posting. 0 to disable.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/num_tl3_flags_to_block_new_user": { "put": { "description": "num tl3 flags to block new user\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "num_tl3_flags_to_block_new_user" ], "properties": { "num_tl3_flags_to_block_new_user": { "type": "integer", "example": 4, "description": "\"If a new user's posts get this many flags from num_tl3_users_to_block_new_user different trust level 3 users, hide all their posts and prevent future posting. 0 to disable.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/num_tl3_users_to_block_new_user": { "put": { "description": "num tl3 users to block new user\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "num_tl3_users_to_block_new_user" ], "properties": { "num_tl3_users_to_block_new_user": { "type": "integer", "example": 2, "description": "\"If a new user's posts get num_tl3_flags_to_block_new_user flags from this many different trust level 3 users, hide all their posts and prevent future posting. 0 to disable.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/notify_mods_when_user_blocked": { "put": { "description": "notify mods when user blocked\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "notify_mods_when_user_blocked" ], "properties": { "notify_mods_when_user_blocked": { "type": "boolean", "example": false, "description": "\"If a user is automatically blocked, send a message to all moderators.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/flag_sockpuppets": { "put": { "description": "flag sockpuppets\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "flag_sockpuppets" ], "properties": { "flag_sockpuppets": { "type": "boolean", "example": false, "description": "\"If a new user replies to a topic from the same IP address as the new user who started the topic, flag both of their posts as potential spam.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/newuser_spam_host_threshold": { "put": { "description": "newuser spam host threshold\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "newuser_spam_host_threshold" ], "properties": { "newuser_spam_host_threshold": { "type": "integer", "example": 3, "description": "\"How many times a new user can post a link to the same host within their `newuser_spam_host_threshold` posts before being considered spam.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/white_listed_spam_host_domains": { "put": { "description": "white listed spam host domains\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "white_listed_spam_host_domains" ], "properties": { "white_listed_spam_host_domains": { "type": "string", "example": "", "description": "\"A list of domains excluded from spam host testing. New users will never be restricted from creating posts with links to these domains.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/levenshtein_distance_spammer_emails": { "put": { "description": "levenshtein distance spammer emails\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "levenshtein_distance_spammer_emails" ], "properties": { "levenshtein_distance_spammer_emails": { "type": "integer", "example": 2, "description": "\"When matching spammer emails, number of characters difference that will still allow a fuzzy match.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_new_accounts_per_registration_ip": { "put": { "description": "max new accounts per registration ip\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_new_accounts_per_registration_ip" ], "properties": { "max_new_accounts_per_registration_ip": { "type": "integer", "example": 3, "description": "\"If there are already (n) trust level 0 accounts from this IP (and none is a staff member or at TL2 or higher), stop accepting new signups from that IP.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_ban_entries_for_roll_up": { "put": { "description": "min ban entries for roll up\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_ban_entries_for_roll_up" ], "properties": { "min_ban_entries_for_roll_up": { "type": "integer", "example": 5, "description": "\"When clicking the Roll up button, will create a new subnet ban entry if there are at least (N) entries.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_age_unmatched_emails": { "put": { "description": "max age unmatched emails\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_age_unmatched_emails" ], "properties": { "max_age_unmatched_emails": { "type": "integer", "example": 365, "description": "\"Delete unmatched screened email entries after (N) days.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_age_unmatched_ips": { "put": { "description": "max age unmatched ips\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_age_unmatched_ips" ], "properties": { "max_age_unmatched_ips": { "type": "integer", "example": 365, "description": "\"Delete unmatched screened IP entries after (N) days.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/num_flaggers_to_close_topic": { "put": { "description": "num flaggers to close topic\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "num_flaggers_to_close_topic" ], "properties": { "num_flaggers_to_close_topic": { "type": "integer", "example": 5, "description": "\"Minimum number of unique flaggers that is required to automatically pause a topic for intervention\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/num_flags_to_close_topic": { "put": { "description": "num flags to close topic\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "num_flags_to_close_topic" ], "properties": { "num_flags_to_close_topic": { "type": "integer", "example": 12, "description": "\"Minimum number of active flags that is required to automatically pause a topic for intervention\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/auto_respond_to_flag_actions": { "put": { "description": "auto respond to flag actions\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "auto_respond_to_flag_actions" ], "properties": { "auto_respond_to_flag_actions": { "type": "boolean", "example": true, "description": "\"Enable automatic reply when disposing a flag.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_first_post_typing_time": { "put": { "description": "min first post typing time\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_first_post_typing_time" ], "properties": { "min_first_post_typing_time": { "type": "integer", "example": 3000, "description": "\"Minimum amount of time in milliseconds a user must type during first post, if threshold is not met post will automatically enter the needs approval queue. Set to 0 to disable (not recommended)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/auto_block_fast_typers_on_first_post": { "put": { "description": "auto block fast typers on first post\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "auto_block_fast_typers_on_first_post" ], "properties": { "auto_block_fast_typers_on_first_post": { "type": "boolean", "example": true, "description": "\"Automatically block users that do not meet min_first_post_typing_time\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/auto_block_fast_typers_max_trust_level": { "put": { "description": "auto black fast typers max trust level\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "auto_block_fast_typers_max_trust_level" ], "properties": { "auto_block_fast_typers_max_trust_level": { "type": "integer", "example": 0, "description": "\"Maximum trust level to auto block fast typers\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/auto_block_first_post_regex": { "put": { "description": "auto block first post regex\n", "tags": [ "Site Settings Spam" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "auto_block_first_post_regex" ], "properties": { "auto_block_first_post_regex": { "type": "string", "example": "", "description": "\"Case insensitive regex that if passed will cause first post by user to be blocked and sent to approval queue. Example: raging|a[bc]a , will cause all posts containing raging or aba or aca to be blocked on first. Only applies to first post.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/unique_posts_min": { "put": { "description": "unique posts mins\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "unique_posts_min" ], "properties": { "unique_posts_min": { "type": "integer", "example": 5, "description": "\"How many minutes before a user can make a post with the same content again\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/rate_limit_create_topic": { "put": { "description": "rate limit create topic\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "rate_limit_create_topic" ], "properties": { "rate_limit_create_topic": { "type": "integer", "example": 16, "description": "\"After creating a topic, users must wait (n) seconds before creating another topic.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/rate_limit_create_post": { "put": { "description": "rate limit create post\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "rate_limit_create_post" ], "properties": { "rate_limit_create_post": { "type": "integer", "example": 5, "description": "\"After posting, users must wait (n) seconds before creating another post.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/rate_limit_new_user_create_topic": { "put": { "description": "rate limit new user create topic\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "rate_limit_new_user_create_topic" ], "properties": { "rate_limit_new_user_create_topic": { "type": "integer", "example": 120, "description": "\"After creating a topic, new users must wait (n) seconds before creating another topic.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/rate_limit_new_user_create_post": { "put": { "description": "rate limit new user create post\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "rate_limit_new_user_create_post" ], "properties": { "rate_limit_new_user_create_post": { "type": "integer", "example": 30, "description": "\"After posting, new users must wait (n) seconds before creating another post.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_topics_per_day": { "put": { "description": "max topics per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_topics_per_day" ], "properties": { "max_topics_per_day": { "type": "integer", "example": 20, "description": "\"Maximum number of topics a user can create per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_private_messages_per_day": { "put": { "description": "max private messages per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_private_messages_per_day" ], "properties": { "max_private_messages_per_day": { "type": "integer", "example": 20, "description": "\"Maximum number of messages users can create per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_likes_per_day": { "put": { "description": "max likes per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_likes_per_day" ], "properties": { "max_likes_per_day": { "type": "integer", "example": 50, "description": "\"Maximum number of likes per user per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_bookmarks_per_day": { "put": { "description": "max bookmarks per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_bookmarks_per_day" ], "properties": { "max_bookmarks_per_day": { "type": "integer", "example": 20, "description": "\"Maximum number of bookmarks per user per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_flags_per_day": { "put": { "description": "max flags per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_flags_per_day" ], "properties": { "max_flags_per_day": { "type": "integer", "example": 20, "description": "\"Maximum number of flags per user per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_edits_per_day": { "put": { "description": "max edits per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_edits_per_day" ], "properties": { "max_edits_per_day": { "type": "integer", "example": 30, "description": "\"Maximum number of edits per user per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_invites_per_day": { "put": { "description": "max invites per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_invites_per_day" ], "properties": { "max_invites_per_day": { "type": "integer", "example": 10, "description": "\"Maximum number of invites a user can send per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_topic_invitations_per_day": { "put": { "description": "max topic invitations per day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_topic_invitations_per_day" ], "properties": { "max_topic_invitations_per_day": { "type": "integer", "example": 30, "description": "\"Maximum number of topic invitations a user can send per day.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_topics_in_first_day": { "put": { "description": "max topics in first day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_topics_in_first_day" ], "properties": { "max_topics_in_first_day": { "type": "integer", "example": 3, "description": "\"The maximum number of topics a user is allowed to create in the 24 hour period after creating their first post\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_replies_in_first_day": { "put": { "description": "max replies in first day\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_replies_in_first_day" ], "properties": { "max_replies_in_first_day": { "type": "integer", "example": 10, "description": "\"The maximum number of replies a user is allowed to create in the 24 hour period after creating their first post\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl2_additional_likes_per_day_multiplier": { "put": { "description": "tl2 additional likes per day multiplier\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl2_additional_likes_per_day_multiplier" ], "properties": { "tl2_additional_likes_per_day_multiplier": { "type": "decimal", "example": 1.5, "description": "\"Increase limit of likes per day for tl2 (member) by multiplying with this number\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl3_additional_likes_per_day_multiplier": { "put": { "description": "tl3 additional likes per day multiplier\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl3_additional_likes_per_day_multiplier" ], "properties": { "tl3_additional_likes_per_day_multiplier": { "type": "decimal", "example": 2, "description": "\"Increase limit of likes per day for tl3 (regular) by multiplying with this number\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tl4_additional_likes_per_day_multiplier": { "put": { "description": "tl4 additional likes per day multiplier\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tl4_additional_likes_per_day_multiplier" ], "properties": { "tl4_additional_likes_per_day_multiplier": { "type": "decimal", "example": 3, "description": "\"Increase limit of likes per day for tl4 (leader) by multiplying with this number\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/alert_admins_if_errors_per_minute": { "put": { "description": "alert admins if errors per minute\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "alert_admins_if_errors_per_minute" ], "properties": { "alert_admins_if_errors_per_minute": { "type": "integer", "example": 0, "description": "\"Number of errors per minute in order to trigger an admin alert. A value of 0 disables this feature. NOTE: requires restart.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/alert_admins_if_errors_per_hour": { "put": { "description": "alert admins if errors per hour\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "alert_admins_if_errors_per_hour" ], "properties": { "alert_admins_if_errors_per_hour": { "type": "integer", "example": 0, "description": "\"Number of errors per hour in order to trigger an admin alert. A value of 0 disables this feature. NOTE: requires restart.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_prints_per_hour_per_user": { "put": { "description": "max prints per hour per user\n", "tags": [ "Site Settings Rate Limits" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_prints_per_hour_per_user" ], "properties": { "max_prints_per_hour_per_user": { "type": "integer", "example": 5, "description": "\"Maximum number of /print page impressions (set to 0 to disable)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/force_hostname": { "put": { "description": "force hostname\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "force_hostname" ], "properties": { "force_hostname": { "type": "string", "example": "", "description": "\"DEVELOPER ONLY! WARNING! Specify a hostname in the URL. Leave blank for default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/port": { "put": { "description": "port\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "port" ], "properties": { "port": { "type": "integer", "example": 3000, "description": "\"DEVELOPER ONLY! WARNING! Use this HTTP port rather than the default of port 80. Leave blank for default of 80.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/queue_jobs": { "put": { "description": "queue jobs\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "queue jobs" ], "properties": { "port": { "type": "boolean", "example": true, "description": "\"DEVELOPER ONLY! WARNING! By default, queue jobs in sidekiq. If disabled, your site will be broken.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_long_polling": { "put": { "description": "enable long polling\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_long_polling" ], "properties": { "enable_long_polling": { "type": "boolean", "example": true, "description": "\"Message bus used for notification can use long polling\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/long_polling_interval": { "put": { "description": "long polling interval\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "long_polling_interval" ], "properties": { "long_polling_interval": { "type": "integer", "example": true, "description": "\"Amount of time the server should wait before responding to clients when there is no data to send (logged on users only)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/long_polling_base_url": { "put": { "description": "long polling base url\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "long_polling_base_url" ], "properties": { "long_polling_base_url": { "type": "string", "example": "/", "description": "\"Base URL used for long polling (when a CDN is serving dynamic content, be sure to set this to origin pull) eg: http://origin.site.com\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/background_polling_interval": { "put": { "description": "background polling interval\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "background_polling_interval" ], "properties": { "background_polling_interval": { "type": "integer", "example": 60000, "description": "\"How often should the clients poll in milliseconds (when the window is in the background)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/polling_interval": { "put": { "description": "polling interval\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "polling_interval" ], "properties": { "polling_interval": { "type": "integer", "example": 3000, "description": "\"When not long polling, how often should logged on clients poll in milliseconds\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/anon_polling_interval": { "put": { "description": "anon polling interval\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "anon_polling_interval" ], "properties": { "anon_polling_interval": { "type": "integer", "example": 15000, "description": "\"How often should anonymous clients poll in milliseconds\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/flush_timings_secs": { "put": { "description": "flush timings secs\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "flush_timings_secs" ], "properties": { "flush_timings_secs": { "type": "integer", "example": 20, "description": "\"How frequently we flush timing data to the server, in seconds.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/active_user_rate_limit_secs": { "put": { "description": "active user rate limit secs\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "active_user_rate_limit_secs" ], "properties": { "active_user_rate_limit_secs": { "type": "integer", "example": 60, "description": "\"How frequently we update the 'last_seen_at' field, in seconds\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/verbose_localization": { "put": { "description": "verbose localization\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "verbose_localization" ], "properties": { "verbose_localization": { "type": "boolean", "example": false, "description": "\"Show extended localization tips in the UI\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/top_topics_formula_log_views_multiplier": { "put": { "description": "top topics formula log views multiplier\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "top_topics_formula_log_views_multiplier" ], "properties": { "top_topics_formula_log_views_multiplier": { "type": "decimal", "example": 2, "description": "\"value of log views multiplier (n) in top topics formula: `log(views_count) * (n) + op_likes_count * 0.5 + LEAST(likes_count / posts_count, 3) + 10 + log(posts_count)`\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/top_topics_formula_first_post_likes_multiplier": { "put": { "description": "top topics formula first post likes multiplier\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "top_topics_formula_first_post_likes_multiplier" ], "properties": { "top_topics_formula_first_post_likes_multiplier": { "type": "decimal", "example": 0.5, "description": "\"value of first post likes multiplier (n) in top topics formula: `log(views_count) * 2 + op_likes_count * (n) + LEAST(likes_count / posts_count, 3) + 10 + log(posts_count)`\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/rebake_old_posts_count": { "put": { "description": "rebake old posts count\n", "tags": [ "Site Settings Developer" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "rebake_old_posts_count" ], "properties": { "rebake_old_posts_count": { "type": "integer", "example": 250, "description": "\"Number of old posts to be rebaked every 15 minutes.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tos_url": { "put": { "description": "tos url\n", "tags": [ "Site Settings Legal" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tos_url" ], "properties": { "tos_url": { "type": "string", "example": "", "description": "\"If you have a Terms of Service document hosted elsewhere that you want to use, provide the full URL here.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/privacy_policy_url": { "put": { "description": "privacy policy url\n", "tags": [ "Site Settings Legal" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "privacy_policy_url" ], "properties": { "privacy_policy_url": { "type": "string", "example": "", "description": "\"If you have a Privacy Policy document hosted elsewhere that you want to use, provide the full URL here.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/fag_url": { "put": { "description": "faq url\n", "tags": [ "Site Settings Legal" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "faq_url" ], "properties": { "faq_url": { "type": "string", "example": "", "description": "\"If you have a FAQ hosted elsewhere that you want to use, provide the full URL here.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/readonly_mode_during_backup": { "put": { "description": "readonly_mode_during_backup\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "readonly_mode_during_backup" ], "properties": { "readonly_mode_during_backup": { "type": "boolean", "example": true, "description": "\"Enable read only mode while taking a backup\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_restore": { "put": { "description": "allow_restore\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_restore" ], "properties": { "allow_restore": { "type": "boolean", "example": false, "description": "\"Allow restore, which can replace ALL site data! Leave false unless you plan to restore a backup\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/maximum_backups": { "put": { "description": "maximum backups\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "maximum_backups" ], "properties": { "maximum_backups": { "type": "integer", "example": 5, "description": "\"The maximum amount of backups to keep on disk. Older backups are automatically deleted\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/automatic_backups_enabled": { "put": { "description": "automatic backups enabled\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "automatic_backups_enabled" ], "properties": { "automatic_backups_enabled": { "type": "boolean", "example": true, "description": "\"Run automatic backups as defined in backup frequency\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/backup_frequency": { "put": { "description": "backup frequency\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "backup_frequency" ], "properties": { "backup_frequency": { "type": "integer", "example": 7, "description": "\"How frequently we create a site backup, in days.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/enable_s3_backups": { "put": { "description": "enable s3 backups\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "enable_s3_backups" ], "properties": { "enable_s3_backups": { "type": "boolean", "example": false, "description": "\"Upload backups to S3 when complete. IMPORTANT: requires valid S3 credentials entered in Files settings.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_backup_bucket": { "put": { "description": "s3 backup bucket\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_backup_bucket" ], "properties": { "s3_backup_bucket": { "type": "string", "example": "", "description": "\"The remote bucket to hold backups. WARNING: Make sure it is a private bucket.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/s3_disable_cleanup": { "put": { "description": "s3 disable cleanup\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "s3_disable_cleanup" ], "properties": { "s3_disable_cleanup": { "type": "boolean", "example": false, "description": "\"Disable the removal of backups from S3 when removed locally.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/backup_time_of_day": { "put": { "description": "backup time of day\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "backup_time_of_day" ], "properties": { "backup_time_of_day": { "type": "string", "example": "3:30", "description": "\"Time of day UTC when the backup should occur.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/backup_with_uploads": { "put": { "description": "backup with uploads\n", "tags": [ "Site Settings Backups" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "backup_with_uploads" ], "properties": { "backup_with_uploads": { "type": "boolean", "example": true, "description": "\"Include uploads in scheduled backups. Disabling this will only backup the database.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_search_term_length": { "put": { "description": "min search term length\n", "tags": [ "Site Settings Search" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_search_term_length" ], "properties": { "min_search_term_length": { "type": "integer", "example": 3, "description": "\"Minimum valid search term length in characters\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/search_tokenize_chinese_japanese_korean": { "put": { "description": "search tokenize chinese japanese korean\n", "tags": [ "Site Settings Search" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "search_tokenize_chinese_japanese_korean" ], "properties": { "search_tokenize_chinese_japanese_korean": { "type": "boolean", "example": false, "description": "\"Force search to tokenize Chinese/Japanese/Korean even on non CJK sites\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/search_prefer_recent_posts": { "put": { "description": "search prefer recent posts\n", "tags": [ "Site Settings Search" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "search_prefer_recent_posts" ], "properties": { "search_prefer_recent_posts": { "type": "boolean", "example": false, "description": "\"If searching your large forum is slow, this option tries an index of more recent posts first\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/search_recent_posts_size": { "put": { "description": "search recent posts size\n", "tags": [ "Site Settings Search" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "search_recent_posts_size" ], "properties": { "search_recent_posts_size": { "type": "integer", "example": 100000, "description": "\"How many recent posts to keep in the index\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/version_checks": { "put": { "description": "version checks\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "version_checks" ], "properties": { "version_checks": { "type": "boolean", "example": true, "description": "\"Ping the Discourse Hub for version updates and show new version messages on the /admin dashboard\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/new_version_emails": { "put": { "description": "new version emails\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "new_version_emails" ], "properties": { "new_version_emails": { "type": "boolean", "example": true, "description": "\"Send an email to the contact_email address when a new version of Discourse is available.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/send_welcome_message": { "put": { "description": "send welcome message\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "send_welcome_message" ], "properties": { "send_welcome_message": { "type": "boolean", "example": true, "description": "\"Send all new users a welcome message with a quick start guide.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/suppress_uncategorized_badge": { "put": { "description": "suppress uncategorized badge\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "suppress_uncategorized_badge" ], "properties": { "suppress_uncategorized_badge": { "type": "boolean", "example": true, "description": "\"Don't show the badge for uncategorized topics in topic lists.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/slug_generation_method": { "put": { "description": "slug generation method\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "slug_generation_method" ], "properties": { "slug_generation_method": { "type": "string", "enum": [ "ascii", "enocded", "none" ], "example": "ascii", "description": "\"Choose a slug generation method. 'encoded' will generate percent encoding string. 'none' will disable slug at all.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/permalink_normalizations": { "put": { "description": "permalink normalizations\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "permalink_normalizations" ], "properties": { "permalink_normalizations": { "type": "string", "example": "", "description": "\"Apply the following regex before matching permalinks, for example: /(topic.*)\\?.*/\\1 will strip query strings from topic routes. Format is regex+string use \\1 etc. to access captures\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_similar_results": { "put": { "description": "max similar results\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_similar_results" ], "properties": { "max_similar_results": { "type": "integer", "example": 5, "description": "\"How many similar topics to show above the editor when composing a new topic. Comparison is based on title and body.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/minimum_topics_similar": { "put": { "description": "minimum topics similar\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "minimum_topics_similar" ], "properties": { "minimum_topics_similar": { "type": "integer", "example": 50, "description": "\"How many topics need to exist before similar topics are presented when composing new topics.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/previous_visit_timeout_hours": { "put": { "description": "previous visit timeout hours\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "previous_visit_timeout_hours" ], "properties": { "previous_visit_timeout_hours": { "type": "integer", "example": 1, "description": "\"How long a visit lasts before we consider it the 'previous' visit, in hours\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/staff_like_weight": { "put": { "description": "staff like weight\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "staff_like_weight" ], "properties": { "staff_like_weight": { "type": "integer", "example": 3, "description": "\"How much extra weighting factor to give staff likes.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_view_duration_hours": { "put": { "description": "topic view duration hours\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_view_duration_hours" ], "properties": { "topic_view_duration_hours": { "type": "integer", "example": 8, "description": "\"Count a new topic view once per IP/User every N hours\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/user_profile_view_duration_hours": { "put": { "description": "user profile view duration hours\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "user_profile_view_duration_hours" ], "properties": { "user_profile_view_duration_hours": { "type": "integer", "example": 8, "description": "\"Count a new user profile view once per IP/User every N hours\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/summary_score_threshold": { "put": { "description": "summary score threshold\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "summary_score_threshold" ], "properties": { "summary_score_threshold": { "type": "integer", "example": 15, "description": "\"The minimum score required for a post to be included in 'Summarize This Topic'\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/summary_posts_required": { "put": { "description": "summary posts required\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "summary_posts_required" ], "properties": { "summary_posts_required": { "type": "integer", "example": 50, "description": "\"Minimum posts in a topic before 'Summarize This Topic' is enabled\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/summary_likes_required": { "put": { "description": "summary likes required\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "summary_likes_required" ], "properties": { "summary_likes_required": { "type": "integer", "example": 1, "description": "\"Minimum likes in a topic before 'Summarize This Topic' is enabled\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/summary_percent_filter": { "put": { "description": "summary percent filter\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "summary_percent_filter" ], "properties": { "summary_percent_filter": { "type": "integer", "example": 20, "description": "\"When a user clicks 'Summarize This Topic', show the top % of posts\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/summary_max_results": { "put": { "description": "summary max results\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "summary_max_results" ], "properties": { "summary_max_results": { "type": "integer", "example": 100, "description": "\"Maximum posts returned by 'Summary This Topic'\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_views_heat_low": { "put": { "description": "topic views heat low\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_view_heat_low" ], "properties": { "topic_view_heat_low": { "type": "integer", "example": 1000, "description": "\"After this many views, the views field is slightly highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_views_heat_medium": { "put": { "description": "topic views heat medium\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_views_heat_medium" ], "properties": { "topic_views_heat_medium": { "type": "integer", "example": 2000, "description": "\"After this many views, the views field is moderately highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_views_heat_high": { "put": { "description": "topic views heat high\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_views_heat_high" ], "properties": { "topic_views_heat_high": { "type": "integer", "example": 5000, "description": "\"After this many views, the views field is strongly highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_post_like_heat_low": { "put": { "description": "topic post like heat low\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_post_like_heat_low" ], "properties": { "topic_post_like_heat_low": { "type": "decimal", "example": 0.5, "description": "\"After the likes:post ratio exceeds this ratio, the post count field is slightly highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_post_like_heat_medium": { "put": { "description": "topic post like heat medium\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_post_like_heat_medium" ], "properties": { "topic_post_like_heat_medium": { "type": "decimal", "example": 1, "description": "\"After the likes:post ratio exceeds this ratio, the post count field is moderately highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_post_like_heat_high": { "put": { "description": "topic post like heat high\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_post_like_heat_high" ], "properties": { "topic_post_like_heat_high": { "type": "decimal", "example": 2, "description": "\"After the likes:post ratio exceeds this ratio, the post count field is strongly highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/history_hours_low": { "put": { "description": "history hours low\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "history_hours_low" ], "properties": { "history_hours_low": { "type": "integer", "example": 12, "description": "\"A post edited within this many hours has the edit indicator slightly highlighted\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/history_hours_medium": { "put": { "description": "history hours medium\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "history_hours_medium" ], "properties": { "history_hours_medium": { "type": "integer", "example": 24, "description": "\"A post edited within this many hours has the edit indicator moderately highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/history_hours_high": { "put": { "description": "history hours high\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "history_hours_high" ], "properties": { "history_hours_high": { "type": "integer", "example": 48, "description": "\"A post edited within this many hours has the edit indicator strongly highlighted.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/cold_age_days_low": { "put": { "description": "cold age days low\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "cold_age_days_low" ], "properties": { "cold_age_days_low": { "type": "integer", "example": 14, "description": "\"After this many days of conversation, the last activity date is slightly dimmed.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/cold_age_days_medium": { "put": { "description": "cold age days medium\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "cold_age_days_medium" ], "properties": { "cold_age_days_medium": { "type": "integer", "example": 90, "description": "\"After this many days of conversation, the last activity date is moderately dimmed.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/cold_age_days_high": { "put": { "description": "cold age days high\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "cold_age_days_high" ], "properties": { "cold_age_days_high": { "type": "integer", "example": 180, "description": "\"After this many days of conversation, the last activity date is strongly dimmed.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/educate_until_posts": { "put": { "description": "educate until posts\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "educate_until_posts" ], "properties": { "educate_until_posts": { "type": "integer", "example": 2, "description": "\"When the user starts typing their first (n) new posts, show the pop-up new user education panel in the composer.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/sequential_replies_threshold": { "put": { "description": "sequential replies threshold\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "sequential_replies_threshold" ], "properties": { "sequential_replies_threshold": { "type": "integer", "example": 2, "description": "\"Number of posts a user has to make in a row in a topic before being reminded about too many sequential replies.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/dominating_topic_minimum_percent": { "put": { "description": "dominating topic minimum percent\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "dominating_topic_minimum_percent" ], "properties": { "dominating_topic_minimum_percent": { "type": "integer", "example": 20, "description": "\"What percentage of posts a user has to make in a topic before being reminded about overly dominating a topic.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/disable_avatar_education_message": { "put": { "description": "disable avatar education message\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "disable_avatar_education_message" ], "properties": { "disable_avatar_education_message": { "type": "boolean", "example": false, "description": "\"Disable education message for changing avatar.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/global_notice": { "put": { "description": "global notice\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "global_notice" ], "properties": { "global_notice": { "type": "string", "example": "", "description": "\"Display an URGENT, EMERGENCY global banner notice to all visitors, change to blank to hide it (HTML allowed).\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/notify_about_flags_after": { "put": { "description": "notify about flags after\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "notify_about_flags_after" ], "properties": { "notify_about_flags_after": { "type": "integer", "example": 48, "description": "\"If there are flags that haven't been handled after this many hours, send an email to the contact_email. Set to 0 to disable.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_create_topics_notice": { "put": { "description": "show create topics notice\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_create_topics_notice" ], "properties": { "show_create_topics_notice": { "type": "boolean", "example": true, "description": "\"If the site has fewer than 5 public topics, show a notice asking admins to create some topics.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/disable_edit_notifications": { "put": { "description": "disable edit notifications\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "disable_edit_notifications" ], "properties": { "disable_edit_notifications": { "type": "boolean", "example": false, "description": "\"Disables edit notifications by the system user when 'download_remote_images_to_local' is active.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/vacuum_db_days": { "put": { "description": "vacuum db days\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "vacuum_db_days" ], "properties": { "vacuum_db_days": { "type": "integer", "example": 90, "description": "\"Run VACUUM ANALYZE to reclaim DB space after migrations (set to 0 to disable)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/delete_drafts_older_than_n_days": { "put": { "description": "delete drafts older than n days\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "delete_drafts_older_than_n_days" ], "properties": { "delete_drafts_older_than_n_days": { "type": "integer", "example": 180, "description": "\"Delete drafts older than (n) days.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/bootstrap_mode_min_users": { "put": { "description": "bootstrap mode min users\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "bootstrap_mode_min_users" ], "properties": { "bootstrap_mode_min_users": { "type": "integer", "example": 50, "description": "\"Minimum number of users required to disable bootstrap mode (set to 0 to disable)\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/automatically_unpin_topics": { "put": { "description": "automatically unpin topics\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "automatically_unpin_topics" ], "properties": { "automatically_unpin_topics": { "type": "boolean", "example": true, "description": "\"Automatically unpin topics when the user reaches the bottom.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/read_time_word_count": { "put": { "description": "read time word count\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "read_time_word_count" ], "properties": { "read_time_word_count": { "type": "integer", "example": 500, "description": "\"Word count per minute for calculating estimated reading time.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/topic_page_title_includes_category": { "put": { "description": "topic page title includes category\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "topic_page_title_includes_category" ], "properties": { "topic_page_title_includes_category": { "type": "boolean", "example": true, "description": "\"Topic page title includes the category name.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/native_app_install_banner": { "put": { "description": "\"native app install banner\"\n", "tags": [ "Site Settings Other" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "native_app_install_banner" ], "properties": { "native_app_install_banner": { "type": "boolean", "example": false, "description": "\"Asks recurring visitors to install Discourse native app.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_digest_frequency": { "put": { "description": "\"default email digest frequency\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_digest_frequency" ], "properties": { "default_email_digest_frequency": { "type": "integer", "example": 0, "description": "\"How often users receive summary emails by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_include_tl0_in_digests": { "put": { "description": "\"default include tl0 in digests\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_include_tl0_in_digests" ], "properties": { "default_include_tl0_in_digests": { "type": "boolean", "example": false, "description": "\"Include posts from new users in summary emails by default. Users can change this in their preferences.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_private_messages": { "put": { "description": "\"default email private messages\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_private_messages" ], "properties": { "default_email_private_messages": { "type": "boolean", "example": true, "description": "\"Send an email when someone messages the user by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_direct": { "put": { "description": "\"default email direct\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_direct" ], "properties": { "default_email_direct": { "type": "boolean", "example": true, "description": "\"Send an email when someone quotes/replies to/mentions or invites the user by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_mailing_list_mode": { "put": { "description": "\"default email mailing list mode\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_mailing_list_mode" ], "properties": { "default_email_mailing_list_mode": { "type": "boolean", "example": false, "description": "\"Send an email for every new post by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_mailing_list_mode_frequency": { "put": { "description": "\"default email mailing list mode frequency\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_mailing_list_mode_frequency" ], "properties": { "default_email_mailing_list_mode_frequency": { "type": "integer", "enum": [ 0, 1, 2 ], "example": 0, "description": "\"Users who enable mailing list mode will receive emails this often by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/disable_mailing_list_mode": { "put": { "description": "\"disable mailing list mode\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "disable_mailing_list_mode" ], "properties": { "disable_mailing_list_mode": { "type": "boolean", "example": false, "description": "\"Disallow users from enabling mailing list mode.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_always": { "put": { "description": "\"default email always\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_always" ], "properties": { "default_email_always": { "type": "boolean", "example": false, "description": "\"Send an email notification even when the user is active by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_previous_replies": { "put": { "description": "\"default email previous replies\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_previous_replies" ], "properties": { "default_email_previous_replies": { "type": "integer", "example": 2, "description": "\"Include previous replies in emails by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_email_in_reply_to": { "put": { "description": "\"default email in reply to\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_email_in_reply_to" ], "properties": { "default_email_in_reply_to": { "type": "boolean", "example": true, "description": "\"Include excerpt of replied to post in emails by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_new_topic_duration_minutes": { "put": { "description": "\"default other new topic duration minutes\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_new_topic_duration_minutes" ], "properties": { "default_other_new_topic_duration_minutes": { "type": "integer", "example": 2880, "description": "\"Global default condition for which a topic is considered new.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_auto_track_topic_after_msecs": { "put": { "description": "\"default other auto track topics after msecs\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_auto_track_topic_after_msecs" ], "properties": { "default_other_auto_track_topic_after_msecs": { "type": "integer", "example": 240000, "description": "\"Global default time before a topic is automatically tracked.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_notification_level_when_replying": { "put": { "description": "\"default other notification level when replying\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_notification_level_when_replying" ], "properties": { "default_other_notification_level_when_replying": { "type": "integer", "example": 2, "description": "\"Global default notification level when the user replies to a topic.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_external_links_in_new_tab": { "put": { "description": "\"default other external links in new tab\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_external_links_in_new_tab" ], "properties": { "default_other_external_links_in_new_tab": { "type": "boolean", "example": false, "description": "\"Open external links in a new tab by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_enable_quoting": { "put": { "description": "\"default other enable quoting\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_enable_quoting" ], "properties": { "default_other_enable_quoting": { "type": "boolean", "example": true, "description": "\"Enable quote reply for highlighted text by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_dynamic_favicon": { "put": { "description": "default other dynamic favicon\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_dynamic_favicon" ], "properties": { "default_other_dynamic_favicon": { "type": "boolean", "example": false, "description": "\"Show new/updated topic count on browser icon by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_disable_jump_reply": { "put": { "description": "\"default other disable jump reply\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_disable_jump_reply" ], "properties": { "default_other_disable_jump_reply": { "type": "boolean", "example": false, "description": "\"Don't jump to user's post after they reply by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_other_like_notification_frequency": { "put": { "description": "\"default other like notification frequency\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_other_like_notification_frequency" ], "properties": { "default_other_like_notification_frequency": { "type": "integer", "example": 1, "description": "\"Notify users on likes by default\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_topics_automatic_unpin": { "put": { "description": "\"default topics automatic unpin\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_topics_automatic_unpin" ], "properties": { "default_topics_automatic_unpin": { "type": "boolean", "example": true, "description": "\"Automatically unpin topics when the user reaches the bottom by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_categories_watching": { "description": "\"default categories watching\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_categories_watching" ], "properties": { "default_categories_watching": { "type": "string", "example": "4|1", "description": "\"Pipe delimited category id's. List of categories that are watched by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } }, "/admin/site_settings/default_categories_tracking": { "put": { "description": "\"default categories tracking\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_categories_tracking" ], "properties": { "default_categories_tracking": { "type": "string", "example": "", "description": "\"Pipe delimited category id's. List of categories that are tracked by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_categories_muted": { "put": { "description": "\"default categories muted\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_categories_muted" ], "properties": { "default_categories_muted": { "type": "string", "example": "", "description": "\"Pipe delimited category id's. List of categories that are muted by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/default_categories_watching_first_post": { "put": { "description": "\"default categories watching first post\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "default_categories_watching_first_post" ], "properties": { "default_categories_watching_first_post": { "type": "string", "example": "", "description": "\"Pipe delimited category id's. List of categories in which first post in each new topic will be watched by default.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_user_api_reqs_per_day": { "put": { "description": "\"max user api reqs per day\"\n", "tags": [ "Site Settings User API" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_user_api_reqs_per_day" ], "properties": { "max_user_api_reqs_per_day": { "type": "integer", "example": 2880, "description": "\"Maximum number of user API requests per key per day\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_user_api_reqs_per_minute": { "put": { "description": "\"max user api reqs per minute\"\n", "tags": [ "Site Settings User API" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_user_api_reqs_per_minute" ], "properties": { "max_user_api_reqs_per_minute": { "type": "integer", "example": 20, "description": "\"Maximum number of user API requests per key per minute\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_user_api_keys": { "put": { "description": "\"allow user api keys\"\n", "tags": [ "Site Settings User API" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_user_api_keys" ], "properties": { "allow_user_api_keys": { "type": "boolean", "example": true, "description": "\"Allow generation of user API keys\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allow_user_api_key_scopes": { "put": { "description": "\"allow user api key scopes\"\n", "tags": [ "Site Settings User API" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allow_user_api_key_scopes" ], "properties": { "allow_user_api_key_scopes": { "type": "string", "example": "read|write|message_bus|push|notifications|session_info", "description": "\"List of scopes allowed for user API keys\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_api_keys_per_user": { "put": { "description": "\"max api keys per user\"\n", "tags": [ "Site Settings User Preferences" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_api_keys_per_user" ], "properties": { "max_api_keys_per_user": { "type": "integer", "example": 10, "description": "\"Maximum number of user API keys per user\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_level_for_user_api_key": { "put": { "description": "\"min trust level for user api key\"\n", "tags": [ "Site Settings User API" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_level_for_user_api_key" ], "properties": { "min_trust_level_for_user_api_key": { "type": "integer", "example": 1, "description": "\"Trust level required for generation of user API keys\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allowed_user_api_push_urls": { "put": { "description": "\"allowed user api push urls\"\n", "tags": [ "Site Settings User API" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allowed_user_api_push_urls" ], "properties": { "allowed_user_api_push_urls": { "type": "string", "example": "", "description": "\"Allowed URLs for server push to user API\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/allowed_user_api_auth_redirects": { "put": { "description": "\"allowed user api auth redirects\"\n", "tags": [ "Site Settings User API" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "allowed_user_api_auth_redirects" ], "properties": { "allowed_user_api_auth_redirects": { "type": "string", "example": "https://api.discourse.org/api/auth_redirect|discourse://auth_redirect", "description": "\"Allowed URL for authentication redirect for user API keys\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tagging_enabled": { "put": { "description": "\"tagging enabled\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tagging_enabled" ], "properties": { "tagging_enabled": { "type": "boolean", "example": false, "description": "\"Enable tags on topics?\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tag_style": { "put": { "description": "\"tag style\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tag_style" ], "properties": { "tag_style": { "type": "string", "enum": [ "simple", "bullet", "box" ], "example": "simple", "description": "\"Visual style for tag badges.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_tags_per_topic": { "put": { "description": "\"max tags per topic\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_tags_per_topic" ], "properties": { "max_tags_per_topic": { "type": "integer", "example": 5, "description": "\"The maximum tags that can be applied to a topic.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_tag_length": { "put": { "description": "\"max tag length\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_tag_length" ], "properties": { "max_tag_length": { "type": "integer", "example": 20, "description": "\"The maximum amount of characters that can be used in a tag.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_to_create_tag": { "put": { "description": "\"min trust to create tag\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_to_create_tag" ], "properties": { "tagging_enabled": { "type": "integer", "enum": [ 0, 1, 2, 3, 4 ], "example": 3, "description": "\"The minimum trust level required to create a tag.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/min_trust_level_to_tag_topics": { "put": { "description": "\"min trust level to tag topics\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "min_trust_level_to_tag_topics" ], "properties": { "min_trust_level_to_tag_topics": { "type": "integer", "enum": [ 0, 1, 2, 3, 4 ], "example": 0, "description": "\"Minimum trust level required to tag topics\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_tag_search_results": { "put": { "description": "\"max_tag_search_results\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_tag_search_results" ], "properties": { "max_tag_search_results": { "type": "integer", "example": 5, "description": "\"When searching for tags, the maximum number of results to show.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/show_filter_by_tag": { "put": { "description": "\"show filter by tag\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "show_filter_by_tag" ], "properties": { "show_filter_by_tag": { "type": "boolean", "example": false, "description": "\"Show a dropdown to filter a topic list by tag.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/max_tags_in_filter_list": { "put": { "description": "\"max tags in filter list\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "max_tags_in_filter_list" ], "properties": { "max_tags_in_filter_list": { "type": "integer", "example": 30, "description": "\"Maximum number of tags to show in the filter dropdown. The most used tags will be shown.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/tags_sort_alphabetically": { "put": { "description": "\"tags sort alphabetically\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "tags_sort_alphabetically" ], "properties": { "tags_sort_alphabetically": { "type": "boolean", "example": false, "description": "\"Show tags in alphabetical order. Default is to show in order of popularity.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/staff_tags": { "put": { "description": "\"staff tags\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "staff_tags" ], "properties": { "staff_tags": { "type": "string", "example": "", "description": "\"A list of tags that can only be applied by staff members\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/suppress_overlapping_tags_in_list": { "put": { "description": "\"suppress overlapping tags in list\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "suppress_overlapping_tags_in_list" ], "properties": { "suppress_overlapping_tags_in_list": { "type": "boolean", "example": false, "description": "\"If tags match exact words in topic titles, don't show the tag\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/remove_muted_tags_from_latest": { "put": { "description": "\"remove muted tags from latest\"\n", "tags": [ "Site Settings Tags" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "remove_muted_tags_from_latest" ], "properties": { "remove_muted_tags_from_latest": { "type": "boolean", "example": false, "description": "\"Don't show topics tagged with muted tags in the latest topic list.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/details_enabled": { "put": { "description": "\"details enabled\"\n", "tags": [ "Site Settings Plugins" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "details_enabled" ], "properties": { "details_enabled": { "type": "boolean", "example": true, "description": "'Enable the details plugin. If you change this, you must rebake all posts with: \"rake posts:rebake\".'\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/daily_performance_report": { "put": { "description": "\"daily performance report\"\n", "tags": [ "Site Settings Plugins" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "daily_performance_report" ], "properties": { "daily_performance_report": { "type": "boolean", "example": false, "description": "\"Analyze NGINX logs daily and post a Staff Only topic with details\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/poll_enabled": { "put": { "description": "\"poll enabled\"\n", "tags": [ "Site Settings Plugins" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "poll_enabled" ], "properties": { "poll_enabled": { "type": "boolean", "example": true, "description": "\"Allow users to create polls?\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/poll_maximum_options": { "put": { "description": "\"poll maximum options\"\n", "tags": [ "Site Settings Plugins" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "poll_maximum_options" ], "properties": { "poll_maximum_options": { "type": "integer", "example": 20, "description": "\"Maximum number of options allowed in a poll.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } }, "/admin/site_settings/poll_edit_window_mins": { "put": { "description": "\"poll edit window mins\"\n", "tags": [ "Site Settings Plugins" ], "parameters": [ { "name": "body", "in": "body", "schema": { "type": "object", "required": [ "poll_edit_window_mins" ], "properties": { "poll_edit_window_mins": { "type": "integer", "example": 5, "description": "\"Number of minutes after post creation during which polls can be edited.\"\n" } } } } ], "responses": { "200": { "description": "empty response body\n" } } } } } }