diff options
| author | Eric Wong <e@80x24.org> | 2015-09-01 08:55:25 +0000 |
|---|---|---|
| committer | Eric Wong <e@80x24.org> | 2015-09-01 08:56:06 +0000 |
| commit | 97bef984363d1279a6ac130d35f063a834e9c241 (patch) | |
| tree | 6a91e79c0129969ed1c25584b803008d5ccb84e9 /Documentation/design_www.txt | |
| parent | 41d5b5f42ec41cd3cefb964eff2da7df88677dde (diff) | |
| download | public-inbox-97bef984363d1279a6ac130d35f063a834e9c241.tar.gz | |
The MIME type entry for Atom feed relies on "atom", so allow properly-configured static file servers to serve it with the correct Content-Type header.
Diffstat (limited to 'Documentation/design_www.txt')
| -rw-r--r-- | Documentation/design_www.txt | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt index d25afca3..a11c3896 100644 --- a/Documentation/design_www.txt +++ b/Documentation/design_www.txt @@ -3,34 +3,38 @@ URL naming ### Unstable endpoints /$LISTNAME/?r=$GIT_COMMIT -> HTML only -/$LISTNAME/atom.xml -> Atom feed +/$LISTNAME/new.atom -> Atom feed #### Optional, relies on Search::Xapian -/$LISTNAME/t/$MESSAGE_ID/ -> HTML content of thread -/$LISTNAME/t/$MESSAGE_ID/atom -> Atom feed for thread -/$LISTNAME/t/$MESSAGE_ID/mbox.gz -> gzipped mbox of thread +/$LISTNAME/t/$MESSAGE_ID/ -> HTML content of thread +/$LISTNAME/t/$MESSAGE_ID/atom -> Atom feed for thread +/$LISTNAME/t/$MESSAGE_ID/mbox.gz -> gzipped mbox of thread ### Stable endpoints -/$LISTNAME/m/$MESSAGE_ID/ -> HTML content (short quotes) -/$LISTNAME/m/$MESSAGE_ID -> 301 to above -/$LISTNAME/m/$MESSAGE_ID/raw -> raw mbox -/$LISTNAME/f/$MESSAGE_ID/ -> HTML content (full quotes) -/$LISTNAME/f/$MESSAGE_ID -> 301 to above -/$LISTNAME/f/$MESSAGE_ID/raw (*) -> 301 to ../m/$MESSAGE_ID/raw +/$LISTNAME/m/$MESSAGE_ID/ -> HTML content (short quotes) +/$LISTNAME/m/$MESSAGE_ID -> 301 to above +/$LISTNAME/m/$MESSAGE_ID/raw -> raw mbox +/$LISTNAME/f/$MESSAGE_ID/ -> HTML content (full quotes) +/$LISTNAME/f/$MESSAGE_ID -> 301 to above +/$LISTNAME/f/$MESSAGE_ID/raw [1] -> 301 to ../m/$MESSAGE_ID/raw -### Legacy endpoints (may be ambiguous given Message-IDs with similar suffies) -/$LISTNAME/m/$MESSAGE_ID.html -> 301 to $MESSAGE_ID/ -/$LISTNAME/m/$MESSAGE_ID.txt -> 301 to $MESSAGE_ID/raw -/$LISTNAME/f/$MESSAGE_ID.html -> 301 to $MESSAGE_ID/ -/$LISTNAME/f/$MESSAGE_ID.txt (*) -> 301 to ../m/$MESSAGE_ID/raw +### Legacy endpoints (may be ambiguous given Message-IDs with similar suffixes) +/$LISTNAME/m/$MESSAGE_ID.html -> 301 to $MESSAGE_ID/ +/$LISTNAME/m/$MESSAGE_ID.txt -> 301 to $MESSAGE_ID/raw +/$LISTNAME/f/$MESSAGE_ID.html -> 301 to $MESSAGE_ID/ +/$LISTNAME/f/$MESSAGE_ID.txt [1] -> 301 to ../m/$MESSAGE_ID/raw +/$LISTNAME/atom.xml [2] -> identical to /$LISTNAME/new.atom FIXME: we must refactor/cleanup/add tests for most of our CGI before adding more endpoints and features. -(*) These URLs were never linked, but only exist as a convenience to folks +[1] These URLs were never linked, but only exist as a convenience to folks who edit existing URLs +[2] Do not make this into a 301 since feed readers may not follow them as well + as normal browsers do. + Encoding notes -------------- |