71 lines
1.7 KiB
JSON
71 lines
1.7 KiB
JSON
|
{
|
||
|
|
"title": "User",
|
||
|
|
"description": "Describes a user object",
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"id": {
|
||
|
|
"description": "Integer denoting the specific tier",
|
||
|
|
"type": "integer"
|
||
|
|
},
|
||
|
|
"person": {
|
||
|
|
"$ref": "./person.schema.json#/properties/persons/items"
|
||
|
|
},
|
||
|
|
"display_name": {
|
||
|
|
"description": "The display name associated with this user",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"user_name": {
|
||
|
|
"description": "The internal user name associated with this user",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"avatar": {
|
||
|
|
"description": "An avatar associated with this user",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"avatar_decoration": {
|
||
|
|
"description": "An avatar decoration associated with this user",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"login_token": {
|
||
|
|
"description": "The login token associated with this user",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"logged_in": {
|
||
|
|
"description": "Whether a user is currently logged in or not",
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"api_keys": {
|
||
|
|
"description": "A list of api keys this user has generated",
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"description": "An api key object",
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"name": {
|
||
|
|
"description": "A name associated with this api key",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"secret": {
|
||
|
|
"description": "The secret for this api key",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"additionalProperties": false,
|
||
|
|
"required": ["name", "secret"]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"additionalProperties": false,
|
||
|
|
"required": [
|
||
|
|
"id",
|
||
|
|
"person",
|
||
|
|
"display_name",
|
||
|
|
"user_name",
|
||
|
|
"avatar",
|
||
|
|
"avatar_decoration",
|
||
|
|
"login_token",
|
||
|
|
"logged_in",
|
||
|
|
"api_keys"
|
||
|
|
]
|
||
|
|
}
|