From 2afffae7fc2d0966fefd4cffb4d8f816f581c405 Mon Sep 17 00:00:00 2001 From: Georg Ehrke Date: Sat, 19 Dec 2015 23:42:13 +0100 Subject: [PATCH] Destroyed REST Backend API (markdown) --- REST-Backend-API.md | 161 -------------------------------------------- 1 file changed, 161 deletions(-) delete mode 100644 REST-Backend-API.md diff --git a/REST-Backend-API.md b/REST-Backend-API.md deleted file mode 100644 index 97843ef..0000000 --- a/REST-Backend-API.md +++ /dev/null @@ -1,161 +0,0 @@ -OBSOLETE - WILL BE REMOVED -========================== - -The json backend api provides you with information about backends. - -Calls: -- Get all backends: ```GET /v1/backends``` -- Get enabled backends ```GET /v1/backends-enabled``` -- Get disabled backends ```GET /v1/backends-disabled``` -- Get default backend ```GET /v1/backends-default``` - -Structure of data: -```json -[ - { - "backend" : "org.ownCloud.local", - "enabled" : true, - "actions" : { - "calendar" : { - "create" : true, - "update" : true, - "delete" : true, - "merge" : true, - "move" : true - }, - "object" : { - "create" : true, - "update" : true, - "delete" : true - } - }, - "prefixes" : [ - { - "name" : "this ownCloud", - "l10n" : "this ownCloud", - "prefix" : "" - } - ], - "subscriptions" : [ - - ] - }, - { - "backend" : "org.ownCloud.contact", - "enabled" : true, - "actions" : { - "calendar" : { - "create" : false, - "update" : false, - "delete" : false, - "merge" : false, - "move" : false - }, - "object" : { - "create" : false, - "update" : false, - "delete" : false - } - }, - "prefixes" : [ - - ], - "subscriptions" : [ - - ] - }, - { - "backend" : "org.ownCloud.webcal", - "enabled" : true, - "actions" : { - "calendar" : { - "create" : false, - "update" : false, - "delete" : false, - "merge" : false, - "move" : false - }, - "object" : { - "create" : false, - "update" : false, - "delete" : false - } - }, - "prefixes" : [ - - ], - "subscriptions" : [ - { - "name" : "WebCal", - "l10n" : "WebCal", - "type" : "org.ownCloud.webcal" - } - ] - } -] -``` - -Properties: -- backend - - Type: ```string``` - - identifier for backend -- enabled - - Type: ```boolean``` - - whether or not a backend is enabled -- actions - - Type: ```array``` - - Possible actions on this backend - ---- - -- actions.calendar - - Type: ```array``` - - Possible calendar actions on this backend -- actions.calendar.create - - Type: ```boolean``` - - whether or not it's possible to create calendars on this backend -- actions.calendar.update - - Type: ```boolean``` - - whether or not it's possible to update calendars on this backend -- actions.calendar.delete - - Type: ```boolean``` - - whether or not it's possible to delete calendars on this backend -- actions.calendar.merge - - Type: ```boolean``` - - whether or not it's possible to merge calendars on this backend -- actions.calendar.move - - Type: ```boolean``` - - whether or not it's possible to move calendars on this backend - ---- - -- actions.object - - Type: ```array``` - - Possible calendar actions on this backend -- actions.object.create - - Type: ```boolean``` - - whether or not it's possible to create objects on this backend -- actions.object.update - - Type: ```boolean``` - - whether or not it's possible to update objects on this backend -- actions.object.delete - - Type: ```boolean``` - - whether or not it's possible to delete objects on this backend - ---- - -- prefixes - - Type: ```array``` - - array of possible uri-prefixes for this backend -- prefixes.```index``` - - Type: ```array``` - - Array with information about a particular prefix -- prefixes.```index```.name - - Type: ```string``` - - name of prefix -- prefixes.```index```.l10n - - Type: ```string``` - - localized name of prefix -- prefixes.```index```.prefix - - Type: ```string``` - - prefix \ No newline at end of file