DEV: Update category api docs (#12017)

Updated the category api docs to follow the new validation format.
This commit is contained in:
Blake Erickson
2021-02-09 06:27:23 -07:00
committed by GitHub
parent 7354636502
commit 65a0d5bd76
6 changed files with 1127 additions and 362 deletions

View File

@@ -0,0 +1,19 @@
{
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string",
"example": "49d9e9"
},
"text_color": {
"type": "string",
"example": "f0fcfd"
}
},
"required": [
"name"
]
}

View File

@@ -0,0 +1,282 @@
{
"additionalProperties": false,
"properties": {
"category": {
"type": "object",
"additionalProperties": false,
"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",
"null"
]
},
"description_text": {
"type": [
"string",
"null"
]
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"topic_url": {
"type": [
"string",
"null"
]
},
"read_restricted": {
"type": "boolean"
},
"permission": {
"type": [
"integer",
"null"
]
},
"notification_level": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"topic_template": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": [
"string",
"null"
]
},
"sort_order": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"show_subcategory_list": {
"type": "boolean"
},
"num_featured_topics": {
"type": "integer"
},
"default_view": {
"type": [
"string",
"null"
]
},
"subcategory_list_style": {
"type": "string"
},
"default_top_period": {
"type": "string"
},
"default_list_filter": {
"type": "string"
},
"minimum_required_tags": {
"type": "integer"
},
"navigate_to_first_post_after_read": {
"type": "boolean"
},
"custom_fields": {
"type": "object",
"additionalProperties": false,
"properties": {
},
"required": [
]
},
"min_tags_from_required_group": {
"type": "integer"
},
"required_tag_group_name": {
"type": [
"string",
"null"
]
},
"read_only_banner": {
"type": [
"string",
"null"
]
},
"available_groups": {
"type": "array",
"items": [
]
},
"auto_close_hours": {
"type": [
"string",
"null"
]
},
"auto_close_based_on_last_post": {
"type": "boolean"
},
"group_permissions": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"permission_type": {
"type": "integer"
},
"group_name": {
"type": "string"
}
},
"required": [
"permission_type",
"group_name"
]
}
]
},
"email_in": {
"type": [
"string",
"null"
]
},
"email_in_allow_strangers": {
"type": "boolean"
},
"mailinglist_mirror": {
"type": "boolean"
},
"all_topics_wiki": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"cannot_delete_reason": {
"type": [
"string",
"null"
]
},
"allow_badges": {
"type": "boolean"
},
"topic_featured_link_allowed": {
"type": "boolean"
},
"search_priority": {
"type": "integer"
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"uploaded_background": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"description",
"description_text",
"description_excerpt",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"can_edit",
"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",
"custom_fields",
"min_tags_from_required_group",
"required_tag_group_name",
"read_only_banner",
"available_groups",
"auto_close_hours",
"auto_close_based_on_last_post",
"group_permissions",
"email_in",
"email_in_allow_strangers",
"mailinglist_mirror",
"all_topics_wiki",
"can_delete",
"cannot_delete_reason",
"allow_badges",
"topic_featured_link_allowed",
"search_priority",
"uploaded_logo",
"uploaded_background"
]
}
},
"required": [
"category"
]
}

View File

@@ -0,0 +1,222 @@
{
"additionalProperties": false,
"properties": {
"category_list": {
"type": "object",
"additionalProperties": false,
"properties": {
"can_create_category": {
"type": "boolean"
},
"can_create_topic": {
"type": "boolean"
},
"draft": {
"type": [
"string",
"null"
]
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"categories": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"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"
},
"description_excerpt": {
"type": "string"
},
"topic_url": {
"type": [
"string",
"null"
]
},
"read_restricted": {
"type": "boolean"
},
"permission": {
"type": "integer"
},
"notification_level": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"topic_template": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": "boolean"
},
"sort_order": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"show_subcategory_list": {
"type": "boolean"
},
"num_featured_topics": {
"type": "integer"
},
"default_view": {
"type": [
"string",
"null"
]
},
"subcategory_list_style": {
"type": "string"
},
"default_top_period": {
"type": "string"
},
"default_list_filter": {
"type": "string"
},
"minimum_required_tags": {
"type": "integer"
},
"navigate_to_first_post_after_read": {
"type": "boolean"
},
"topics_day": {
"type": "integer"
},
"topics_week": {
"type": "integer"
},
"topics_month": {
"type": "integer"
},
"topics_year": {
"type": "integer"
},
"topics_all_time": {
"type": "integer"
},
"is_uncategorized": {
"type": "boolean"
},
"subcategory_ids": {
"type": "array",
"items": [
]
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"uploaded_background": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"description",
"description_text",
"description_excerpt",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"can_edit",
"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",
"topics_day",
"topics_week",
"topics_month",
"topics_year",
"topics_all_time",
"is_uncategorized",
"subcategory_ids",
"uploaded_logo",
"uploaded_background"
]
}
]
}
},
"required": [
"can_create_category",
"can_create_topic",
"categories"
]
}
},
"required": [
"category_list"
]
}

View File

