Last modified: 2011-11-14 14:25:43 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 T31935, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 29935 - Improve formatting of examples in ApiParamInfo
Improve formatting of examples in ApiParamInfo
Status: RESOLVED FIXED
Product: MediaWiki
Classification: Unclassified
API (Other open bugs)
1.20.x
All All
: Unprioritized enhancement (vote)
: ---
Assigned To: Roan Kattouw
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2011-07-17 17:14 UTC by Sam Reed (reedy)
Modified: 2011-11-14 14:25 UTC (History)
4 users (show)

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


Attachments

Description Sam Reed (reedy) 2011-07-17 17:14:05 UTC
examples="Get data with content for the last revision of titles "API" and "Main Page":
  api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content
Get last 5 revisions of the "Main Page":
  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment
Get first 5 revisions of the "Main Page":
  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer
Get first 5 revisions of the "Main Page" made after 2006-05-01:
  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000
Get first 5 revisions of the "Main Page" that were not made made by anonymous user "127.0.0.1"
  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1
Get first 5 revisions of the "Main Page" that were made by the user "MediaWiki default"
  api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default"

Is not pretty. Using an encoded \n between a list of strings

As such, when implemeting help urls, I switched it to be like

        <helpurls>          <helpurl>http://www.mediawiki.org/wiki/API:Properties#revisions_.2F_rv</helpurl>
        </helpurls>


As such, I know changing from the (crappy) inline attribute, to a list of elements is a "breaking change", how about doing both (?) for a while, and then sometime in the future, drop the nasty way?

I know it's not so much of a breaking change, as it's not parameter renaming, but it is a format change
Comment 1 Sam Reed (reedy) 2011-07-18 13:20:04 UTC
r92430 does the formatting

Just need to decide about the old one...
Comment 2 Sam Reed (reedy) 2011-11-14 14:25:43 UTC
Removing the old would be breaking. Closing bug as fixed

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


Navigation
Links