IntenseWebs/discourse
3
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-02-25 18:55:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

document user endpoints (#11894)

Browse Source 
* document user endpoints, allow for empty request/response bodies

* document more user endpoints, improve debugging output if no details are specified

* document some more user endpoints

* minor cleanup

* FIX: flakey tests due to bad regex
This commit is contained in:
Blake Erickson
2021-01-29 11:27:11 -07:00
committed by GitHub
parent 11c812f042
commit 67e185b33e
12 changed files with 1458 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
spec/requests/api/schemas/json/admin_user_list_response.json Normal file
View File

@@ -0,0 +1,122 @@
{
"type": "array",
"minItems": 1,
"uniqItems": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"email": {
"type": "string"
},
"secondary_emails": {
"type": "array",
"items": [
]
},
"active": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"moderator": {
"type": "boolean"
},
"last_seen_at": {
"type": ["string", "null"]
},
"last_emailed_at": {
"type": ["string", "null"]
},
"created_at": {
"type": "string"
},
"last_seen_age": {
"type": ""
},
"last_emailed_age": {
"type": ""
},
"created_at_age": {
"type": ""
},
"trust_level": {
"type": "integer"
},
"manual_locked_trust_level": {
"type": [
"string",
"null"
]
},
"flag_level": {
"type": "integer"
},
"title": {
"type": [
"string",
"null"
]
},
"time_read": {
"type": "integer"
},
"staged": {
"type": "boolean"
},
"days_visited": {
"type": "integer"
},
"posts_read_count": {
"type": "integer"
},
"topics_entered": {
"type": "integer"
},
"post_count": {
"type": "integer"
}
},
"required": [
"id",
"username",
"name",
"avatar_template",
"active",
"admin",
"moderator",
"last_seen_at",
"last_emailed_at",
"created_at",
"last_seen_age",
"last_emailed_age",
"created_at_age",
"trust_level",
"manual_locked_trust_level",
"flag_level",
"title",
"time_read",
"staged",
"days_visited",
"posts_read_count",
"topics_entered",
"post_count"
]
}
}

616
spec/requests/api/schemas/json/admin_user_response.json Normal file
View File

