Context Navigation

← Previous Ticket
Next Ticket →

Opened at 2013-01-05T00:21:01Z

Last modified at 2021-03-30T18:40:19Z

#1903 reopened enhancement

deprecate one of the synonyms "/file/" and "/named/" from the WAPI

Reported by:	zooko	Owned by:	zooko
Priority:	normal	Milestone:	soon
Component:	code-frontend-web	Version:	1.9.2
Keywords:	usability wui wapi docs forward-compatibility	Cc:
Launchpad Bug:

Description (last modified by daira)

webapi.rst says: "URLs may also use /file/$FILECAP/FILENAME as a synonym for /named/$FILECAP/FILENAME.". Why is that? Let's deprecate "/file/".

Change History (20)

comment:1 Changed at 2013-01-05T00:44:00Z by zooko

Summary changed from remove one of the synonyms "/file/" and "/named/" from the WAPI to deprecate one of the synonyms "/file/" and "/named/" from the WAPI

Review needed: https://github.com/tahoe-lafs/tahoe-lafs/pull/29

comment:2 Changed at 2013-01-05T03:31:08Z by davidsarah

Keywords reviewed added
Owner set to zooko

comment:3 Changed at 2013-01-05T03:34:32Z by davidsarah

Review comments on github. BTW, FileHandler in web/root.py should probably be renamed to NamedHandler and the error messages in it changed to reference /named, in that case.

Last edited at 2014-03-05T02:54:07Z by daira (previous) (diff)

comment:4 Changed at 2013-05-01T21:52:29Z by daira

git/src/allmydata/web/info.py#L143 and git/src/allmydata/web/directory.py (lines 733, 743, and 1042) use /file. Nothing currently uses /named.

Version 0, edited at 2013-05-01T21:52:29Z by daira (next)

comment:5 Changed at 2013-05-01T21:53:05Z by daira

Keywords easy reviewed removed

comment:6 Changed at 2013-05-07T20:30:44Z by zooko

In my opinion /named is a better word for this API than /file, since the difference between /file and /uri is not that the former is a file and the latter isn't.

comment:7 Changed at 2013-05-08T00:31:19Z by daira

OK, +1 for that pull request modulo https://github.com/tahoe-lafs/tahoe-lafs/pull/29#commitcomment-2387217, but let's also have a patch for comment:3, comment:4, and to change any uses of /file in tests to /named.

comment:8 Changed at 2013-11-10T15:50:10Z by zooko

Keywords forward-compatibility added

I'm adding the tag "forward-compatibility" because we want to ship a stable release with this deprecation in place before shipping a future stable release with the deprecated API removed.

comment:9 Changed at 2013-11-10T15:53:44Z by zooko

Status changed from new to assigned

comment:10 Changed at 2014-03-05T02:54:47Z by daira

Description modified (diff)

comment:11 follow-up: ↓ 12 Changed at 2014-10-02T15:00:16Z by daira

I'm still not sure why we're deprecating "/file" which is used, rather than deprecating "/named" which is unused. (I value having fewer redundant options but I'm not sure it really matters what they are called.)

comment:12 in reply to: ↑ 11 Changed at 2014-10-03T15:33:13Z by zooko

Replying to daira:

I'm still not sure why we're deprecating "/file" which is used, rather than deprecating "/named" which is unused. (I value having fewer redundant options but I'm not sure it really matters what they are called.)

I wanted to move to "/named" because it explains what it actually does — it changes the name of the downloaded file. Calling this feature "/file" is confusing because it is still a file even if you don't use this feature.