document user endpoints (#11894)

* 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

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"
]
}