From fac604ddb7f3de35d1723716856d1f03454137bd Mon Sep 17 00:00:00 2001
From: Max Goodman
Date: Wed, 4 Sep 2013 19:29:32 -0700
Subject: [PATCH] Recommend X-Modhash usage in the API docs.
---
r2/r2/lib/validator/validator.py | 2 +-
r2/r2/templates/apihelp.html | 3 +++
2 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/r2/r2/lib/validator/validator.py b/r2/r2/lib/validator/validator.py
index 9d12035fa..425752600 100644
--- a/r2/r2/lib/validator/validator.py
+++ b/r2/r2/lib/validator/validator.py
@@ -815,7 +815,7 @@ class VModhash(Validator):
def param_docs(self):
return {
- self.param: 'a [modhash](#modhashes)',
+ '%s / X-Modhash header' % self.param: 'a [modhash](#modhashes)',
}
class VVotehash(Validator):
diff --git a/r2/r2/templates/apihelp.html b/r2/r2/templates/apihelp.html
index a29a7490a..4bb83d508 100644
--- a/r2/r2/templates/apihelp.html
+++ b/r2/r2/templates/apihelp.html
@@ -140,6 +140,9 @@
or in the Listing structures of several other API
calls.
+ The preferred way to send a modhash is to include an
+ X-Modhash custom HTTP header with your requests.
+
fullnames
A fullname is a combination of a thing's type