aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMilo Casagrande <milo.casagrande@linaro.org>2014-08-08 10:14:37 +0200
committerMilo Casagrande <milo.casagrande@linaro.org>2014-08-08 10:14:37 +0200
commitdf3c38bf4eaaa17538bb11e465b683c7336dbf99 (patch)
treef3f82d45b42b11e9b33f9be6211c21de77e0b2f2 /doc
parent6c6a6098936550a845b5afeae8b949e82567c743 (diff)
Fix HTTP header: use Authorization.
Change-Id: Id9bc8c751ceaa3a322cd77de1913d4e60fafb156
Diffstat (limited to 'doc')
-rw-r--r--doc/count-collection.rst8
-rw-r--r--doc/intro.rst4
2 files changed, 7 insertions, 5 deletions
diff --git a/doc/count-collection.rst b/doc/count-collection.rst
index dbd9e09..90cf72b 100644
--- a/doc/count-collection.rst
+++ b/doc/count-collection.rst
@@ -11,7 +11,7 @@ GET
:param collection: The collection name to get the count of. Can be one of
``job``, ``defconfig``, ``boot``.
- :reqheader X-Linaro-Token: The token necessary to authorize the request.
+ :reqheader Authorization: The token necessary to authorize the request.
:query limit: Number of results to return. Default 0 (all results).
:type limit: int
@@ -33,6 +33,8 @@ GET
:type defconfig: string
:query job: A job name.
:type job: string
+ :query job_id: A job ID (usually in the form of ``job``-``kernel``).
+ :type job_id: string
:query kernel: A kernel name.
:type kernel: string
@@ -43,14 +45,14 @@ GET
GET /count/ HTTP/1.1
Host: api.backend.linaro.org
Accept: */*
- X-Linaro-Token: token
+ Authorization: token
.. sourcecode:: http
GET /count/job/ HTTP/1.1
Host: api.backend.linaro.org
Accept: */*
- X-Linaro-Token: token
+ Authorization: token
**Example Responses**
diff --git a/doc/intro.rst b/doc/intro.rst
index 174bd79..83e4120 100644
--- a/doc/intro.rst
+++ b/doc/intro.rst
@@ -101,7 +101,7 @@ Authentication and Tokens
The only way to authenticate through the API is via an authentication token.
Requests that require authentication will return ``403 Forbidden``.
-Authentication is performed using the ``X-Linaro-Token`` header.
+Authentication is performed using the ``Authorization`` header.
Tokens
******
@@ -115,4 +115,4 @@ Basic Authentication
::
- curl -H 'X-Linaro-Token: token' https://api.backend.linaro.org
+ curl -H 'Authorization: token' https://api.backend.linaro.org