Last modified: 2011-12-27 16:24:18 UTC

Wikimedia Bugzilla is closed!

Wikimedia migrated from Bugzilla to Phabricator. Bug reports are handled in Wikimedia Phabricator.
This static website is read-only and for historical purposes. It is not possible to log in and except for displaying bug reports and their history, links might be broken. See T35147, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 33147 - API examples should explain what they do
API examples should explain what they do
Status: RESOLVED FIXED
Product: MediaWiki
Classification: Unclassified
API (Other open bugs)
unspecified
All All
: Unprioritized enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks: 32739
  Show dependency treegraph
 
Reported: 2011-12-15 04:09 UTC by Max Semenik
Modified: 2011-12-27 16:24 UTC (History)
6 users (show)

See Also:
Web browser: ---
Mobile Platform: ---
Assignee Huggle Beta Tester: ---


Attachments

Description Max Semenik 2011-12-15 04:09:35 UTC
Currently, we have only URLs, but users have to guess what they do. This bug is a prerequisite for a sensible implementation of bug 32739.
Comment 1 Sam Reed (reedy) 2011-12-15 13:45:52 UTC
	public function getExamples() {
		return array(
			'api.php?action=compare&fromrev=1&torev=2',
		);
	}

I'm guessing we should just change it to

	public function getExamples() {
		return array(
			'api.php?action=compare&fromrev=1&torev=2' => 'Does a diff between revid 1 and 2',
		);
	}



Then we've just got to display it on the html dump, and via paraminfo

We know if the key is a number, we don't have a description, so we can allow fallback of no extra information for other stuff that hasn't been updated
Comment 2 Sam Reed (reedy) 2011-12-16 15:29:05 UTC
r106439 does the core parts

Still all the documentations to update...
Comment 3 Sam Reed (reedy) 2011-12-19 22:22:52 UTC
r106441 and r106521 I think cover the ones where descriptions are already available, and reformats them

Will log a new bug to actually do the rest of adding new example descriptions
Comment 4 db [inactive,noenotif] 2011-12-22 19:31:27 UTC
reverted with r106879
Comment 5 Sam Reed (reedy) 2011-12-27 16:24:18 UTC
Re-instated r107393

Note You need to log in before you can comment on or make changes to this bug.


Navigation
Links