about summary refs log tree commit homepage
path: root/Documentation/design_www.txt
diff options
context:
space:
mode:
authorEric Wong <e@yhbt.net>2020-02-16 10:24:35 +0000
committerEric Wong <e@yhbt.net>2020-02-17 07:54:52 +0000
commit8a4b5da8df770ce57513d940afd62f0142b266b0 (patch)
treed0d73eafc261cde41202e2f307d900a093b4c2fb /Documentation/design_www.txt
parent7efca6c8a2b98d97056fc933165df82e4b825725 (diff)
downloadpublic-inbox-8a4b5da8df770ce57513d940afd62f0142b266b0.tar.gz
The blob regeneration (solving) part has been stable and
performant for over a year with no problems, even with web
crawlers constantly hitting it without needing rate limits.

All the other stuff is open to bikeshedding (as long as
my crappy hardware supports it :P)
Diffstat (limited to 'Documentation/design_www.txt')
-rw-r--r--Documentation/design_www.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt
index f15a5562..240fa504 100644
--- a/Documentation/design_www.txt
+++ b/Documentation/design_www.txt
@@ -7,7 +7,7 @@ URL and anchor naming
 /$INBOX/?r=$GIT_COMMIT                 -> HTML only
 /$INBOX/new.atom                       -> Atom feed
 
-#### Optional, relies on Search::Xapian
+#### Optional, relies on Search::Xapian (or Xapian SWIG binding)
 /$INBOX/$MESSAGE_ID/t/                 -> HTML content of thread (nested)
 /$INBOX/$MESSAGE_ID/T/                 -> HTML content of thread (flat)
         anchors:
@@ -21,6 +21,16 @@ URL and anchor naming
 /$INBOX/$MESSAGE_ID/t.atom             -> Atom feed for thread
 /$INBOX/$MESSAGE_ID/t.mbox.gz          -> gzipped mbox of thread
 
+/$INBOX/$GIT_OID/s/                    -> "git show" (via "git apply")
+        This endpoint requires "coderepo" entries configured for
+        a given inbox.  It can recreate ("solve") blobs from
+        patch emails using Xapian and git-apply(1).  It can also
+        display non-blob content, but that remains a
+        work-in-progress.
+
+/$INBOX/$GIT_OID/s/$FILENAME           -> "git show", raw output
+        As above, but shows the raw (usually text/plain) output.
+
 ### Stable endpoints
 /$INBOX/$MESSAGE_ID/                   -> HTML content
         anchors: