Page MenuHomePhabricator

action=upload needs better documentation
Closed, ResolvedPublic

Description

Patch against r53871

With 5 different "modules" in there, it needs to be better organized. I managed to figure it out by digging through the code, but we can't expect everyone to do that.

I've given it a shot in the attached patch. What I did:

  • Explain the 5 different modes at the top, much like prop=revisions does.
  • Mention that multipart/form-data is required for "file" and "chunk".
  • Note that the session keys are tied to the current login session.
  • Rearrange the parameters so "shared" parameters come first and then the various module-related parameters are grouped together.
  • Revise parameter descriptions.
  • Add more examples.

Version: 1.16.x
Severity: enhancement

Attached:

Details

Reference
bz19970

Event Timeline

bzimport raised the priority of this task from to Medium.Nov 21 2014, 10:40 PM
bzimport set Reference to bz19970.

Michael, can you verify that Brad's descriptions are correct?

Also, it might be useful to number the different modes and indicate for each parameter which modes they can be used in (like list=deletedrevs does).

mdale wrote:

That looks good. added in r53885 I don't think numbering will increase clarity. Since some of the paras have an order that they need to be sent. Perhaps we link out to a mediaWiki page with some examples usage?