{
"openapi": "3.1.0",
"info": {
"title": "User status",
"version": "1.7.0",
"description": "User status",
"license": {
"name": "agpl",
"identifier": "AGPL-3.0"
}
},
"servers": [
"url": "https://{hostname}:{port}",
"variables": {
"hostname": {
"default": "localhost"
"port": {
"default": "8080"
],
"security": [
"basic_auth": []
"tags": [],
"components": {
"schemas": {
"OCSMeta": {
"type": "object",
"required": [
"status",
"statuscode"
"properties": {
"status": {
"type": "string"
"statuscode": {
"type": "integer"
"message": {
"totalitems": {
"itemsperpage": {
"EmptyOCS": {
"ocs"
"ocs": {
"meta",
"data"
"meta": {
"$ref": "#/components/schemas/OCSMeta"
"data": {
"type": "array"
"PredefinedStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PredefinedStatus"
"PredefinedStatus": {
"id",
"icon",
"message"
"id": {
"icon": {
"clearAt": {
"oneOf": [
"$ref": "#/components/schemas/ClearAt"
"type": "integer",
"description": "Time as unix timestamp"
]
"ClearAt": {
"type",
"time"
"type": {
"type": "string",
"enum": [
"period",
"end-of"
"time": {
"day",
"week"
"description": "Time offset in seconds"
"Type": {
"online",
"offline",
"dnd",
"away",
"invisible"
"GetStatus": {
"type": "object"
"$ref": "#/components/schemas/Status"
"GetPublicStatuses": {
"$ref": "#/components/schemas/PublicStatus"
"GetPublicStatus": {
"Status": {
"allOf": [
"messageIsPredefined",
"statusIsUserDefined"
"messageId": {
"messageIsPredefined": {
"type": "boolean"
"statusIsUserDefined": {
"PublicStatus": {
"userId",
"status"
"userId": {
"$ref": "#/components/schemas/Type"
"Heartbeat": {
"securitySchemes": {
"basic_auth": {
"type": "http",
"scheme": "basic"
"paths": {
"/ocs/v2.php/apps/user_status/api/v1/statuses": {
"get": {
"operationId": "get-public-statuses",
"tags": [
"user_status"
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetPublicStatuses"
"/ocs/v2.php/apps/user_status/api/v1/statuses/{userId}": {
"parameters": [
"name": "userId",
"in": "path",
"required": true,
"operationId": "get-public-status",
"$ref": "#/components/schemas/GetPublicStatus"
"/ocs/v2.php/apps/user_status/api/v1/user_status": {
"operationId": "get-status",
"$ref": "#/components/schemas/GetStatus"
"/ocs/v2.php/apps/user_status/api/v1/user_status/status": {
"put": {
"operationId": "set-status",
"name": "statusType",
"in": "query",
"/ocs/v2.php/apps/user_status/api/v1/user_status/message/predefined": {
"operationId": "set-predefined-message",
"name": "messageId",
"name": "clearAt",
"required": false,
"/ocs/v2.php/apps/user_status/api/v1/user_status/message/custom": {
"operationId": "set-custom-message",
"name": "statusIcon",
"name": "message",
"/ocs/v2.php/apps/user_status/api/v1/user_status/message": {
"delete": {
"operationId": "clear-message",
"description": ""
"/ocs/v2.php/apps/user_status/api/v1/predefined_statuses": {
"operationId": "get-predefined-statuses",
"$ref": "#/components/schemas/PredefinedStatuses"
"/ocs/v2.php/apps/user_status/api/v1/heartbeat": {
"operationId": "heartbeat",
"name": "status",
"$ref": "#/components/schemas/Heartbeat"