Last modified: 2012-02-10 14:39:33 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 T36313, the corresponding Phabricator task for complete and up-to-date bug report information.
Bug 34313 - MediaWiki API intro message about "HTML format" should mention the format parameter
MediaWiki API intro message about "HTML format" should mention the format par...
Status: RESOLVED FIXED
Product: MediaWiki
Classification: Unclassified
API (Other open bugs)
unspecified
All All
: Unprioritized normal (vote)
: ---
Assigned To: Nobody - You can work on this!
:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2012-02-10 02:24 UTC by MZMcBride
Modified: 2012-02-10 14:39 UTC (History)
4 users (show)

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


Attachments

Description MZMcBride 2012-02-10 02:24:27 UTC
At a URL like <https://en.wikipedia.org/w/api.php?action=query&list=blocks>, the API currently says:

---
You are looking at the HTML representation of the XML format.
HTML is good for debugging, but probably is not suitable for your application.
See [complete documentation], or [API help] for more information.
---

I think this blurb should mention the format parameter. I think it's non-obvious that the default format is xmlfm. Maybe even mention the format parameter with a more direct link to the section of the documentation about the format parameter. But nobody wants a wall of text of documentation. They just want to know how to make the output _not_ the HTML format.

Also, I think the language "probably is not suitable for your application" should be toughened up (remove the "probably"), but I'm too lazy to file a separate bug.

Ideally the language would be something like...

---
You are looking at the HTML representation of the XML format.
HTML is good for debugging, but is unsuitable for application use.
Specify the [format parameter] to change the output format.
Please see the [complete documentation] or [API help] for more information.
---
Comment 1 Sam Reed (reedy) 2012-02-10 14:39:33 UTC
r111160

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


Navigation
Links