diff --git a/admin_manual/configuration_user/instruction_set_for_apps.rst b/admin_manual/configuration_user/instruction_set_for_apps.rst index 5f109b373..1379ae2de 100644 --- a/admin_manual/configuration_user/instruction_set_for_apps.rst +++ b/admin_manual/configuration_user/instruction_set_for_apps.rst @@ -21,9 +21,11 @@ Status codes: Example ^^^^^^^ +:: - * GET ``http://admin:secret@example.com/ocs/v1.php/cloud/apps?filter=enabled`` - * Gets enabled apps + $ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/apps?filter=enabled + +* Gets enabled apps XML output ^^^^^^^^^^ @@ -60,9 +62,11 @@ Status codes: Example ^^^^^^^ +:: - * GET ``http://admin:secret@example.com/ocs/v1.php/cloud/apps/files`` - * Get app info for the ``files`` app + $ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/apps/files + +* Get app info for the ``files`` app XML output ^^^^^^^^^^ @@ -114,9 +118,11 @@ Status codes: Example ^^^^^^^ +:: - * POST ``http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor`` - * Enable the ``files_texteditor`` app + $ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor + +* Enable the ``files_texteditor`` app XML output ^^^^^^^^^^ @@ -148,9 +154,11 @@ Status codes: Example ^^^^^^^ +:: - * DELETE ``http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor`` - * Disable the ``files_texteditor`` app + $ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/apps/files_texteditor + +* Disable the ``files_texteditor`` app XML output ^^^^^^^^^^ diff --git a/admin_manual/configuration_user/instruction_set_for_groups.rst b/admin_manual/configuration_user/instruction_set_for_groups.rst index 287721031..6fa6225f4 100644 --- a/admin_manual/configuration_user/instruction_set_for_groups.rst +++ b/admin_manual/configuration_user/instruction_set_for_groups.rst @@ -21,9 +21,11 @@ Status codes: Example ^^^^^^^ +:: - * GET ``http://admin:secret@example.com/ocs/v1.php/cloud/groups?search=adm`` - * Returns list of groups matching the search string. + $ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/groups?search=adm + +* Returns list of groups matching the search string. XML output ^^^^^^^^^^ @@ -63,10 +65,11 @@ Status codes: Example ^^^^^^^ +:: - * POST ``http://admin:secret@example.com/ocs/v1.php/cloud/groups -d - groupid="newgroup"`` - * Adds a new group called ``newgroup`` + $ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/groups -d groupid="newgroup" + +* Adds a new group called ``newgroup`` XML output ^^^^^^^^^^ @@ -98,9 +101,11 @@ Status codes: Example ^^^^^^^ +:: - * POST ``http://admin:secret@example.com/ocs/v1.php/cloud/groups/admin`` - * Returns a list of users in the ``admin`` group + $ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/groups/admin + +* Returns a list of users in the ``admin`` group XML output ^^^^^^^^^^ @@ -138,10 +143,11 @@ Status codes: Example ^^^^^^^ +:: - * GET - ``https://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup/subadmins`` - * Return the subadmins of the group: ``mygroup`` + $ curl -X GET https://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup/subadmins + +* Return the subadmins of the group: ``mygroup`` XML output ^^^^^^^^^^ @@ -178,9 +184,11 @@ Status codes: Example ^^^^^^^ +:: - * DELETE ``http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup`` - * Delete the group ``mygroup`` + $ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/groups/mygroup + +* Delete the group ``mygroup`` XML output ^^^^^^^^^^ diff --git a/admin_manual/configuration_user/instruction_set_for_users.rst b/admin_manual/configuration_user/instruction_set_for_users.rst index b9b5adb0b..c0cc11ec6 100644 --- a/admin_manual/configuration_user/instruction_set_for_users.rst +++ b/admin_manual/configuration_user/instruction_set_for_users.rst @@ -27,9 +27,10 @@ Status codes: Example ^^^^^^^ +:: + + $ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/users -d userid="Frank" -d password="frankspassword" -* POST ``http://admin:secret@example.com/ocs/v1.php/cloud/users -d - userid="Frank" -d password="frankspassword"`` * Creates the user ``Frank`` with password ``frankspassword`` * optionally groups can be specified by one or more ``groups[]`` query parameters: ``URL -d groups[]="admin" -D groups[]="Team1"`` @@ -68,8 +69,10 @@ Status codes: Example ^^^^^^^ +:: + + $ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/users?search=Frank -* GET ``http://admin:secret@example.com/ocs/v1.php/cloud/users?search=Frank`` * Returns list of users matching the search string. XML output @@ -107,8 +110,11 @@ Status codes: Example ^^^^^^^ - * GET ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank`` - * Returns information on the user ``Frank`` +:: + + $ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank + +* Returns information on the user ``Frank`` XML output ^^^^^^^^^^ @@ -171,13 +177,17 @@ Status codes: Examples ^^^^^^^^ - * PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -d - key="email" -d value="franksnewemail@example.org"`` - * Updates the email address for the user ``Frank`` - - * PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -d - key="quota" -d value="100MB"`` - * Updates the quota for the user ``Frank`` +:: + + $ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -d key="email" -d value="franksnewemail@example.org" + +* Updates the email address for the user ``Frank`` + +:: + + $ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -d key="quota" -d value="100MB" + +* Updates the quota for the user ``Frank`` XML output ^^^^^^^^^^ @@ -211,8 +221,11 @@ Statuscodes: Example ^^^^^^^ - * PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/disable`` - * Disables the user ``Frank`` +:: + + $ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/disable + +* Disables the user ``Frank`` XML output ^^^^^^^^^^ @@ -247,8 +260,11 @@ Statuscodes: Example ^^^^^^^ - * PUT ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/enable`` - * Enables the user ``Frank`` +:: + + $ curl -X PUT http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/enable + +* Enables the user ``Frank`` XML output ^^^^^^^^^^ @@ -283,8 +299,11 @@ Statuscodes: Example ^^^^^^^ - * DELETE ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank`` - * Deletes the user ``Frank`` +:: + + $ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank + +* Deletes the user ``Frank`` XML output ^^^^^^^^^^ @@ -317,8 +336,11 @@ Status codes: Example ^^^^^^^ - * GET ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups`` - * Retrieves a list of groups of which ``Frank`` is a member +:: + + $ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups + +* Retrieves a list of groups of which ``Frank`` is a member XML output ^^^^^^^^^^ @@ -362,9 +384,11 @@ Status codes: Example ^^^^^^^ - * POST ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups - -d groupid="newgroup"`` - * Adds the user ``Frank`` to the group ``newgroup`` +:: + + $ curl -X POST http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -d groupid="newgroup" + +* Adds the user ``Frank`` to the group ``newgroup`` XML output ^^^^^^^^^^ @@ -403,10 +427,11 @@ Status codes: Example ^^^^^^^ - * DELETE - ``http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -d - groupid="newgroup"`` - * Removes the user ``Frank`` from the group ``newgroup`` +:: + + $ curl -X DELETE http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/groups -d groupid="newgroup" + +* Removes the user ``Frank`` from the group ``newgroup`` XML output ^^^^^^^^^^ @@ -444,10 +469,11 @@ Status codes: Example ^^^^^^^ - * POST - ``https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins - -d groupid="group"`` - * Makes the user ``Frank`` a subadmin of the ``group`` group +:: + + $ curl -X POST https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins -d groupid="group" + +* Makes the user ``Frank`` a subadmin of the ``group`` group XML output ^^^^^^^^^^ @@ -485,10 +511,11 @@ Status codes: Example ^^^^^^^ - * DELETE - ``https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins - -d groupid="oldgroup"`` - * Removes ``Frank's`` subadmin rights from the ``oldgroup`` group +:: + + $ curl -X DELETE https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins -d groupid="oldgroup" + +* Removes ``Frank's`` subadmin rights from the ``oldgroup`` group XML output ^^^^^^^^^^ @@ -523,9 +550,11 @@ Status codes: Example ^^^^^^^ - * GET - ``https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins`` - * Returns the groups of which ``Frank`` is a subadmin +:: + + $ curl -X GET https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/subadmins + +* Returns the groups of which ``Frank`` is a subadmin XML output ^^^^^^^^^^ @@ -562,9 +591,11 @@ Status codes: Example ^^^^^^^ - * POST - ``https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/welcome`` - * Sends the welcome email to ``Frank`` +:: + + $ curl -X POST https://admin:secret@example.com/ocs/v1.php/cloud/users/Frank/welcome + +* Sends the welcome email to ``Frank`` XML output ^^^^^^^^^^