* (bug 23473) - Give description of properties on all modules

[lhc/web/wiklou.git] / includes / api / ApiQueryBlocks.php

diff --git a/includes/api/ApiQueryBlocks.php b/includes/api/ApiQueryBlocks.php
index 45e3a0b..ca4f500 100644 (file)
--- a/includes/api/ApiQueryBlocks.php
+++ b/includes/api/ApiQueryBlocks.php
@@ -271,7 +271,17 @@ class ApiQueryBlocks extends ApiQueryBase {
                        'ip' => array(  'Get all blocks applying to this IP or CIDR range, including range blocks.',
                                        'Cannot be used together with bkusers. CIDR ranges broader than /16 are not accepted' ),
                        'limit' => 'The maximum amount of blocks to list',
-                       'prop' => 'Which properties to get',
+                       'prop' => array(
+                               'Which properties to get',
+                               ' id         - Adds the id of the block',
+                               ' user       - Adds the username of the blocked user',
+                               ' by         - Adds the username of the blocking admin',
+                               ' timestamp  - Adds the timestamp of when the block was given',
+                               ' expiry     - Adds the timestamp of when the block expires',
+                               ' reason     - Adds the reason given for the block',
+                               ' range      - Adds the range of IPs affected by the block',
+                               ' flags      - Tags the ban with (autoblock, anononly, etc)',
+                       ),
                );
        }