]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/design_www.txt
various documentation updates
[public-inbox.git] / Documentation / design_www.txt
1 URL naming
2 ----------
3
4 ### Unstable endpoints
5 /$LISTNAME/?r=$GIT_COMMIT                       -> HTML only
6 /$LISTNAME/index.atom.xml                       -> Atom feed
7 /$LISTNAME/all.atom.xml                         -> Atom feed, includes replies
8
9 ### Stable endpoints
10 /$LISTNAME/m/$MESSAGE_ID.html                   -> HTML content (short quotes)
11 /$LISTNAME/m/$MESSAGE_ID.txt                    -> raw original
12 /$LISTNAME/m/$MESSAGE_ID                        -> 301 to .html version
13 /$LISTNAME/f/$MESSAGE_ID.html                   -> HTML content (full quotes)
14 /$LISTNAME/f/$MESSAGE_ID                        -> 301 to .html version
15 /$LISTNAME/f/$MESSAGE_ID.txt                    -> 301 to m/$MESSAGE_ID.txt
16
17 TODO (these might be expensive)
18 -------------------------------
19 /$LISTNAME/t/$MESSAGE_ID.html                   -> HTML content of thread
20 /$LISTNAME/t/$MESSAGE_ID.mbox                   -> mbox content of thread
21
22 We use file name suffixes on all of these (except /) so URLs may easily
23 cached/memoized using a static file server.