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

New Issue

zooko · 2013-01-05T00:21:01Z

zooko commented

2013-01-05 00:21:01 +00:00

[webapi.rst]source:docs/frontends/webapi.rst?rev=05d0b8b5b9247e1d0541e58250a81df89d5c9115#viewing-downloading-a-file says: "URLs may also use /file/$FILECAP/FILENAME as a synonym for /named/$FILECAP/FILENAME.". Why is that? Let's deprecate "/file/".

zooko added the

labels 2013-01-05 00:21:01 +00:00

zooko added this to the undecided milestone 2013-01-05 00:21:01 +00:00

zooko commented

2013-01-05 00:44:00 +00:00

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

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

zooko changed title from ~~remove one of the synonyms "/file/" and "/named/" from the WAPI~~ to deprecate one of the synonyms "/file/" and "/named/" from the WAPI

2013-01-05 00:44:00 +00:00

zooko was assigned by tahoe-lafs

2013-01-05 03:31:08 +00:00

davidsarah commented

2013-01-05 03:34:32 +00:00

Review comments on github. BTW, [FileHandler in web/root.py]source:src/allmydata/web/root.py@880af4e1#L92 should probably be renamed to NamedHandler and the error messages in it changed to reference /named, in that case.

Review comments on github. BTW, [FileHandler in web/root.py]source:src/allmydata/web/root.py@880af4e1#L92 should probably be renamed to `NamedHandler` and the error messages in it changed to reference `/named`, in that case.

daira commented

2013-05-01 21:52:29 +00:00

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

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

zooko commented

2013-05-07 20:30:44 +00:00

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.

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.

daira commented

2013-05-08 00:31:19 +00:00

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:90786, comment:90787, and to change any uses of /file in tests to /named.

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:90786](/tahoe-lafs/trac-2024-07-25/issues/1903#issuecomment-90786), [comment:90787](/tahoe-lafs/trac-2024-07-25/issues/1903#issuecomment-90787), and to change any uses of `/file` in tests to `/named`.

zooko commented

2013-11-10 15:50:10 +00:00

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.

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.

daira commented

2014-10-02 15:00:16 +00:00

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.)

zooko commented

2014-10-03 15:33:13 +00:00

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.

Replying to [daira](/tahoe-lafs/trac-2024-07-25/issues/1903#issuecomment-90791): > 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.

daira commented

2014-10-08 11:39:31 +00:00

OK, then this needs the changes in comment:90789, which probably means that the deprecation isn't going to get into 1.11.

OK, then this needs the changes in [comment:90789](/tahoe-lafs/trac-2024-07-25/issues/1903#issuecomment-90789), which probably means that the deprecation isn't going to get into 1.11.

Brian Warner <warner@lothar.com> commented

2016-04-23 02:28:27 +00:00

In 3e73461/trunk:

update webapi.rst's View/Download File docs

• mark "/file/" as a synonym for "/named/" to be deprecated (fixes #1903)
• move the options common to all three forms to the bottom and dedent them
• name the protocol/format as "LAFS" and the implementation/client "Tahoe"
• reflow (with fill-column 77)

In [3e73461/trunk](/tahoe-lafs/trac-2024-07-25/commit/3e7346100f735478933bff592d81ea4edfbc26ac): ``` update webapi.rst's View/Download File docs • mark "/file/" as a synonym for "/named/" to be deprecated (fixes #1903) • move the options common to all three forms to the bottom and dedent them • name the protocol/format as "LAFS" and the implementation/client "Tahoe" • reflow (with fill-column 77) ```

tahoe-lafs added the

fixed

label 2016-04-23 02:28:27 +00:00

tahoe-lafs closed this issue

2016-04-23 02:28:27 +00:00

Brian Warner <warner@lothar.com> commented

2016-04-23 02:28:29 +00:00

In afb7718/trunk:

Merge PR #29 from zooko:1903-deprecate-synonymous-file-and-update-docs

refs ticket:1903

In [afb7718/trunk](/tahoe-lafs/trac-2024-07-25/commit/afb7718f89818f646c5feadbb1e66ca83c93676f): ``` Merge PR #29 from zooko:1903-deprecate-synonymous-file-and-update-docs refs ticket:1903 ```

warner commented

2016-04-23 02:35:07 +00:00

Oops, I didn't notice the commit's auto-closing comment. I didn't mean to mark this one fixed yet.. I just wanted to land some old PRs.

To resolve this ticket, I think we need more changes (stop using /file, etc).

Oops, I didn't notice the commit's auto-closing comment. I didn't mean to mark this one fixed yet.. I just wanted to land some old PRs. To resolve this ticket, I think we need more changes (stop using /file, etc).

warner removed the

fixed

label 2016-04-23 02:35:07 +00:00

warner reopened this issue

2016-04-23 02:35:07 +00:00

tahoe-lafs added

normal

and removed

minor

labels 2016-04-25 16:23:47 +00:00

tahoe-lafs modified the milestone from undecided to 1.12.0

2016-04-25 16:23:47 +00:00