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:
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

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