@@ -0,0 +1,616 @@
{
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"email": {
"type": "string"
},
"secondary_emails": {
"type": "array",
"items": [
]
},
"active": {
"type": "boolean"
},
"admin": {
"type": "boolean"
},
"moderator": {
"type": "boolean"
},
"last_seen_at": {
"type": ["string", "null"]
},
"last_emailed_at": {
"type": ["string", "null"]
},
"created_at": {
"type": "string"
},
"last_seen_age": {
"type": ""
},
"last_emailed_age": {
"type": ""
},
"created_at_age": {
"type": ""
},
"trust_level": {
"type": "integer"
},
"manual_locked_trust_level": {
"type": [
"string",
"null"
]
},
"flag_level": {
"type": "integer"
},
"title": {
"type": [
"string",
"null"
]
},
"time_read": {
"type": "integer"
},
"staged": {
"type": "boolean"
},
"days_visited": {
"type": "integer"
},
"posts_read_count": {
"type": "integer"
},
"topics_entered": {
"type": "integer"
},
"post_count": {
"type": "integer"
},
"associated_accounts": {
"type": "array",
"items": [
]
},
"can_send_activation_email": {
"type": "boolean"
},
"can_activate": {
"type": "boolean"
},
"can_deactivate": {
"type": "boolean"
},
"ip_address": {
"type": "string"
},
"registration_ip_address": {
"type": [
"string",
"null"
]
},
"can_grant_admin": {
"type": "boolean"
},
"can_revoke_admin": {
"type": "boolean"
},
"can_grant_moderation": {
"type": "boolean"
},
"can_revoke_moderation": {
"type": "boolean"
},
"can_impersonate": {
"type": "boolean"
},
"like_count": {
"type": "integer"
},
"like_given_count": {
"type": "integer"
},
"topic_count": {
"type": "integer"
},
"flags_given_count": {
"type": "integer"
},
"flags_received_count": {
"type": "integer"
},
"private_topics_count": {
"type": "integer"
},
"can_delete_all_posts": {
"type": "boolean"
},
"can_be_deleted": {
"type": "boolean"
},
"can_be_anonymized": {
"type": "boolean"
},
"can_be_merged": {
"type": "boolean"
},
"full_suspend_reason": {
"type": [
"string",
"null"
]
},
"silence_reason": {
"type": [
"string",
"null"
]
},
"primary_group_id": {
"type": [
"string",
"null"
]
},
"badge_count": {
"type": "integer"
},
"warnings_received_count": {
"type": "integer"
},
"bounce_score": {
"type": ""
},
"reset_bounce_score_after": {
"type": [
"string",
"null"
]
},
"can_view_action_logs": {
"type": "boolean"
},
"can_disable_second_factor": {
"type": "boolean"
},
"can_delete_sso_record": {
"type": "boolean"
},
"api_key_count": {
"type": "integer"
},
"single_sign_on_record": {
"type": [
"string",
"null"
]
},
"approved_by": {
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string"
},
"name": {
"type": "string"
},
"avatar_template": {
"type": "string"
}
},
"required": [
"id",
"username",
"name",
"avatar_template"
]
},
"suspended_by": {
"type": [
"string",
"null"
]
},
"silenced_by": {
"type": [
"string",
"null"
]
},
"tl3_requirements": {
"type": "object",
"additionalProperties": false,
"properties": {
"time_period": {
"type": "integer"
},
"requirements_met": {
"type": "boolean"
},
"requirements_lost": {
"type": "boolean"
},
"trust_level_locked": {
"type": "boolean"
},
"on_grace_period": {
"type": "boolean"
},
"days_visited": {
"type": "integer"
},
"min_days_visited": {
"type": "integer"
},
"num_topics_replied_to": {
"type": "integer"
},
"min_topics_replied_to": {
"type": "integer"
},
"topics_viewed": {
"type": "integer"
},
"min_topics_viewed": {
"type": "integer"
},
"posts_read": {
"type": "integer"
},
"min_posts_read": {
"type": "integer"
},
"topics_viewed_all_time": {
"type": "integer"
},
"min_topics_viewed_all_time": {
"type": "integer"
},
"posts_read_all_time": {
"type": "integer"
},
"min_posts_read_all_time": {
"type": "integer"
},
"num_flagged_posts": {
"type": "integer"
},
"max_flagged_posts": {
"type": "integer"
},
"num_flagged_by_users": {
"type": "integer"
},
"max_flagged_by_users": {
"type": "integer"
},
"num_likes_given": {
"type": "integer"
},
"min_likes_given": {
"type": "integer"
},
"num_likes_received": {
"type": "integer"
},
"min_likes_received": {
"type": "integer"
},
"num_likes_received_days": {
"type": "integer"
},
"min_likes_received_days": {
"type": "integer"
},
"num_likes_received_users": {
"type": "integer"
},
"min_likes_received_users": {
"type": "integer"
},
"penalty_counts": {
"type": "object",
"additionalProperties": false,
"properties": {
"silenced": {
"type": "integer"
},
"suspended": {
"type": "integer"
},
"total": {
"type": "integer"
}
},
"required": [
"silenced",
"suspended",
"total"
]
}
},
"required": [
"time_period",
"requirements_met",
"requirements_lost",
"trust_level_locked",
"on_grace_period",
"days_visited",
"min_days_visited",
"num_topics_replied_to",
"min_topics_replied_to",
"topics_viewed",
"min_topics_viewed",
"posts_read",
"min_posts_read",
"topics_viewed_all_time",
"min_topics_viewed_all_time",
"posts_read_all_time",
"min_posts_read_all_time",
"num_flagged_posts",
"max_flagged_posts",
"num_flagged_by_users",
"max_flagged_by_users",
"num_likes_given",
"min_likes_given",
"num_likes_received",
"min_likes_received",
"num_likes_received_days",
"min_likes_received_days",
"num_likes_received_users",
"min_likes_received_users",
"penalty_counts"
]
},
"groups": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"automatic": {
"type": "boolean"
},
"name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"user_count": {
"type": "integer"
},
"mentionable_level": {
"type": "integer"
},
"messageable_level": {
"type": "integer"
},
"visibility_level": {
"type": "integer"
},
"primary_group": {
"type": "boolean"
},
"title": {
"type": [
"string",
"null"
]
},
"grant_trust_level": {
"type": [
"string",
"null"
]
},
"incoming_email": {
"type": [
"string",
"null"
]
},
"has_messages": {
"type": "boolean"
},
"flair_url": {
"type": [
"string",
"null"
]
},
"flair_bg_color": {
"type": [
"string",
"null"
]
},
"flair_color": {
"type": [
"string",
"null"
]
},
"bio_raw": {
"type": [
"string",
"null"
]
},
"bio_cooked": {
"type": [
"string",
"null"
]
},
"bio_excerpt": {
"type": [
"string",
"null"
]
},
"public_admission": {
"type": "boolean"
},
"public_exit": {
"type": "boolean"
},
"allow_membership_requests": {
"type": "boolean"
},
"full_name": {
"type": [
"string",
"null"
]
},
"default_notification_level": {
"type": "integer"
},
"membership_request_template": {
"type": [
"string",
"null"
]
},
"members_visibility_level": {
"type": "integer"
},
"can_see_members": {
"type": "boolean"
},
"can_admin_group": {
"type": "boolean"
},
"publish_read_state": {
"type": "boolean"
}
},
"required": [
"id",
"automatic",
"name",
"display_name",
"user_count",
"mentionable_level",
"messageable_level",
"visibility_level",
"primary_group",
"title",
"grant_trust_level",
"incoming_email",
"has_messages",
"flair_url",
"flair_bg_color",
"flair_color",
"bio_raw",
"bio_cooked",
"bio_excerpt",
"public_admission",
"public_exit",
"allow_membership_requests",
"full_name",
"default_notification_level",
"membership_request_template",
"members_visibility_level",
"can_see_members",
"can_admin_group",
"publish_read_state"
]
}
]
}
},
"required": [
"id",
"username",
"name",
"avatar_template",
"active",
"admin",
"moderator",
"last_seen_at",
"last_emailed_at",
"created_at",
"last_seen_age",
"last_emailed_age",
"created_at_age",
"trust_level",
"manual_locked_trust_level",
"flag_level",
"title",
"time_read",
"staged",
"days_visited",
"posts_read_count",
"topics_entered",
"post_count",
"can_send_activation_email",
"can_activate",
"can_deactivate",
"ip_address",
"registration_ip_address",
"can_grant_admin",
"can_revoke_admin",
"can_grant_moderation",
"can_revoke_moderation",
"can_impersonate",
"like_count",
"like_given_count",
"topic_count",
"flags_given_count",
"flags_received_count",
"private_topics_count",
"can_delete_all_posts",
"can_be_deleted",
"can_be_anonymized",
"can_be_merged",
"full_suspend_reason",
"silence_reason",
"primary_group_id",
"badge_count",
"warnings_received_count",
"bounce_score",
"reset_bounce_score_after",
"can_view_action_logs",
"can_disable_second_factor",
"can_delete_sso_record",
"api_key_count",
"single_sign_on_record",
"approved_by",
"suspended_by",
"silenced_by",
"groups"
]
}

