Opened at 2012-01-21T23:38:56Z
Last modified at 2012-05-14T04:59:17Z
#1662 closed defect
webapi.rst fails to mention /file/ handler. — at Initial Version
Reported by: | nejucomo | Owned by: | nobody |
---|---|---|---|
Priority: | major | Milestone: | 1.9.2 |
Component: | documentation | Version: | 1.9.1 |
Keywords: | webapi docs | Cc: | zooko |
Launchpad Bug: |
Description
[Note: This issue affects both the 1.9.0 and 1.9.1 source releases, but there is no trac Version value for 1.9.1 currently.]
Symptom: I see browser requests for "GET /file/..." but when I grep for '/file' in webapi.rst I see no hits. I have also looked at every hit for "grep -i file" to verify this url path is not mentioned in webapi.rst.
Resolution: Update webapi.rst to describe /file/ urls.
Related Info: It looks as if /file/ may do something similar to /named/ or one may be an older backwards-compatible version of the same feature. If so, clearly document this. If the functional overlap is large and there's no compatibility requirement, we should file a new ticket to remove one of them. If the functionality partially overlaps but is distinct, webapi.rst should make the distinction clear.
Background: I am configuring access control policies based on HTTP method and path for a read-only gateway, so I want webapi.rst to tell me everything necessary for my usecase.