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 api endpoints (#11958)

Browse Source 
* DEV: Documented several group endpoints

* documented some more endpoints

* document more api endpoints

* Document backup endpoints

* remove puts
This commit is contained in:
Blake Erickson
2021-02-03 17:12:35 -07:00
committed by GitHub
parent e58f9f7a55
commit 151193bb11
18 changed files with 1286 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

115
spec/requests/api/schemas/json/search_response.json Normal file
View File

@@ -0,0 +1,115 @@
{
"additionalProperties": false,
"properties": {
"posts": {
"type": "array",
"items": [
]
},
"users": {
"type": "array",
"items": [
]
},
"categories": {
"type": "array",
"items": [
]
},
"groups": {
"type": "array",
"items": [
]
},
"grouped_search_result": {
"type": ["object", "null"],
"additionalProperties": false,
"properties": {
"more_posts": {
"type": [
"string",
"null"
]
},
"more_users": {
"type": [
"string",
"null"
]
},
"more_categories": {
"type": [
"string",
"null"
]
},
"term": {
"type": "string"
},
"search_log_id": {
"type": "integer"
},
"more_full_page_results": {
"type": [
"string",
"null"
]
},
"can_create_topic": {
"type": "boolean"
},
"error": {
"type": [
"string",
"null"
]
},
"post_ids": {
"type": "array",
"items": [
]
},
"user_ids": {
"type": "array",
"items": [
]
},
"category_ids": {
"type": "array",
"items": [
]
},
"group_ids": {
"type": "array",
"items": [
]
}
},
"required": [
"more_posts",
"more_users",
"more_categories",
"term",
"search_log_id",
"more_full_page_results",
"can_create_topic",
"error",
"post_ids",
"user_ids",
"category_ids",
"group_ids"
]
}
},
"required": [
"grouped_search_result"
]
}