Page MenuHomePhabricator

Give action=query higher billing on api main help page
Open, LowestPublic

Description

Not sure if this is a wontfix... But it'd be really useful if the info from https://en.wikipedia.org/w/api.php?action=help&modules=query appeared on https://en.wikipedia.org/w/api.php

It's annoying that I have to try and find query in the wall of action text if I end up at api.php rather than remembering about https://en.wikipedia.org/w/api.php?action=help&recursivesubmodules=1

Or maybe there's some other "better" way of extracting (some) of this information out to a higher level

Event Timeline

Reedy created this task.Feb 16 2015, 4:05 PM
Reedy raised the priority of this task from to Needs Triage.
Reedy updated the task description. (Show Details)
Reedy added a project: MediaWiki-API.
Reedy added a subscriber: Reedy.
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptFeb 16 2015, 4:05 PM
Reedy set Security to None.
Restricted Application added a project: Documentation. · View Herald TranscriptFeb 16 2015, 4:10 PM
Anomie added a subscriber: Anomie.Feb 16 2015, 4:55 PM

About the only way that would really make sense would be to add an example linking to it.

Aklapper triaged this task as Lowest priority.Feb 17 2015, 10:08 AM

I suggest changing the action parameter description (apihelp-main-param-action) from "Which action to perform" to

Which action to perform. If you're trying to get information about a page , you probably will use a prop= submodule of action=query; other query submodules return lists of pages and information about the wiki. View all query submodules.

Or maybe there's some other "better" way of extracting (some) of this information out to a higher level

Which action to perform. If you're trying to get information about a page , you probably will use a prop= submodule of action=query; other query submodules return lists of pages and information about the wiki. View all query submodules.

That's rather verbose and tutorial-ish for a quick-reference parameter description, IMO.

Hi @Reedy I'm Diksha and I'm an outreachy applicant. I want to contribute to this task. May I know how to get started with this?

Restricted Application added a project: Core Platform Team. · View Herald TranscriptWed, Oct 23, 10:05 AM

Hi @Reedy I'm Diksha and I'm an outreachy applicant. I want to contribute to this task. May I know how to get started with this?

As per the other ticket, please see https://www.mediawiki.org/wiki/Gerrit/Tutorial on how to setup and work with our version control to submit a patch.

About the only way that would really make sense would be to add an example linking to it.

This seems a reasonable solution to the problem, though of course is further down than query in the list anyway ;)

I would concur that modifying apihelp-main-param-action doesn't seem the right place to add more information/context. I wonder if apihelp-main-extended-description might be a worthy place to add a comment about it, but then maybe it just gets cluttered?

@Dikshagupta99 Are you able to find how and where the other examples on https://en.wikipedia.org/w/api.php are added to the page in the MediaWiki API PHP code?

You should be able to use these examples to add another in the same places in terms of PHP code, i18n messages and such

Is there any github link for this task where I can clone the repository and make a PR.

Is there any github link for this task where I can clone the repository and make a PR.

We have github mirrors, but we mostly don't develop in Github, so PR need to be made to Gerrit

I'm able to find where the examples are added on https://en.wikipedia.org/w/api.php but how they are added. please tell.

Try searching for the text strings used in the examples in the MediaWiki Core repo