vbrandl/hoc
1
0
Fork 0
Code Issues 1 Pull Requests Actions Projects Releases Wiki Activity

Document JSON endpoint on index page

Browse Source
This commit is contained in:
Valentin Brandl 2019-06-16 15:00:46 +02:00
parent 05736ee3ba
commit 21243e6cfb
No known key found for this signature in database
GPG Key ID: 30D341DD34118D7D
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
templates/index.rs.html
View File

@ -45,6 +45,21 @@ would render this badge:
alt="example badge" /></a> alt="example badge" /></a>
</pre> </pre>
<p>
You can also request the HoC as JSON by appending <code>/json</code> to the request path. This will return a JSON
object with two fields: <code>count</code> and <code>head</code> with count being the HoC value and head being the
commit ref of <code>HEAD</code>. Requesting
<a href="https://@domain/github/vbrandl/hoc/json">https://@domain/github/vbrandl/hoc/json</a> might return something
along the lines of
</p>
<pre>
&#123;
"head" : "05736ee3ba256ec9a7227c436aef2bf43db109ab",
"count": 7582
&#125;
</pre>
<h2>Badge Generator</h2> <h2>Badge Generator</h2>
<form method="post" action="/generate"> <form method="post" action="/generate">