Last modified: 2011-03-22 00:47:12 UTC

Wikimedia Bugzilla is closed!

Wikimedia has migrated from Bugzilla to Phabricator. Bug reports should be created and updated in Wikimedia Phabricator instead. Please create an account in Phabricator and add your Bugzilla email address to it.
Wikimedia Bugzilla is read-only. If you try to edit or create any bug report in Bugzilla you will be shown an intentional error message.
In order to access the Phabricator task corresponding to a Bugzilla report, just remove "static-" from its URL.
You could still run searches in Bugzilla or access your list of votes but bug reports will obviously not be up-to-date in Bugzilla.
Bug 28142 - SiteMatrix API module documentation is insufficient
SiteMatrix API module documentation is insufficient
Status: RESOLVED FIXED
Product: MediaWiki extensions
Classification: Unclassified
SiteMatrix (Other open bugs)
unspecified
All All
: Normal enhancement (vote)
: ---
Assigned To: Sam Reed (reedy)
:
Depends on:
Blocks: noncoreapi
  Show dependency treegraph
 
Reported: 2011-03-21 01:24 UTC by MZMcBride
Modified: 2011-03-22 00:47 UTC (History)
0 users

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


Attachments

Description MZMcBride 2011-03-21 01:24:29 UTC
The SiteMatrix's API module (?action=sitematrix) currently has the following documentation:

----
* action=sitematrix (sm) *
  Get Wikimedia sites list

This module requires read rights
Example:
  api.php?action=sitematrix
----

It would be nice if the documentation explained the various states a wiki can be in (private, fishbowl, closed, etc.) and what each of those mean.

It would also be nice if the documentation explained what "code" means (whether it's unique, where it comes from, etc.) so that developers know whether they need to pay attention to it or if they can safely use it.

Any other parts of the module that are not currently documented should be added as well.
Comment 1 Sam Reed (reedy) 2011-03-22 00:47:12 UTC
r84508

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


Navigation
Links