SiteGetBasicInfoResponse
{
"required": [
"logo_url",
"logo_small_url",
"apple_touch_icon_url",
"favicon_url",
"title",
"description",
"header_primary_color",
"header_background_color",
"login_required",
"mobile_logo_url"
],
"properties": {
"title": {
"type": "string"
},
"logo_url": {
"type": "string"
},
"description": {
"type": "string"
},
"favicon_url": {
"type": "string"
},
"login_required": {
"type": "boolean"
},
"logo_small_url": {
"type": "string"
},
"mobile_logo_url": {
"type": "string"
},
"apple_touch_icon_url": {
"type": "string"
},
"header_primary_color": {
"type": "string"
},
"header_background_color": {
"type": "string"
}
},
"additionalProperties": false
}
SiteGetCategoriesAndSubcategoriesResponse
{
"required": [
"default_archetype",
"notification_types",
"post_types",
"trust_levels",
"groups",
"filters",
"periods",
"top_menu_items",
"anonymous_top_menu_items",
"uncategorized_category_id",
"user_field_max_length",
"post_action_types",
"topic_flag_types",
"can_create_tag",
"can_tag_topics",
"can_tag_pms",
"tags_filter_regexp",
"top_tags",
"topic_featured_link_allowed_category_ids",
"user_themes",
"user_color_schemes",
"default_dark_color_scheme",
"censored_regexp",
"custom_emoji_translation",
"watched_words_replace",
"watched_words_link",
"categories",
"archetypes",
"user_fields",
"auth_providers"
],
"properties": {
"groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"flair_url",
"flair_bg_color",
"flair_color"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
}
}
}
},
"filters": {
"type": "array",
"items": {}
},
"periods": {
"type": "array",
"items": {}
},
"top_tags": {
"type": "array",
"items": {}
},
"user_tips": {
"type": "object",
"required": [
"first_notification",
"topic_timeline",
"post_menu",
"topic_notification_levels",
"suggested_topics",
"admin_guide"
],
"properties": {
"post_menu": {
"type": "integer"
},
"admin_guide": {
"type": "integer"
},
"topic_timeline": {
"type": "integer"
},
"suggested_topics": {
"type": "integer"
},
"first_notification": {
"type": "integer"
},
"topic_notification_levels": {
"type": "integer"
}
}
},
"archetypes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"options"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {}
}
}
}
},
"categories": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"topic_template",
"has_children",
"sort_order",
"sort_ascending",
"show_subcategory_list",
"num_featured_topics",
"default_view",
"subcategory_list_style",
"default_top_period",
"default_list_filter",
"minimum_required_tags",
"navigate_to_first_post_after_read",
"allowed_tags",
"allowed_tag_groups",
"allow_global_tags",
"required_tag_groups",
"read_only_banner",
"uploaded_logo",
"uploaded_logo_dark",
"uploaded_background",
"uploaded_background_dark",
"can_edit"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"color": {
"type": "string"
},
"can_edit": {
"type": "boolean"
},
"position": {
"type": "integer"
},
"topic_url": {
"type": "string"
},
"permission": {
"type": "integer"
},
"post_count": {
"type": "integer"
},
"sort_order": {
"type": [
"string",
"null"
]
},
"text_color": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"topic_count": {
"type": "integer"
},
"allowed_tags": {
"type": "array",
"items": {}
},
"default_view": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": "boolean"
},
"custom_fields": {
"type": [
"object",
"null"
],
"additionalProperties": true
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"topic_template": {
"type": [
"string",
"null"
]
},
"read_restricted": {
"type": "boolean"
},
"description_text": {
"type": [
"string",
"null"
]
},
"read_only_banner": {
"type": [
"string",
"null"
]
},
"allow_global_tags": {
"type": "boolean"
},
"form_template_ids": {
"type": "array",
"items": {}
},
"allowed_tag_groups": {
"type": "array",
"items": {}
},
"default_top_period": {
"type": "string"
},
"notification_level": {
"type": "integer"
},
"parent_category_id": {
"type": "integer"
},
"uploaded_logo_dark": {
"type": [
"string",
"null"
]
},
"default_list_filter": {
"type": "string"
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"num_featured_topics": {
"type": "integer"
},
"required_tag_groups": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"min_count"
],
"properties": {
"name": {
"type": "string"
},
"min_count": {
"type": "integer"
}
}
}
},
"uploaded_background": {
"type": [
"string",
"null"
]
},
"minimum_required_tags": {
"type": "integer"
},
"show_subcategory_list": {
"type": "boolean"
},
"subcategory_list_style": {
"type": "string"
},
"uploaded_background_dark": {
"type": [
"string",
"null"
]
},
"navigate_to_first_post_after_read": {
"type": "boolean"
}
}
}
},
"post_types": {
"type": "object",
"required": [
"regular",
"moderator_action",
"small_action",
"whisper"
],
"properties": {
"regular": {
"type": "integer"
},
"whisper": {
"type": "integer"
},
"small_action": {
"type": "integer"
},
"moderator_action": {
"type": "integer"
}
}
},
"can_tag_pms": {
"type": "boolean"
},
"user_fields": {
"type": "array",
"items": {}
},
"user_themes": {
"type": "array",
"items": {
"type": "object",
"required": [
"theme_id",
"name",
"default",
"color_scheme_id"
],
"properties": {
"name": {
"type": "string"
},
"default": {
"type": "boolean"
},
"theme_id": {
"type": "integer"
},
"color_scheme_id": {
"type": [
"integer",
"null"
]
}
}
}
},
"trust_levels": {
"type": "object",
"required": [
"newuser",
"basic",
"member",
"regular",
"leader"
],
"properties": {
"basic": {
"type": "integer"
},
"leader": {
"type": "integer"
},
"member": {
"type": "integer"
},
"newuser": {
"type": "integer"
},
"regular": {
"type": "integer"
}
}
},
"denied_emojis": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"hashtag_icons": {
"type": "object"
},
"auth_providers": {
"type": "array",
"items": {}
},
"can_create_tag": {
"type": "boolean"
},
"can_tag_topics": {
"type": "boolean"
},
"top_menu_items": {
"type": "array",
"items": {}
},
"censored_regexp": {
"type": "array",
"items": {
"type": "object"
}
},
"wizard_required": {
"type": "boolean"
},
"topic_flag_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name_key",
"name",
"description",
"short_description",
"is_flag",
"is_custom_flag"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"is_flag": {
"type": "boolean"
},
"name_key": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"is_custom_flag": {
"type": "boolean"
},
"short_description": {
"type": "string"
}
}
}
},
"default_archetype": {
"type": "string"
},
"post_action_types": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name_key",
"name",
"description",
"short_description",
"is_flag",
"is_custom_flag"
],
"properties": {
"id": {
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"is_flag": {
"type": "boolean"
},
"name_key": {
"type": [
"string",
"null"
]
},
"description": {
"type": "string"
},
"is_custom_flag": {
"type": "boolean"
},
"short_description": {
"type": "string"
}
}
}
},
"notification_types": {
"type": "object",
"required": [
"mentioned",
"replied",
"quoted",
"edited",
"liked",
"private_message",
"invited_to_private_message",
"invitee_accepted",
"posted",
"watching_category_or_tag",
"moved_post",
"linked",
"granted_badge",
"invited_to_topic",
"custom",
"group_mentioned",
"group_message_summary",
"watching_first_post",
"topic_reminder",
"liked_consolidated",
"linked_consolidated",
"post_approved",
"code_review_commit_approved",
"membership_request_accepted",
"membership_request_consolidated",
"bookmark_reminder",
"reaction",
"votes_released",
"event_reminder",
"event_invitation",
"chat_mention",
"chat_message",
"chat_invitation",
"chat_group_mention"
],
"properties": {
"liked": {
"type": "integer"
},
"custom": {
"type": "integer"
},
"edited": {
"type": "integer"
},
"linked": {
"type": "integer"
},
"posted": {
"type": "integer"
},
"quoted": {
"type": "integer"
},
"replied": {
"type": "integer"
},
"assigned": {
"type": "integer"
},
"reaction": {
"type": "integer"
},
"following": {
"type": "integer"
},
"mentioned": {
"type": "integer"
},
"moved_post": {
"type": "integer"
},
"chat_quoted": {
"type": "integer"
},
"chat_mention": {
"type": "integer"
},
"chat_message": {
"type": "integer"
},
"new_features": {
"type": "integer"
},
"granted_badge": {
"type": "integer"
},
"post_approved": {
"type": "integer"
},
"admin_problems": {
"type": "integer"
},
"event_reminder": {
"type": "integer"
},
"topic_reminder": {
"type": "integer"
},
"votes_released": {
"type": "integer"
},
"chat_invitation": {
"type": "integer"
},
"group_mentioned": {
"type": "integer"
},
"private_message": {
"type": "integer"
},
"circles_activity": {
"type": "integer"
},
"event_invitation": {
"type": "integer"
},
"invited_to_topic": {
"type": "integer"
},
"invitee_accepted": {
"type": "integer"
},
"bookmark_reminder": {
"type": "integer"
},
"following_replied": {
"type": "integer"
},
"chat_group_mention": {
"type": "integer"
},
"liked_consolidated": {
"type": "integer"
},
"linked_consolidated": {
"type": "integer"
},
"watching_first_post": {
"type": "integer"
},
"group_message_summary": {
"type": "integer"
},
"following_created_topic": {
"type": "integer"
},
"watching_category_or_tag": {
"type": "integer"
},
"invited_to_private_message": {
"type": "integer"
},
"code_review_commit_approved": {
"type": "integer"
},
"membership_request_accepted": {
"type": "integer"
},
"question_answer_user_commented": {
"type": "integer"
},
"membership_request_consolidated": {
"type": "integer"
}
}
},
"tags_filter_regexp": {
"type": "string"
},
"user_color_schemes": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"is_dark"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"is_dark": {
"type": "boolean"
}
}
}
},
"watched_words_link": {
"type": [
"string",
"null"
]
},
"can_associate_groups": {
"type": "boolean"
},
"user_field_max_length": {
"type": "integer"
},
"watched_words_replace": {
"type": [
"string",
"null"
]
},
"hashtag_configurations": {
"type": "object"
},
"anonymous_top_menu_items": {
"type": "array",
"items": {}
},
"custom_emoji_translation": {
"type": "object",
"properties": {}
},
"default_dark_color_scheme": {
"type": [
"object",
"null"
]
},
"uncategorized_category_id": {
"type": "integer"
},
"markdown_additional_options": {
"type": "object"
},
"navigation_menu_site_top_tags": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"whispers_allowed_groups_names": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"displayed_about_plugin_stat_groups": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
}
},
"topic_featured_link_allowed_category_ids": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}
TagsCreateTagGroupRequest
{
"type": "object",
"required": [
"name"
],
"properties": {
"name": {
"type": "string"
}
}
}
TagsCreateTagGroupResponse
{
"type": "object",
"required": [
"tag_group"
],
"properties": {
"tag_group": {
"type": "object",
"required": [
"id",
"name",
"tag_names",
"parent_tag_name",
"one_per_topic",
"permissions"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object"
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
TagsGetSingleTagGroupResponse
{
"type": "object",
"properties": {
"tag_group": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object",
"properties": {
"everyone": {
"type": "integer"
}
}
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
TagsGetSpecificTagResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"staff": {
"type": "boolean"
},
"topic_count": {
"type": "integer"
}
}
}
},
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
TagsGetTagGroupsResponse
{
"type": "object",
"properties": {
"tag_groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object",
"properties": {
"staff": {
"type": "integer"
}
}
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
}
TagsListResponse
{
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"text": {
"type": "string"
},
"count": {
"type": "integer"
},
"pm_count": {
"type": "integer"
},
"target_tag": {
"type": [
"string",
"null"
]
}
}
}
},
"extras": {
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {}
}
}
}
}
}
TagsUpdateTagGroupRequest
{
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
TagsUpdateTagGroupResponse
{
"type": "object",
"properties": {
"success": {
"type": "string"
},
"tag_group": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"tag_names": {
"type": "array",
"items": {}
},
"permissions": {
"type": "object",
"properties": {
"everyone": {
"type": "integer"
}
}
},
"one_per_topic": {
"type": "boolean"
},
"parent_tag_name": {
"type": "array",
"items": {}
}
}
}
}
}
TopicsCreateTopicTimerRequest
{
"type": "object",
"properties": {
"time": {
"type": "string",
"example": ""
},
"category_id": {
"type": "integer"
},
"status_type": {
"type": "string"
},
"based_on_last_post": {
"type": "boolean"
}
}
}
TopicsCreateTopicTimerResponse
{
"type": "object",
"properties": {
"closed": {
"type": "boolean"
},
"success": {
"type": "string",
"example": "OK"
},
"duration": {
"type": [
"string",
"null"
]
},
"execute_at": {
"type": "string"
},
"category_id": {
"type": [
"string",
"null"
]
},
"based_on_last_post": {
"type": "boolean"
}
}
}
TopicsGetLatestTopicsResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": "string"
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"op_like_count": {
"type": "integer"
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
TopicsGetSingleTopicResponse
{
"required": [
"post_stream",
"timeline_lookup",
"suggested_topics",
"tags",
"tags_descriptions",
"id",
"title",
"fancy_title",
"posts_count",
"created_at",
"views",
"reply_count",
"like_count",
"last_posted_at",
"visible",
"closed",
"archived",
"has_summary",
"archetype",
"slug",
"category_id",
"word_count",
"deleted_at",
"user_id",
"featured_link",
"pinned_globally",
"pinned_at",
"pinned_until",
"image_url",
"slow_mode_seconds",
"draft",
"draft_key",
"draft_sequence",
"unpinned",
"pinned",
"highest_post_number",
"deleted_by",
"has_deleted",
"actions_summary",
"chunk_size",
"bookmarked",
"bookmarks",
"topic_timer",
"message_bus_last_id",
"participant_count",
"show_read_indicator",
"thumbnails",
"slow_mode_enabled_until",
"summarizable",
"details"
],
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"draft": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"details": {
"type": "object",
"required": [
"can_edit",
"notification_level",
"can_move_posts",
"can_delete",
"can_remove_allowed_users",
"can_create_post",
"can_reply_as_new_topic",
"can_convert_topic",
"can_review_topic",
"can_close_topic",
"can_archive_topic",
"can_split_merge_topic",
"can_edit_staff_notes",
"can_toggle_topic_visibility",
"can_pin_unpin_topic",
"can_moderate_category",
"can_remove_self_id",
"created_by",
"last_poster"
],
"properties": {
"can_edit": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_by": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"last_poster": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"participants": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template",
"post_count",
"primary_group_name",
"flair_name",
"flair_url",
"flair_color",
"flair_bg_color",
"admin",
"moderator",
"trust_level"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"admin": {
"type": "boolean"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"flair_name": {
"type": [
"string",
"null"
]
},
"post_count": {
"type": "integer"
},
"flair_color": {
"type": [
"string",
"null"
]
},
"trust_level": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_group_id": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"primary_group_name": {
"type": [
"string",
"null"
]
}
}
}
},
"can_invite_to": {
"type": "boolean"
},
"can_flag_topic": {
"type": "boolean"
},
"can_move_posts": {
"type": "boolean"
},
"can_close_topic": {
"type": "boolean"
},
"can_create_post": {
"type": "boolean"
},
"can_review_topic": {
"type": "boolean"
},
"can_archive_topic": {
"type": "boolean"
},
"can_convert_topic": {
"type": "boolean"
},
"can_remove_self_id": {
"type": "integer"
},
"notification_level": {
"type": "integer"
},
"can_pin_unpin_topic": {
"type": "boolean"
},
"can_edit_staff_notes": {
"type": "boolean"
},
"can_invite_via_email": {
"type": "boolean"
},
"can_moderate_category": {
"type": "boolean"
},
"can_split_merge_topic": {
"type": "boolean"
},
"can_reply_as_new_topic": {
"type": "boolean"
},
"can_remove_allowed_users": {
"type": "boolean"
},
"can_toggle_topic_visibility": {
"type": "boolean"
}
}
},
"user_id": {
"type": "integer"
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bookmarks": {
"type": "array",
"items": {}
},
"draft_key": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"pinned_at": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"chunk_size": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"deleted_by": {
"type": [
"string",
"null"
]
},
"like_count": {
"type": "integer"
},
"thumbnails": {
"type": [
"string",
"null"
]
},
"word_count": {
"type": [
"integer",
"null"
]
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_deleted": {
"type": "boolean"
},
"has_summary": {
"type": "boolean"
},
"post_stream": {
"type": "object",
"required": [
"posts",
"stream"
],
"properties": {
"posts": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"username",
"avatar_template",
"created_at",
"cooked",
"post_number",
"post_type",
"updated_at",
"reply_count",
"reply_to_post_number",
"quote_count",
"incoming_link_count",
"reads",
"readers_count",
"score",
"yours",
"topic_id",
"topic_slug",
"display_username",
"primary_group_name",
"flair_name",
"flair_url",
"flair_bg_color",
"flair_color",
"version",
"can_edit",
"can_delete",
"can_recover",
"can_wiki",
"link_counts",
"read",
"user_title",
"bookmarked",
"actions_summary",
"moderator",
"admin",
"staff",
"user_id",
"hidden",
"trust_level",
"deleted_at",
"user_deleted",
"edit_reason",
"can_view_edit_history",
"wiki",
"reviewable_id",
"reviewable_score_count",
"reviewable_score_pending_count"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"read": {
"type": "boolean"
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"bookmarked": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"link_counts": {
"type": "array",
"items": {
"type": "object",
"required": [
"url",
"internal",
"reflection",
"title",
"clicks"
],
"properties": {
"url": {
"type": "string"
},
"title": {
"type": "string"
},
"clicks": {
"type": "integer"
},
"internal": {
"type": "boolean"
},
"reflection": {
"type": "boolean"
}
}
}
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"can_act"
],
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"display_username": {
"type": "string"
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"can_see_hidden_post": {
"type": "boolean"
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
}
},
"stream": {
"type": "array",
"items": {}
}
}
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"topic_timer": {
"type": [
"string",
"null"
]
},
"pinned_until": {
"type": [
"string",
"null"
]
},
"summarizable": {
"type": "boolean"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"draft_sequence": {
"type": "integer"
},
"last_posted_at": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"count",
"hidden",
"can_act"
],
"properties": {
"id": {
"type": "integer"
},
"count": {
"type": "integer"
},
"hidden": {
"type": "boolean"
},
"can_act": {
"type": "boolean"
}
}
}
},
"pinned_globally": {
"type": "boolean"
},
"timeline_lookup": {
"type": "array",
"items": {}
},
"suggested_topics": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"title",
"fancy_title",
"slug",
"posts_count",
"reply_count",
"highest_post_number",
"image_url",
"created_at",
"last_posted_at",
"bumped",
"bumped_at",
"archetype",
"unseen",
"pinned",
"unpinned",
"excerpt",
"visible",
"closed",
"archived",
"bookmarked",
"liked",
"tags",
"tags_descriptions",
"like_count",
"views",
"category_id",
"featured_link",
"posters"
],
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"tags": {
"type": "array",
"items": {}
},
"liked": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"excerpt": {
"type": "string"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"required": [
"extras",
"description",
"user"
],
"properties": {
"user": {
"type": "object",
"required": [
"id",
"username",
"name",
"avatar_template"
],
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
},
"extras": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": [
"string",
"null"
]
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"last_posted_at": {
"type": [
"string",
"null"
]
},
"tags_descriptions": {
"type": "object",
"properties": {}
},
"highest_post_number": {
"type": "integer"
}
}
}
},
"participant_count": {
"type": "integer"
},
"slow_mode_seconds": {
"type": "integer"
},
"tags_descriptions": {
"type": "object",
"properties": {}
},
"current_post_number": {
"type": "integer"
},
"highest_post_number": {
"type": [
"integer",
"null"
]
},
"message_bus_last_id": {
"type": "integer"
},
"show_read_indicator": {
"type": "boolean"
},
"slow_mode_enabled_until": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
TopicsGetSpecificPostsRequest
{
"type": "object",
"required": [
"post_ids[]"
],
"properties": {
"post_ids[]": {
"type": "integer"
}
}
}
TopicsGetSpecificPostsResponse
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"post_stream": {
"type": "object",
"properties": {
"posts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": [
"string",
"null"
]
},
"read": {
"type": "boolean"
},
"wiki": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"reads": {
"type": "integer"
},
"score": {
"type": "number"
},
"staff": {
"type": "boolean"
},
"yours": {
"type": "boolean"
},
"cooked": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"user_id": {
"type": "integer"
},
"version": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"can_wiki": {
"type": "boolean"
},
"topic_id": {
"type": "integer"
},
"username": {
"type": "string"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"moderator": {
"type": "boolean"
},
"post_type": {
"type": "integer"
},
"can_delete": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"deleted_at": {
"type": [
"string",
"null"
]
},
"flair_name": {
"type": [
"string",
"null"
]
},
"topic_slug": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"user_title": {
"type": [
"string",
"null"
]
},
"can_recover": {
"type": "boolean"
},
"edit_reason": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"post_number": {
"type": "integer"
},
"quote_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"trust_level": {
"type": "integer"
},
"user_deleted": {
"type": "boolean"
},
"readers_count": {
"type": "integer"
},
"reviewable_id": {
"type": "integer"
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"actions_summary": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"can_act": {
"type": "boolean"
}
}
}
},
"avatar_template": {
"type": "string"
},
"display_username": {
"type": [
"string",
"null"
]
},
"primary_group_name": {
"type": [
"string",
"null"
]
},
"incoming_link_count": {
"type": "integer"
},
"reply_to_post_number": {
"type": [
"string",
"null"
]
},
"can_view_edit_history": {
"type": "boolean"
},
"reviewable_score_count": {
"type": "integer"
},
"reviewable_score_pending_count": {
"type": "integer"
}
}
}
}
}
}
}
}
TopicsGetTopTopicsByPeriodResponse
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
},
"topic_list": {
"type": "object",
"properties": {
"draft": {
"type": [
"string",
"null"
]
},
"topics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"liked": {
"type": "boolean"
},
"title": {
"type": "string"
},
"views": {
"type": "integer"
},
"bumped": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unseen": {
"type": "boolean"
},
"posters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"extras": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"description": {
"type": "string"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
}
}
},
"visible": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"unpinned": {
"type": "boolean"
},
"archetype": {
"type": "string"
},
"bumped_at": {
"type": "string"
},
"image_url": {
"type": [
"string",
"null"
]
},
"bookmarked": {
"type": "boolean"
},
"created_at": {
"type": "string"
},
"like_count": {
"type": "integer"
},
"category_id": {
"type": "integer"
},
"fancy_title": {
"type": "string"
},
"has_summary": {
"type": "boolean"
},
"posts_count": {
"type": "integer"
},
"reply_count": {
"type": "integer"
},
"unread_posts": {
"type": "integer"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"op_like_count": {
"type": "integer"
},
"last_posted_at": {
"type": "string"
},
"pinned_globally": {
"type": "boolean"
},
"notification_level": {
"type": "integer"
},
"highest_post_number": {
"type": "integer"
},
"last_poster_username": {
"type": "string"
},
"last_read_post_number": {
"type": "integer"
}
}
}
},
"per_page": {
"type": "integer"
},
"draft_key": {
"type": "string"
},
"for_period": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"can_create_topic": {
"type": "boolean"
}
}
},
"primary_groups": {
"type": "array",
"items": {}
}
}
}
TopicsSendInviteToTopicRequest
{
"type": "object",
"properties": {
"user": {
"type": "string"
},
"email": {
"type": "string"
}
}
}
TopicsSendInviteToTopicResponse
{
"type": "object",
"properties": {
"user": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
}
}
}
}
TopicsSetNotificationLevelRequest
{
"type": "object",
"required": [
"notification_level"
],
"properties": {
"notification_level": {
"enum": [
"0",
"1",
"2",
"3"
],
"type": "string"
}
}
}
TopicsSetNotificationLevelResponse
{
"type": "object",
"properties": {
"success": {
"type": "string",
"example": "OK"
}
}
}
TopicsUpdateStatusOfTopicRequest
{
"type": "object",
"required": [
"status",
"enabled"
],
"properties": {
"until": {
"type": "string",
"example": "2030-12-31",
"description": "Only required for `pinned` and `pinned_globally`"
},
"status": {
"enum": [
"closed",
"pinned",
"pinned_globally",
"archived",
"visible"
],
"type": "string"
},
"enabled": {
"enum": [
"true",
"false"
],
"type": "string"
}
}
}
TopicsUpdateStatusOfTopicResponse
{
"type": "object",
"properties": {
"success": {
"type": "string",
"example": "OK"
},
"topic_status_update": {
"type": [
"string",
"null"
]
}
}
}
TopicsUpdateTimestampJsonRequest
{
"type": "object",
"required": [
"timestamp"
],
"properties": {
"timestamp": {
"type": "string",
"example": "1594291380"
}
}
}
TopicsUpdateTimestampJsonResponse
{
"type": "object",
"properties": {
"success": {
"type": "string",
"example": "OK"
}
}
}
TopicsUpdateTopicByIdJsonRequest
{
"type": "object",
"properties": {
"topic": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"category_id": {
"type": "integer"
}
}
}
}
}
TopicsUpdateTopicByIdJsonResponse
{
"type": "object",
"properties": {
"basic_topic": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"slug": {
"type": "string"
},
"title": {
"type": "string"
},
"fancy_title": {
"type": "string"
},
"posts_count": {
"type": "integer"
}
}
}
}
}
UploadsAbortMultipartUploadRequest
{
"required": [
"external_upload_identifier"
],
"properties": {
"external_upload_identifier": {
"type": "string",
"example": "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ",
"description": "The identifier of the multipart upload in the external\nstorage provider. This is the multipart upload_id in AWS S3."
}
},
"additionalProperties": false
}
UploadsAbortMultipartUploadResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UploadsCompleteExternalUploadRequest
{
"required": [
"unique_identifier"
],
"properties": {
"pasted": {
"type": "string",
"example": "true",
"description": "Optionally set this to true if the upload was pasted\ninto the upload area. This will convert PNG files to JPEG."
},
"for_site_setting": {
"type": "string",
"example": "true",
"description": "Optionally set this to true if the upload is for a\nsite setting."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "The unique identifier returned in the original /generate-presigned-put\nrequest."
},
"for_private_message": {
"type": "string",
"example": "true",
"description": "Optionally set this to true if the upload is for a\nprivate message."
}
},
"additionalProperties": false
}
UploadsCompleteExternalUploadResponse
{
"required": [
"id",
"url",
"original_filename",
"filesize",
"width",
"height",
"thumbnail_width",
"thumbnail_height",
"extension",
"short_url",
"short_path",
"retain_hours",
"human_filesize"
],
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"filesize": {
"type": "integer"
},
"extension": {
"type": "string"
},
"short_url": {
"type": "string"
},
"short_path": {
"type": "string"
},
"retain_hours": {
"type": [
"string",
"null"
]
},
"dominant_color": {
"type": [
"string",
"null"
]
},
"human_filesize": {
"type": "string"
},
"thumbnail_width": {
"type": "integer"
},
"thumbnail_height": {
"type": "integer"
},
"original_filename": {
"type": "string"
}
},
"additionalProperties": false
}
UploadsCompleteMultipartUploadRequest
{
"required": [
"unique_identifier",
"parts"
],
"properties": {
"parts": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"example": [
{
"etag": "0c376dcfcc2606f4335bbc732de93344",
"part_number": 1
},
{
"etag": "09ert8cfcc2606f4335bbc732de91122",
"part_number": 2
}
],
"description": "All of the part numbers and their corresponding ETags\nthat have been uploaded must be provided."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "The unique identifier returned in the original /create-multipart\nrequest."
}
},
"additionalProperties": false
}
UploadsCompleteMultipartUploadResponse
{
"required": [
"id",
"url",
"original_filename",
"filesize",
"width",
"height",
"thumbnail_width",
"thumbnail_height",
"extension",
"short_url",
"short_path",
"retain_hours",
"human_filesize"
],
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"filesize": {
"type": "integer"
},
"extension": {
"type": "string"
},
"short_url": {
"type": "string"
},
"short_path": {
"type": "string"
},
"retain_hours": {
"type": [
"string",
"null"
]
},
"dominant_color": {
"type": [
"string",
"null"
]
},
"human_filesize": {
"type": "string"
},
"thumbnail_width": {
"type": "integer"
},
"thumbnail_height": {
"type": "integer"
},
"original_filename": {
"type": "string"
}
},
"additionalProperties": false
}
UploadsCreateMultipartExternalUploadRequest
{
"required": [
"upload_type",
"file_name",
"file_size"
],
"properties": {
"metadata": {
"type": "object",
"properties": {
"sha1-checksum": {
"type": "string",
"description": "The SHA1 checksum of the upload binary blob. Optionally\nbe provided and serves as an additional security check when\nlater processing the file in complete-external-upload endpoint."
}
}
},
"file_name": {
"type": "string",
"example": "IMG_2021.jpeg"
},
"file_size": {
"type": "integer",
"example": 4096,
"description": "File size should be represented in bytes."
},
"upload_type": {
"enum": [
"avatar",
"profile_background",
"card_background",
"custom_emoji",
"composer"
],
"type": "string"
}
},
"additionalProperties": false
}
UploadsCreateMultipartExternalUploadResponse
{
"required": [
"external_upload_identifier",
"key",
"unique_identifier"
],
"properties": {
"key": {
"type": "string",
"example": "temp/site/uploads/default/12345/67890.jpg",
"description": "The path of the temporary file on the external storage\nservice."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "A unique string that identifies the external upload.\nThis must be stored and then sent in the /complete-multipart\nand /batch-presign-multipart-parts endpoints."
},
"external_upload_identifier": {
"type": "string",
"example": "84x83tmxy398t3y._Q_z8CoJYVr69bE6D7f8J6Oo0434QquLFoYdGVerWFx9X5HDEI_TP_95c34n853495x35345394.d.ghQ",
"description": "The identifier of the multipart upload in the external\nstorage provider. This is the multipart upload_id in AWS S3."
}
},
"additionalProperties": false
}
UploadsCreateNewUploadRequest
{
"required": [
"type"
],
"properties": {
"file": {
"type": "string",
"format": "binary"
},
"type": {
"enum": [
"avatar",
"profile_background",
"card_background",
"custom_emoji",
"composer"
],
"type": "string"
},
"user_id": {
"type": "integer",
"description": "required if uploading an avatar"
},
"synchronous": {
"type": "boolean",
"description": "Use this flag to return an id and url"
}
},
"additionalProperties": false
}
UploadsCreateNewUploadResponse
{
"required": [
"id",
"url",
"original_filename",
"filesize",
"width",
"height",
"thumbnail_width",
"thumbnail_height",
"extension",
"short_url",
"short_path",
"retain_hours",
"human_filesize"
],
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"filesize": {
"type": "integer"
},
"extension": {
"type": "string"
},
"short_url": {
"type": "string"
},
"short_path": {
"type": "string"
},
"retain_hours": {
"type": [
"string",
"null"
]
},
"dominant_color": {
"type": [
"string",
"null"
]
},
"human_filesize": {
"type": "string"
},
"thumbnail_width": {
"type": "integer"
},
"thumbnail_height": {
"type": "integer"
},
"original_filename": {
"type": "string"
}
},
"additionalProperties": false
}
UploadsGeneratePresignedUrlsForMultipartPartsRequest
{
"required": [
"part_numbers",
"unique_identifier"
],
"properties": {
"part_numbers": {
"type": "array",
"items": {
"description": "WARNING: Missing items property in array schema. Missing items property has been filled with this AnyType schema."
},
"example": [
1,
2,
3
],
"description": "The part numbers to generate the presigned URLs for,\nmust be between 1 and 10000."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "The unique identifier returned in the original /create-multipart\nrequest."
}
},
"additionalProperties": false
}
UploadsGeneratePresignedUrlsForMultipartPartsResponse
{
"required": [
"presigned_urls"
],
"properties": {
"presigned_urls": {
"type": "object",
"example": {
"1": "https://discourse-martin-uploads-test.s3.us-east-2.amazonaws.com/temp/uploads/default/123abc/123abc.jpg?partNumber=1&uploadId=123456abcd&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test&X-Amz-Date=20211222T012336Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=abc123"
},
"description": "The presigned URLs for each part number, which has\nthe part numbers as keys."
}
},
"additionalProperties": false
}
UploadsInitiateDirectExternalUploadRequest
{
"required": [
"type",
"file_name",
"file_size"
],
"properties": {
"type": {
"enum": [
"avatar",
"profile_background",
"card_background",
"custom_emoji",
"composer"
],
"type": "string"
},
"metadata": {
"type": "object",
"properties": {
"sha1-checksum": {
"type": "string",
"description": "The SHA1 checksum of the upload binary blob. Optionally\nbe provided and serves as an additional security check when\nlater processing the file in complete-external-upload endpoint."
}
}
},
"file_name": {
"type": "string",
"example": "IMG_2021.jpeg"
},
"file_size": {
"type": "integer",
"example": 4096,
"description": "File size should be represented in bytes."
}
},
"additionalProperties": false
}
UploadsInitiateDirectExternalUploadResponse
{
"properties": {
"key": {
"type": "string",
"example": "temp/site/uploads/default/12345/67890.jpg",
"description": "The path of the temporary file on the external storage\nservice."
},
"url": {
"type": "string",
"example": "https://file-uploads.s3.us-west-2.amazonaws.com/temp/site/uploads/default/123/456.jpg?x-amz-acl=private&x-amz-meta-sha1-checksum=sha1&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AAAAus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20211221T011246Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=12345678",
"description": "A presigned PUT URL which must be used to upload\nthe file binary blob to."
},
"signed_headers": {
"type": "object",
"example": {
"x-amz-acl": "private",
"x-amz-meta-sha1-checksum": "sha1"
},
"description": "A map of headers that must be sent with the PUT request."
},
"unique_identifier": {
"type": "string",
"example": "66e86218-80d9-4bda-b4d5-2b6def968705",
"description": "A unique string that identifies the external upload.\nThis must be stored and then sent in the /complete-external-upload\nendpoint to complete the direct upload."
}
},
"additionalProperties": false
}
UsersActivateUserResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UsersAnonymizeByIdJsonResponse
{
"required": [
"success",
"username"
],
"properties": {
"success": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
}
UsersChangePasswordActionRequest
{
"required": [
"username",
"password"
],
"properties": {
"password": {
"type": "string"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
}
UsersCreateUserRequest
{
"required": [
"name",
"email",
"password",
"username"
],
"properties": {
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"active": {
"type": "boolean",
"description": "This param requires an api key in the request header\nor it will be ignored"
},
"approved": {
"type": "boolean"
},
"password": {
"type": "string"
},
"username": {
"type": "string"
},
"external_ids": {
"type": "object"
},
"user_fields[1]": {
"type": "boolean"
}
},
"additionalProperties": false
}
UsersCreateUserResponse
{
"required": [
"success",
"active",
"message"
],
"properties": {
"active": {
"type": "boolean"
},
"message": {
"type": "string"
},
"success": {
"type": "boolean"
},
"user_id": {
"type": "integer"
}
},
"additionalProperties": false
}
UsersDeactivateUserResponse
{
"required": [
"success"
],
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"additionalProperties": false
}
UsersDeleteUserByIdJsonRequest
{
"properties": {
"block_ip": {
"type": "boolean"
},
"block_urls": {
"type": "boolean"
},
"block_email": {
"type": "boolean"
},
"delete_posts": {
"type": "boolean"
}
},
"additionalProperties": false
}
UsersDeleteUserByIdJsonResponse
{
"required": [
"deleted"
],
"properties": {
"deleted": {
"type": "boolean"
}
},
"additionalProperties": false
}
UsersGetEmailsResponse
{
"required": [
"email",
"secondary_emails",
"unconfirmed_emails",
"associated_accounts"
],
"properties": {
"email": {
"type": "string"
},
"secondary_emails": {
"type": "array",
"items": {}
},
"unconfirmed_emails": {
"type": "array",
"items": {}
},
"associated_accounts": {
"type": "array",
"items": {}
}
},
"additionalProperties": false
}