docs: add x-total-count doc

See ory/hydra#1666
ory · Aug 10, 2020 · 7c25550 · 7c25550
1 parent bf149b4
commit 7c25550
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/ecosystem/api-design.md b/docs/ecosystem/api-design.md
@@ -36,12 +36,17 @@ Example:
 < HTTP/1.1 200 OK
 < Content-Type: application/json
 < Link: <hydra-admin/clients?limit=5&offset=0>; rel="first",</clients?limit=5&offset=15>; rel="next",</clients?limit=5&offset=5>; rel="prev",</clients?limit=5&offset=20>; rel="last"
+< X-Total-Count: 123
 < Date: Mon, 22 Apr 2019 23:34:29 GMT
 < Transfer-Encoding: chunked
 <
 [...]
 ```
 
+### Total Count
+
+You can get the total item count from the `X-Total-Count` HTTP Header.
+
 ## Date Format
 
 ORY's APIs use [rfc3339](https://tools.ietf.org/html/rfc3339) as the date