Last modified: 2014-09-24 00:49:45 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 T31936, the corresponding Phabricator task for complete and up-to-date bug report information.
First Last Prev Next    This bug is not in your last search results.
Bug 29936 - Api documentation on mw.org is out of date, incomplete
Api documentation on mw.org is out of date, incomplete
Status: NEW
Product: MediaWiki
Classification: Unclassified
Documentation (Other open bugs)
1.20.x
All All
: Normal enhancement (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on: 42687 56204 58339
Blocks: documentation
  Show dependency tree / graph
 
Reported: 2011-07-17 17:15 UTC by Sam Reed (reedy)
Modified: 2014-09-24 00:49 UTC (History)
8 users (show)

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

Attachments
Add an attachment (proposed patch, testcase, etc.)

Description Sam Reed (reedy) 2011-07-17 17:15:23 UTC 
While fixing bug 28817, I noticed there are numerous (I'll make a list shortly) of modules that don't (seem) to have documentation pages on mw.org
Comment 1 Sam Reed (reedy) 2011-07-17 17:20:12 UTC 
ApiComparePages
ApiFeedContributions
ApiFileRevert
ApiPageSet (is one really needed?)
ApiQueryFilearchive
ApiQueryIWBacklinks
ApiQueryIWLinks
ApiQueryLangBacklinks
ApiQueryQueryPage
ApiQueryStashImageInfo
ApiQueryWatchlistRaw
ApiResult (is one really needed?)
ApiRsd

Maybe we just use Zaks tool to pull from the inline text (Krinkle?)
Comment 2 Krinkle 2011-07-31 04:31:40 UTC 
A few months back I've asked Zak to publish his tool into the repository[1], but never heard back from him. I'll ask him again.


[1] http://svn.wikimedia.org/viewvc/mediawiki/trunk/tools/mediawiki-api-wikidocgen/
Comment 3 Ariel Test Glenn 2011-11-24 19:14:34 UTC 
Is this bug still accurate (api docs out of date)?
Comment 4 Sam Reed (reedy) 2011-11-24 19:17:45 UTC 
I think it is to some extent, but nowhere near as bad as it was...

Needs checking again, as we've added a few more modules
Comment 5 Sumana Harihareswara 2012-02-22 06:24:56 UTC 
CC'ing Ben Lobaugh as he's interested in improving API docs on mediawiki.org.
Comment 7 Bawolff (Brian Wolff) 2012-07-25 12:08:55 UTC 
(In reply to comment #6)
> I think Bawolff disagrees? 
> <https://www.mediawiki.org/wiki/Talk:Wikimedia_Engineering/2012-13_Goals#Documentation>

Oh I don't think API docs are perfect, I just think they're much better than everything else.
Comment 8 Quim Gil 2013-04-23 14:25:19 UTC 
(In reply to comment #3)
> Is this bug still accurate (api docs out of date)?
Comment 9 Sam Reed (reedy) 2013-04-23 15:58:48 UTC 
Very likley
Comment 10 Sumana Harihareswara 2014-09-23 23:17:23 UTC 
https://www.mediawiki.org/wiki/Data_%26_Developer_Hub is related.
Note You need to log in before you can comment on or make changes to this bug.
First Last Prev Next    This bug is not in your last search results.

Navigation
Links