mirror of
https://github.com/discourse/discourse.git
synced 2025-02-25 18:55:32 -06:00
document api endpoints (#11958)
* DEV: Documented several group endpoints * documented some more endpoints * document more api endpoints * Document backup endpoints * remove puts
This commit is contained in:
140
spec/requests/api/schemas/json/group_members_response.json
Normal file
140
spec/requests/api/schemas/json/group_members_response.json
Normal file
@@ -0,0 +1,140 @@
|
||||
{
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"members": {
|
||||
"type": "array",
|
||||
"items": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"avatar_template": {
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"last_posted_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"last_seen_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"added_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"timezone": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"username",
|
||||
"name",
|
||||
"avatar_template",
|
||||
"title",
|
||||
"last_posted_at",
|
||||
"last_seen_at",
|
||||
"added_at",
|
||||
"timezone"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"owners": {
|
||||
"type": "array",
|
||||
"items": [
|
||||
{
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"avatar_template": {
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"type": [
|
||||
"string",
|
||||
"null"
|
||||
]
|
||||
},
|
||||
"last_posted_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"last_seen_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"added_at": {
|
||||
"type": "string"
|
||||
},
|
||||
"timezone": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"id",
|
||||
"username",
|
||||
"name",
|
||||
"avatar_template",
|
||||
"title",
|
||||
"last_posted_at",
|
||||
"last_seen_at",
|
||||
"added_at",
|
||||
"timezone"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"meta": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"total": {
|
||||
"type": "integer"
|
||||
},
|
||||
"limit": {
|
||||
"type": "integer"
|
||||
},
|
||||
"offset": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"total",
|
||||
"limit",
|
||||
"offset"
|
||||
]
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"members",
|
||||
"owners",
|
||||
"meta"
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user