Legoktm has just merged Gerrit change 160798,[1] Gerrit change 161093,[2] Gerrit change 160819,[3] and a few associated patches. Collectively, these make the following changes to the human-readable aspects of the API output, which will be deployed to WMF wikis with 1.25wmf4 (see https://www.mediawiki.org/wiki/MediaWiki_1.25/Roadmap for the schedule).
* action=help now outputs a nice HTML page instead of a plain-text document wrapped in XML. * Hitting api.php with no parameters will display help for the main module only, with links to each submodule. One of the examples provided shows how to get everything on one page as with the old help. * The default for the 'format' parameter is now jsonfm rather than xmlfm. * Syntax highlighting for format=jsonfm and format=xmlfm now uses Extension:SyntaxHighlight_GeSHi rather than ad-hoc code that only worked right for xmlfm. Other formats are not highlighted.
The patches also change the aspects of action=paraminfo that return help-related information: * Module description is no longer returned by default; a new parameter selects html, wikitext, or raw Message data. * The 'examples' result property is now an array rather than a string. * The 'allexamples' result property has been removed. * Parameter descriptions are no longer returned by default; a new parameter selects html, wikitext, or raw Message data. Machine-readable parameter info remains available.
The impact of these changes on existing bots and scripts is expected to be minimal, as non-human consumption is likely to be limited to ApiSandbox.
[1]: https://gerrit.wikimedia.org/r/#/c/160798 [2]: https://gerrit.wikimedia.org/r/#/c/161093 [2]: https://gerrit.wikimedia.org/r/#/c/160819
Le 14/10/2014 01:34, Brad Jorsch (Anomie) a écrit :
Legoktm has just merged Gerrit change 160798,[1] Gerrit change 161093,[2] Gerrit change 160819,[3] and a few associated patches. Collectively, these make the following changes to the human-readable aspects of the API output, which will be deployed to WMF wikis with 1.25wmf4 (see https://www.mediawiki.org/wiki/MediaWiki_1.25/Roadmap for the schedule).
- action=help now outputs a nice HTML page instead of a plain-text
document wrapped in XML.
- Hitting api.php with no parameters will display help for the main
module only, with links to each submodule. One of the examples provided shows how to get everything on one page as with the old help.
- The default for the 'format' parameter is now jsonfm rather than xmlfm.
- Syntax highlighting for format=jsonfm and format=xmlfm now uses
Extension:SyntaxHighlight_GeSHi rather than ad-hoc code that only worked right for xmlfm. Other formats are not highlighted.
<snip>
Thank you very much to everyone involved. The API landing pages looks way nicer this way :-)
Il 20/10/2014 10:35, Antoine Musso ha scritto:
Le 14/10/2014 01:34, Brad Jorsch (Anomie) a écrit :
Legoktm has just merged Gerrit change 160798,[1] Gerrit change 161093,[2] Gerrit change 160819,[3] and a few associated patches. Collectively, these make the following changes to the human-readable aspects of the API output, which will be deployed to WMF wikis with 1.25wmf4 (see https://www.mediawiki.org/wiki/MediaWiki_1.25/Roadmap for the schedule).
- action=help now outputs a nice HTML page instead of a plain-text
document wrapped in XML.
- Hitting api.php with no parameters will display help for the main
module only, with links to each submodule. One of the examples provided shows how to get everything on one page as with the old help.
- The default for the 'format' parameter is now jsonfm rather than xmlfm.
- Syntax highlighting for format=jsonfm and format=xmlfm now uses
Extension:SyntaxHighlight_GeSHi rather than ad-hoc code that only worked right for xmlfm. Other formats are not highlighted.
<snip>
Thank you very much to everyone involved. The API landing pages looks way nicer this way :-)
Such an awesome change made the ApiExplorer https://www.mediawiki.org/wiki/Extension:ApiExplorer extension pretty useless, didn't it?
Hi,
at some point I miss that 1 huge page where I could find everything in 3 seconds just by using ctrl+f, there should be a way to display it, or there should be at least some api for it :P 1 page documentations are sometimes better than docs split into zillions of html documents
On Sun, Oct 26, 2014 at 9:19 PM, Ricordisamoa ricordisamoa@openmailbox.org wrote:
Il 20/10/2014 10:35, Antoine Musso ha scritto:
Le 14/10/2014 01:34, Brad Jorsch (Anomie) a écrit :
Legoktm has just merged Gerrit change 160798,[1] Gerrit change 161093,[2] Gerrit change 160819,[3] and a few associated patches. Collectively, these make the following changes to the human-readable aspects of the API output, which will be deployed to WMF wikis with 1.25wmf4 (see https://www.mediawiki.org/wiki/MediaWiki_1.25/Roadmap for the schedule).
- action=help now outputs a nice HTML page instead of a plain-text
document wrapped in XML.
- Hitting api.php with no parameters will display help for the main
module only, with links to each submodule. One of the examples provided shows how to get everything on one page as with the old help.
- The default for the 'format' parameter is now jsonfm rather than xmlfm.
- Syntax highlighting for format=jsonfm and format=xmlfm now uses
Extension:SyntaxHighlight_GeSHi rather than ad-hoc code that only worked right for xmlfm. Other formats are not highlighted.
<snip>
Thank you very much to everyone involved. The API landing pages looks way nicer this way :-)
Such an awesome change made the ApiExplorer https://www.mediawiki.org/wiki/Extension:ApiExplorer extension pretty useless, didn't it?
Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
Il 26/10/2014 22:44, Petr Bena ha scritto:
Hi,
at some point I miss that 1 huge page where I could find everything in 3 seconds just by using ctrl+f, there should be a way to display it, or there should be at least some api for it :P 1 page documentations are sometimes better than docs split into zillions of html documents
I have to agree. Ctrl+F is still a use case ;-)
On 10/26/14 2:44 PM, Petr Bena wrote:
Hi,
at some point I miss that 1 huge page where I could find everything in 3 seconds just by using ctrl+f, there should be a way to display it, or there should be at least some api for it :P 1 page documentations are sometimes better than docs split into zillions of html documents
If you scroll down a bit, there's a link that says "All help in one page" and sends you to https://www.mediawiki.org/w/api.php?action=help&recursivesubmodules=1.
-- Legoktm
On Sun, 26 Oct 2014 22:44:53 +0100, Petr Bena benapetr@gmail.com wrote:
at some point I miss that 1 huge page where I could find everything in 3 seconds just by using ctrl+f, there should be a way to display it, or there should be at least some api for it :P
There in fact is, or in fact are.
https://en.wikipedia.org/w/api.php?action=help&recursivesubmodules=1
(That link is displayed as one of the examples on the main API page, described as "All help in one page".)
Aha, in that case I like it :))
On Sun, Oct 26, 2014 at 11:59 PM, Bartosz Dziewoński matma.rex@gmail.com wrote:
On Sun, 26 Oct 2014 22:44:53 +0100, Petr Bena benapetr@gmail.com wrote:
at some point I miss that 1 huge page where I could find everything in 3 seconds just by using ctrl+f, there should be a way to display it, or there should be at least some api for it :P
There in fact is, or in fact are.
https://en.wikipedia.org/w/api.php?action=help&recursivesubmodules=1
(That link is displayed as one of the examples on the main API page, described as "All help in one page".)
-- Bartosz Dziewoński
Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
This is great--so much more usable. Thanks to everyone who contributed to these changes!
Frances
On Mon, Oct 13, 2014 at 4:34 PM, Brad Jorsch (Anomie) bjorsch@wikimedia.org wrote:
Legoktm has just merged Gerrit change 160798,[1] Gerrit change 161093,[2] Gerrit change 160819,[3] and a few associated patches. Collectively, these make the following changes to the human-readable aspects of the API output, which will be deployed to WMF wikis with 1.25wmf4 (see https://www.mediawiki.org/wiki/MediaWiki_1.25/Roadmap for the schedule).
- action=help now outputs a nice HTML page instead of a plain-text document
wrapped in XML.
- Hitting api.php with no parameters will display help for the main module
only, with links to each submodule. One of the examples provided shows how to get everything on one page as with the old help.
- The default for the 'format' parameter is now jsonfm rather than xmlfm.
- Syntax highlighting for format=jsonfm and format=xmlfm now uses
Extension:SyntaxHighlight_GeSHi rather than ad-hoc code that only worked right for xmlfm. Other formats are not highlighted.
The patches also change the aspects of action=paraminfo that return help-related information:
- Module description is no longer returned by default; a new parameter
selects html, wikitext, or raw Message data.
- The 'examples' result property is now an array rather than a string.
- The 'allexamples' result property has been removed.
- Parameter descriptions are no longer returned by default; a new parameter
selects html, wikitext, or raw Message data. Machine-readable parameter info remains available.
The impact of these changes on existing bots and scripts is expected to be minimal, as non-human consumption is likely to be limited to ApiSandbox.
-- Brad Jorsch (Anomie) Software Engineer Wikimedia Foundation _______________________________________________ Wikitech-l mailing list Wikitech-l@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/wikitech-l
wikitech-l@lists.wikimedia.org