[doc][s]: Mentioned alternative API authorization header.

ckan · Dec 7, 2011 · cf793da · cf793da
1 parent 3c18594
commit cf793da
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 12 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -429,13 +429,9 @@ To obtain your API key:
 
 2. The user page shows the API Key: /user/me
 
-The key should be passed in the API request header:
+The key should be passed in the API request header ''Authorization'' (or an alternative may be provided such as ''X-CKAN-API-KEY''). For example::
 
-================= =====
-Header            Example value
-================= =====
-Authorization     ``fde34a3c-b716-4c39-8dc4-881ba115c6d4``
-================= =====
+  curl http://thedatahub.org/api/rest/package -d '{"name": "test"}' -H 'Authorization: fde34a3c-b716-4c39-8dc4-881ba115c6d4'
 
 If requests that are required to be authorized are not sent with a 
 valid Authorization header, for example the user associated with the 

diff --git a/doc/apiv3.rst b/doc/apiv3.rst
@@ -223,13 +223,9 @@ To obtain your API key:
 
 2. The user page shows the API Key: /user/me
 
-The key should be passed in the API request header:
+The key should be passed in the API request header ''Authorization'' (or an alternative may be provided such as ''X-CKAN-API-KEY''). For example::
 
-================= =====
-Header            Example value
-================= =====
-Authorization     ``fde34a3c-b716-4c39-8dc4-881ba115c6d4``
-================= =====
+  curl http://thedatahub.org/api/rest/package -d '{"name": "test"}' -H 'Authorization: fde34a3c-b716-4c39-8dc4-881ba115c6d4'
 
 If requests that are required to be authorized are not sent with a 
 valid Authorization header, for example the user associated with the