Page MenuHomePhabricator
Create Task
Maniphest T89229

API Help should generate [try in ApiSandbox] link to Special:ApiSandbox#action=params from getExamples()
Closed, ResolvedPublic
Actions

Description

The API help shown by Special:ApiHelp and action=help includes example API requests. For example Special:ApiHelp/query has this example
api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user%7Ccomment&continue=
which you can click to see the API response.

This is great but if you want to modify parameters it is fiddly to modify the browser URL. If the wiki has Extension:ApiSandbox it would be nice to provide an extra link "[try in ApiSandbox]".

ApiSandbox supports this \o/ , its doHash() function applies anything in the URL fragment (after the hash mark) to its UI. So take the example URL query string, and append it to Special:ApiSandbox# and we get the desired behavior:
https://www.mediawiki.org/wiki/Special:ApiSandbox#action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user%7Ccomment&continue=

I've added [try in ApiSandbox] to mw.org's Template:ApiEx (T89680).

Details

SubjectRepoBranchLines +/-
Add Special:ApiSandboxmediawiki/coremaster+2 K -24
Api help examples add links to Special:ApiSandboxmediawiki/coremaster+19 -3
Add link to Special:ApiSandbox to api.php examplesmediawiki/extensions/ApiSandboxmaster+84 -2
Customize query in gerrit

Related Objects
Search...

Event Timeline

• Spage created this task.Feb 11 2015, 10:31 AM
• Spage raised the priority of this task from to Medium.
• Spage updated the task description. (Show Details)
• Spage added projects: Web-APIs-Hub, MediaWiki-Action-API.
• Spage added subscribers: • Spage, Qgil, Anomie, Aklapper.
gerritbot added a project: Patch-For-Review.Feb 11 2015, 10:43 AM
gerritbot subscribed.

Change 189921 had a related patch set uploaded (by Spage):
Api help examples add links to Special:ApiSandbox

https://gerrit.wikimedia.org/r/189921

Patch-For-Review

Anomie added a comment.Feb 11 2015, 4:07 PM

For that matter, you could have a similar link in the format=*fm header.

BTW, since ApiSandbox only works with JS, ideally the link would be applied using JS.

Umherirrender added a project: MediaWiki-extensions-ApiSandbox.Feb 12 2015, 5:00 PM
Umherirrender set Security to None.
• Spage mentioned this in T89680: Template:ApiEx on mw.org should have a link to "[view in ApiSandbox]"..Feb 16 2015, 11:21 PM
• Spage added a comment.Feb 16 2015, 11:26 PM
In T89229#1031385, @Anomie wrote:

For that matter, you could have a similar link in the format=*fm header.

Do you mean a general link to ApiSandbox for the module, e.g. https://www.mediawiki.org/wiki/Special:ApiSandbox#action=query&prop=extracts ?

BTW, since ApiSandbox only works with JS, ideally the link would be applied using JS.

I agree, I responded in gerrit (thanks for your comments).

• Spage updated the task description. (Show Details)Feb 16 2015, 11:33 PM
gerritbot added a comment.Feb 17 2015, 10:26 AM

Change 191006 had a related patch set uploaded (by Spage):
Add link to Special:ApiSandbox to api.php examples

https://gerrit.wikimedia.org/r/191006

Patch-For-Review

• Spage moved this task from Backlog to Tech on the Web-APIs-Hub board.Feb 17 2015, 10:42 AM
• Spage added a project: ECT-February-2015.Feb 17 2015, 5:08 PM
• Spage claimed this task.Feb 17 2015, 5:10 PM
• Spage moved this task from Backlog to Doing on the ECT-February-2015 board.
Anomie moved this task from Unsorted to Needs Review on the MediaWiki-Action-API board.Feb 19 2015, 6:00 PM
• Spage added a project: ECT-March-2015.Mar 3 2015, 5:38 AM

T89680: Template:ApiEx on mw.org should have a link to "[view in ApiSandbox]". is more important for the Data & developer hub, but this would still useful.

• Spage lowered the priority of this task from Medium to Low.Mar 3 2015, 5:40 AM
• Spage moved this task from Backlog to Doing on the ECT-March-2015 board.Mar 3 2015, 5:43 AM
• Spage mentioned this in T88269: Report the Engineering Community activity for February 2015.Mar 3 2015, 6:17 AM
• Spage mentioned this in P411 Data and developer hub scratchpad.Mar 18 2015, 10:31 AM
• Spage mentioned this in T93770: Engineering Community quarterly goals for April-June 2015.Apr 11 2015, 4:10 AM
Qgil added a project: ECT-April-2015.Apr 15 2015, 9:24 PM

This task was part of ECT-March-2015, and it is still open and assigned. Assuming that it belongs to ECT-April-2015 as well. Otherwise please edit accordingly.

• Spage removed • Spage as the assignee of this task.Apr 21 2015, 10:15 AM

This feature is unlikely to happen before T89386: Merge ApiSandbox extension into core.

• Spage renamed this task from API Help should generate link to Special:ApiSandbox#action=params from getExamples() to API Help should generate [try in ApiSandbox] link to Special:ApiSandbox#action=params from getExamples().Apr 21 2015, 10:16 AM
• Spage updated the task description. (Show Details)
• Spage removed a project: ECT-April-2015.
• Spage mentioned this in T97842: The formatted API result page should link to module-specific API help..May 1 2015, 7:36 PM
Ricordisamoa subscribed.Jun 15 2015, 8:31 AM
Anomie mentioned this in T89863: [Task] Merge on-wiki Wikibase/API documentation into Wikibase apihelp strings..Oct 27 2015, 3:02 PM
gerritbot added a comment.Jan 5 2016, 5:11 AM

Change 209570 had a related patch set uploaded (by Anomie):
Add Special:ApiSandbox

https://gerrit.wikimedia.org/r/209570

gerritbot added a comment.Feb 3 2016, 4:53 PM

Change 209570 merged by jenkins-bot:
Add Special:ApiSandbox

https://gerrit.wikimedia.org/r/209570

Anomie closed this task as Resolved.Feb 3 2016, 5:11 PM
Anomie claimed this task.

Resolved with T89386: Merge ApiSandbox extension into core.

gerritbot added a comment.Feb 7 2016, 10:54 PM

Change 191006 abandoned by Anomie:
Add link to Special:ApiSandbox to api.php examples

Reason:
ApiSandbox was merged into core, so this isn't likely to be needed anymore.

https://gerrit.wikimedia.org/r/191006

gerritbot added a comment.Aug 28 2016, 8:47 AM

Change 189921 abandoned by TTO:
Api help examples add links to Special:ApiSandbox

Reason:
Already implemented in a different way.

https://gerrit.wikimedia.org/r/189921

Aklapper removed a subscriber: Anomie.Oct 16 2020, 5:43 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL