webservice MDL-20803 add web service documentation generator

group/externallib.php

@@ -43,7 +43,7 @@ public static function create_groups_parameters() {
                             'description' => new external_value(PARAM_RAW, 'group description text'),
                             'enrolmentkey' => new external_value(PARAM_RAW, 'group enrol secret phrase'),
                         )
-                    )
+                    ), 'List of group object. A group has a courseid, a name, a description and an enrolment key.'
                 )
             )
         );
@@ -103,7 +103,7 @@ public static function create_groups_returns() {
                     'description' => new external_value(PARAM_RAW, 'group description text'),
                     'enrolmentkey' => new external_value(PARAM_RAW, 'group enrol secret phrase'),
                 )
-            )
+            ), 'List of group object. A group has an id, a courseid, a name, a description and an enrolment key.'
         );
     }
 
@@ -114,7 +114,8 @@ public static function create_groups_returns() {
     public static function get_groups_parameters() {
         return new external_function_parameters(
             array(
-                'groupids' => new external_multiple_structure(new external_value(PARAM_INT, 'Group ID')),
+                'groupids' => new external_multiple_structure(new external_value(PARAM_INT, 'Group ID')
+                        ,'List of group id. A group id is an integer.'),
             )
         );
     }

lang/en_utf8/webservice.php

@@ -6,12 +6,17 @@
 $string['addrequiredcapability'] = 'Assign/Unassign the required capability';
 $string['addservice'] = 'Add a new service: $a->name (id: $a->id)';
 $string['actwebserviceshhdr'] = 'Active web service protocols';
+$string['apiexplorer'] = 'API explorer';
+$string['apiexplorernotavalaible'] = 'API explorer not available yet.';
+$string['arguments'] = 'Arguments';
 $string['configwebserviceplugins'] = 'For security reasons enable only protocols that are used.';
 $string['deleteservice'] = 'Delete the service: $a->name (id: $a->id)';
 $string['deleteserviceconfirm'] = 'Do you really want to delete external service \"$a\"?';
 $string['disabledwarning'] = 'All webs service protocols are disabled, the \Enable web services\" setting can be found in the \"Advanced features\" section.';
 $string['editservice'] = 'Edit the service: $a->name (id: $a->id)';
 $string['enabled'] = 'Enabled';
+$string['error'] = 'Error: $a';
+$string['errorcodes'] = 'Error Codes';
 $string['execute'] = 'Execute';
 $string['executewarnign'] = 'WARNING: if you press execute your database will be modified and changes can not be reverted automatically!';
 $string['externalservices'] = 'External services';
@@ -22,15 +27,21 @@
 $string['functions'] = 'Functions';
 $string['iprestriction'] = 'IP restriction';
 $string['manageprotocols'] = 'Manage protocols';
+$string['noerrorcode'] = 'No error code';
 $string['norequiredcapability'] = 'No required capability';
+$string['optional'] = 'Optional';
 $string['potusers'] = 'Not authorised users';
 $string['potusersmatching'] = 'Not authorised users matching';
 $string['protocol'] = 'Protocol';
 $string['removefunction'] = 'Remove';
 $string['removefunctionconfirm'] = 'Do you really want to remove function \"$a->function\" from service \"$a->service\"?';
+$string['requireauthentication'] = 'This method requires authentication with xxx permission.';
+$string['required'] = 'Required';
 $string['requiredcapability'] = 'Required capability';
-$string['selectedcapabilitydoesntexit'] = 'The currently set required capability ($a) doesn\'t exist anymore. Please change it and save the changes.';
+$string['response'] = 'Response';
+$string['restcode'] = 'REST code';
 $string['restrictedusers'] = 'Authorised users only';
+$string['selectedcapabilitydoesntexit'] = 'The currently set required capability ($a) doesn\'t exist anymore. Please change it and save the changes.';
 $string['selectedcapability'] = 'Selected';
 $string['servicename'] = 'Service name';
 $string['servicesbuiltin'] = 'Built-in services';
@@ -41,3 +52,9 @@
 $string['testclient'] = 'Web service test client';
 $string['validuntil'] = 'Valid until';
 $string['webservices'] = 'Web services';
+$string['wsdocumentation'] = 'Web service documentation';
+$string['wsdocumentationintro'] = 'Following a listing of web service functions available for the username <b>$a</b>.<br/>In order to create a client we advice you to read the <a href=\"http://docs.moodle.org/en/Development:Creating_a_web_service_and_a_web_service_function#Create_your_own_client\">Moodle documentation</a>';
+$string['wsdocumentationlogin'] = 'Enter your web service username and password.';
+$string['wspassword'] = 'Web service password';
+$string['wsusername'] = 'Web service username';
+$string['xmlrpcstructure'] = 'XML-RPC structure';