From cb5fedd4677cd77e542e1ae28950fe83f4b93b7f Mon Sep 17 00:00:00 2001 From: Roan Kattouw Date: Mon, 9 Mar 2009 10:36:48 +0000 Subject: [PATCH] API: (bug 17873) Mention the 'g' prefix for generator parameters in the api.php help --- includes/api/ApiQuery.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index 75792ff6c7..c9699110d9 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -553,7 +553,8 @@ class ApiQuery extends ApiBase { 'prop' => 'Which properties to get for the titles/revisions/pageids', 'list' => 'Which lists to get', 'meta' => 'Which meta data to get about the site', - 'generator' => 'Use the output of a list as the input for other prop/list/meta items', + 'generator' => array('Use the output of a list as the input for other prop/list/meta items', + 'NOTE: generator parameter names must be prefixed with a \'g\', see examples.'), 'redirects' => 'Automatically resolve redirects', 'indexpageids' => 'Include an additional pageids section listing all returned page IDs.', 'export' => 'Export the current revisions of all given or generated pages', @@ -571,7 +572,8 @@ class ApiQuery extends ApiBase { protected function getExamples() { return array ( - 'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment' + 'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment', + 'api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions', ); } -- 2.20.1