Page MenuHomePhabricator

SiteMatrix API module documentation is insufficient
Closed, ResolvedPublic

Description

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.


Version: unspecified
Severity: enhancement

Details

Reference
bz28142