Page MenuHomePhabricator

ApiParamInfo: description missing
Closed, ResolvedPublic

Description

For some param the description text is missing. Please show all description which also available by action=help. Thanks.


Version: unspecified
Severity: enhancement
URL: http://en.wikipedia.org/w/api.php?action=paraminfo&modules=edit

Details

Reference
bz18709

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 21 2014, 10:33 PM
bzimport added a project: MediaWiki-API.
bzimport set Reference to bz18709.

(In reply to comment #0)

For some param the description text is missing. Please show all description
which also available by action=help. Thanks.

Could you be more specific as to what exactly is missing?

Of course. See the URL for following output:

<parameters>
  <param name="title" />
  <param name="section" />
  <param name="text" />
  <param name="token" />
  <param name="summary" />
  <param name="minor" type="bool" default="false" />
  <param name="notminor" type="bool" default="false" />
  <param name="bot" type="bool" default="false" />
  <param name="basetimestamp" />
  <param name="starttimestamp" />
  <param name="recreate" type="bool" default="false" />
  <param name="createonly" type="bool" default="false" />
  <param name="nocreate" type="bool" default="false" />
  <param name="captchaword" />
  <param name="captchaid" />
  <param name="watch" type="bool" default="false" />
  <param name="unwatch" type="bool" default="false" />
  <param name="md5" />
  <param name="prependtext" />
  <param name="appendtext" />
  <param name="undo" type="integer" description="Undo this revision. Overrides text, prependtext and appendtext" />
  <param name="undoafter" type="integer" description="Undo all revisions from undo to this one. If not set, just undo one revision" />
</parameters>

On action=help it looks so:

Parameters:

title          - Page title
section        - Section number. 0 for the top section, 'new' for a new section
text           - Page content
token          - Edit token. You can get one of these through prop=info
summary        - Edit summary. Also section title when section=new
minor          - Minor edit
notminor       - Non-minor edit
bot            - Mark this edit as bot
basetimestamp  - Timestamp of the base revision (gotten through prop=revisions&rvprop=timestamp).
                 Used to detect edit conflicts; leave unset to ignore conflicts.
starttimestamp - Timestamp when you obtained the edit token.
                 Used to detect edit conflicts; leave unset to ignore conflicts.
recreate       - Override any errors about the article having been deleted in the meantime
createonly     - Don't edit the page if it exists already
nocreate       - Throw an error if the page doesn't exist
captchaword    - Answer to the CAPTCHA
captchaid      - CAPTCHA ID from previous request
watch          - Add the page to your watchlist
unwatch        - Remove the page from your watchlist
md5            - The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated.
                 If set, the edit won't be done unless the hash is correct
prependtext    - Add this text to the beginning of the page. Overrides text.
                 Don't use together with section: that won't do what you expect.
appendtext     - Add this text to the end of the page. Overrides text
undo           - Undo this revision. Overrides text, prependtext and appendtext
undoafter      - Undo all revisions from undo to this one. If not set, just undo one revision

action=paraminfo gives only description of 'type="integer"' and not of the other param, this infos only available on action=help.

In my opinion it is helpful to get all description by action=paraminfo which also available by action=help

Fixed in r50338