12
spec/requests/api/schemas/json/success_ok_response.json Normal file
View File

@@ -0,0 +1,12 @@
{
"additionalProperties": false,
"properties": {
"success": {
"type": "string",
"example": "OK"
}
},
"required": [
"success"
]
}

146
spec/requests/api/schemas/json/user_actions_response.json Normal file
View File

@@ -0,0 +1,146 @@
{
"additionalProperties": false,
"properties": {
"user_actions": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"excerpt": {
"type": "string"
},
"action_type": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"avatar_template": {
"type": "string"
},
"acting_avatar_template": {
"type": "string"
},
"slug": {
"type": "string"
},
"topic_id": {
"type": "integer"
},
"target_user_id": {
"type": "integer"
},
"target_name": {
"type": [
"string",
"null"
]
},
"target_username": {
"type": "string"
},
"post_number": {
"type": "integer"
},
"post_id": {
"type": [
"string",
"null"
]
},
"username": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"user_id": {
"type": "integer"
},
"acting_username": {
"type": "string"
},
"acting_name": {
"type": [
"string",
"null"
]
},
"acting_user_id": {
"type": "integer"
},
"title": {
"type": "string"
},
"deleted": {
"type": "boolean"
},
"hidden": {
"type": [
"string",
"null"
]
},
"post_type": {
"type": [
"string",
"null"
]
},
"action_code": {
"type": [
"string",
"null"
]
},
"category_id": {
"type": "integer"
},
"closed": {
"type": "boolean"
},
"archived": {
"type": "boolean"
}
},
"required": [
"excerpt",
"action_type",
"created_at",
"avatar_template",
"acting_avatar_template",
"slug",
"topic_id",
"target_user_id",
"target_name",
"target_username",
"post_number",
"post_id",
"username",
"name",
"user_id",
"acting_username",
"acting_name",
"acting_user_id",
"title",
"deleted",
"hidden",
"post_type",
"action_code",
"category_id",
"closed",
"archived"
]
}
]
}
},
"required": [
"user_actions"
]
}

