You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
401 lines
8.8 KiB
401 lines
8.8 KiB
{ |
|
"openapi": "3.1.0", |
|
"info": { |
|
"title": "Notifications", |
|
"version": "2.14.0", |
|
"description": "This app provides a backend and frontend for the notification API available in Nextcloud.", |
|
"license": { |
|
"name": "agpl", |
|
"identifier": "AGPL-3.0" |
|
} |
|
}, |
|
"paths": { |
|
"/ocs/v2.php/apps/notifications/api/{apiVersion}/notifications": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "endpoint-listnotifications-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"delete": { |
|
"operationId": "endpoint-deleteallnotifications-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/ocs/v2.php/apps/notifications/api/{apiVersion}/notifications/{id}": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "id", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
} |
|
], |
|
"get": { |
|
"operationId": "endpoint-getnotification-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"delete": { |
|
"operationId": "endpoint-deletenotification-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/ocs/v2.php/apps/notifications/api/{apiVersion}/notifications/exists": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"post": { |
|
"operationId": "endpoint-confirmidsforuser-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "ids", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "array" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/ocs/v2.php/apps/notifications/api/{apiVersion}/push": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
} |
|
], |
|
"post": { |
|
"operationId": "push-registerdevice-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "pushTokenHash", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "devicePublicKey", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "proxyServer", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"delete": { |
|
"operationId": "push-removedevice-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/ocs/v2.php/apps/notifications/api/{apiVersion}/admin_notifications/{userId}": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
}, |
|
{ |
|
"name": "userId", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"post": { |
|
"operationId": "api-generatenotification-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "shortMessage", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "longMessage", |
|
"in": "query", |
|
"required": false, |
|
"schema": { |
|
"type": "string", |
|
"default": "" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/ocs/v2.php/apps/notifications/api/{apiVersion}/settings": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
} |
|
], |
|
"post": { |
|
"operationId": "settings-personal-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "batchSetting", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
}, |
|
{ |
|
"name": "soundNotification", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "soundTalk", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
}, |
|
"/ocs/v2.php/apps/notifications/api/{apiVersion}/settings/admin": { |
|
"parameters": [ |
|
{ |
|
"name": "apiVersion", |
|
"in": "path", |
|
"required": true, |
|
"schema": { |
|
"type": "TODO" |
|
} |
|
} |
|
], |
|
"post": { |
|
"operationId": "settings-admin-TODO", |
|
"tags": [ |
|
"notifications" |
|
], |
|
"parameters": [ |
|
{ |
|
"name": "batchSetting", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "integer" |
|
} |
|
}, |
|
{ |
|
"name": "soundNotification", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
}, |
|
{ |
|
"name": "soundTalk", |
|
"in": "query", |
|
"required": true, |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
], |
|
"responses": { |
|
"200": { |
|
"description": "", |
|
"content": { |
|
"application/json": { |
|
"schema": { |
|
"type": "string" |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |
|
} |