@@ -0,0 +1,252 @@
{
"additionalProperties": false,
"properties": {
"users": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
},
"required": [
"id",
"username",
"name",
"avatar_template"
]
}
]
},
"primary_groups": {
"type": "array",
"items": [
]
},
"topic_list": {
"type": "object",
"additionalProperties": false,
"properties": {
"can_create_topic": {
"type": "boolean"
},
"draft": {
"type": [
"string",
"null"
]
},
"draft_key": {
"type": "string"
},
"draft_sequence": {
"type": "integer"
},
"per_page": {
"type": "integer"
},
"topics": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"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",
"null"
]
},
"created_at": {
"type": "string"
},
"last_posted_at": {
"type": "string"
},
"bumped": {
"type": "boolean"
},
"bumped_at": {
"type": "string"
},
"archetype": {
"type": "string"
},
"unseen": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"unpinned": {
"type": [
"string",
"null"
]
},
"excerpt": {
"type": "string"
},
"visible": {
"type": "boolean"
},
"closed": {
"type": "boolean"
},
"archived": {
"type": "boolean"
},
"bookmarked": {
"type": [
"string",
"null"
]
},
"liked": {
"type": [
"string",
"null"
]
},
"views": {
"type": "integer"
},
"like_count": {
"type": "integer"
},
"has_summary": {
"type": "boolean"
},
"last_poster_username": {
"type": "string"
},
"category_id": {
"type": "integer"
},
"pinned_globally": {
"type": "boolean"
},
"featured_link": {
"type": [
"string",
"null"
]
},
"posters": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"extras": {
"type": "string"
},
"description": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"primary_group_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"extras",
"description",
"user_id",
"primary_group_id"
]
}
]
}
},
"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",
"views",
"like_count",
"has_summary",
"last_poster_username",
"category_id",
"pinned_globally",
"featured_link",
"posters"
]
}
]
}
},
"required": [
"can_create_topic",
"draft",
"draft_key",
"draft_sequence",
"per_page",
"topics"
]
}
},
"required": [
"topic_list"
]
}

View File

@@ -0,0 +1,286 @@
{
"additionalProperties": false,
"properties": {
"success": {
"type": "string"
},
"category": {
"type": "object",
"additionalProperties": false,
"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",
"null"
]
},
"description_text": {
"type": [
"string",
"null"
]
},
"description_excerpt": {
"type": [
"string",
"null"
]
},
"topic_url": {
"type": [
"string",
"null"
]
},
"read_restricted": {
"type": "boolean"
},
"permission": {
"type": [
"string",
"null"
]
},
"notification_level": {
"type": "integer"
},
"can_edit": {
"type": "boolean"
},
"topic_template": {
"type": [
"string",
"null"
]
},
"has_children": {
"type": [
"string",
"null"
]
},
"sort_order": {
"type": [
"string",
"null"
]
},
"sort_ascending": {
"type": [
"string",
"null"
]
},
"show_subcategory_list": {
"type": "boolean"
},
"num_featured_topics": {
"type": "integer"
},
"default_view": {
"type": [
"string",
"null"
]
},
"subcategory_list_style": {
"type": "string"
},
"default_top_period": {
"type": "string"
},
"default_list_filter": {
"type": "string"
},
"minimum_required_tags": {
"type": "integer"
},
"navigate_to_first_post_after_read": {
"type": "boolean"
},
"custom_fields": {
"type": "object",
"additionalProperties": false,
"properties": {
},
"required": [
]
},
"min_tags_from_required_group": {
"type": "integer"
},
"required_tag_group_name": {
"type": [
"string",
"null"
]
},
"read_only_banner": {
"type": [
"string",
"null"
]
},
"available_groups": {
"type": "array",
"items": [
]
},
"auto_close_hours": {
"type": [
"string",
"null"
]
},
"auto_close_based_on_last_post": {
"type": "boolean"
},
"group_permissions": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"permission_type": {
"type": "integer"
},
"group_name": {
"type": "string"
}
},
"required": [
"permission_type",
"group_name"
]
}
]
},
"email_in": {
"type": [
"string",
"null"
]
},
"email_in_allow_strangers": {
"type": "boolean"
},
"mailinglist_mirror": {
"type": "boolean"
},
"all_topics_wiki": {
"type": "boolean"
},
"can_delete": {
"type": "boolean"
},
"cannot_delete_reason": {
"type": [
"string",
"null"
]
},
"allow_badges": {
"type": "boolean"
},
"topic_featured_link_allowed": {
"type": "boolean"
},
"search_priority": {
"type": "integer"
},
"uploaded_logo": {
"type": [
"string",
"null"
]
},
"uploaded_background": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"color",
"text_color",
"slug",
"topic_count",
"post_count",
"position",
"description",
"description_text",
"description_excerpt",
"topic_url",
"read_restricted",
"permission",
"notification_level",
"can_edit",
"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",
"custom_fields",
"min_tags_from_required_group",
"required_tag_group_name",
"read_only_banner",
"available_groups",
"auto_close_hours",
"auto_close_based_on_last_post",
"group_permissions",
"email_in",
"email_in_allow_strangers",
"mailinglist_mirror",
"all_topics_wiki",
"can_delete",
"cannot_delete_reason",
"allow_badges",
"topic_featured_link_allowed",
"search_priority",
"uploaded_logo",
"uploaded_background"
]
}
},
"required": [
"success",
"category"
]
}