17
spec/requests/api/schemas/json/user_delete_request.json Normal file
View File

@@ -0,0 +1,17 @@
{
"additionalProperties": false,
"properties": {
"delete_posts": {
"type": "boolean"
},
"block_email": {
"type": "boolean"
},
"block_urls": {
"type": "boolean"
},
"block_ip": {
"type": "boolean"
}
}
}

11
spec/requests/api/schemas/json/user_delete_response.json Normal file
View File

@@ -0,0 +1,11 @@
{
"additionalProperties": false,
"properties": {
"deleted": {
"type": "boolean"
}
},
"required": [
"deleted"
]
}

15
spec/requests/api/schemas/json/user_refresh_gravatar_response.json Normal file
View File

@@ -0,0 +1,15 @@
{
"additionalProperties": false,
"properties": {
"gravatar_upload_id": {
"type": ["integer", "null"]
},
"gravatar_avatar_template": {
"type": ["string", "null"]
}
},
"required": [
"gravatar_upload_id",
"gravatar_avatar_template"
]
}

21
spec/requests/api/schemas/json/user_update_avatar_request.json Normal file
View File

@@ -0,0 +1,21 @@
{
"additionalProperties": false,
"properties": {
"upload_id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"uploaded",
"custom",
"gravatar",
"system"
]
}
},
"required": [
"upload_id",
"type"
]
}

12
spec/requests/api/schemas/json/user_update_email_request.json Normal file
View File

@@ -0,0 +1,12 @@
{
"additionalProperties": false,
"properties": {
"email": {
"type": "string",
"format": "email"
}
},
"required": [
"email"
]
}

109
spec/requests/api/schemas/json/users_public_list_response.json Normal file
View File

@@ -0,0 +1,109 @@
{
"additionalProperties": false,
"properties": {
"directory_items": {
"type": "array",
"items": [
{
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"likes_received": {
"type": "integer"
},
"likes_given": {
"type": "integer"
},
"topics_entered": {
"type": "integer"
},
"topic_count": {
"type": "integer"
},
"post_count": {
"type": "integer"
},
"posts_read": {
"type": "integer"
},
"days_visited": {
"type": "integer"
},
"user": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"username": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"avatar_template": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"username",
"name",
"avatar_template",
"title"
]
}
},
"required": [
"id",
"likes_received",
"likes_given",
"topics_entered",
"topic_count",
"post_count",
"posts_read",
"days_visited",
"user"
]
}
]
},
"meta": {
"type": "object",
"additionalProperties": false,
"properties": {
"last_updated_at": {
"type": ["string", "null"]
},
"total_rows_directory_items": {
"type": "integer"
},
"load_more_directory_items": {
"type": "string"
}
},
"required": [
"last_updated_at",
"total_rows_directory_items",
"load_more_directory_items"
]
}
},
"required": [
"directory_items",
"meta"
]
}