harmacist/healthchecks
1
0
Fork 0
forked from GithubBackups/healthchecks
Code Issues Pull Requests Projects Releases Wiki Activity

Fix default values for timeout and grace parameters in API reference.

Browse Source
This commit is contained in:
Pēteris Caune 2020-03-02 13:50:27 +02:00
parent dab0c4200e
commit ccba5e8731
No known key found for this signature in database
GPG Key ID: E28D7679E9A9EDE2
3 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
hc/front/views.py
View File

@ -276,15 +276,19 @@ def serve_doc(request, doc="introduction"):
if not os.path.exists(path): if not os.path.exists(path):
raise Http404("not found") raise Http404("not found")
replaces = {
"{{ default_timeout }}": str(int(DEFAULT_TIMEOUT.total_seconds())),
"{{ default_grace }}": str(int(DEFAULT_GRACE.total_seconds())),
"SITE_NAME": settings.SITE_NAME,
"SITE_ROOT": settings.SITE_ROOT,
"PING_ENDPOINT": settings.PING_ENDPOINT,
"IMG_URL": os.path.join(settings.STATIC_URL, "img/docs"),
"PING_EMAIL": "your-uuid-here@%s" % settings.PING_EMAIL_DOMAIN,
}
content = open(path, "r", encoding="utf-8").read() content = open(path, "r", encoding="utf-8").read()
content = content.replace("SITE_NAME", settings.SITE_NAME) for placeholder, value in replaces.items():
content = content.replace("SITE_ROOT", settings.SITE_ROOT) content = content.replace(placeholder, value)
content = content.replace("PING_URL", settings.PING_ENDPOINT + "your-uuid-here")
content = content.replace("PING_ENDPOINT", settings.PING_ENDPOINT)
content = content.replace("IMG_URL", os.path.join(settings.STATIC_URL, "img/docs"))
content = content.replace(
"PING_EMAIL", "your-uuid-here@%s" % settings.PING_EMAIL_DOMAIN
)
ctx = { ctx = {
"page": "docs", "page": "docs",

2
templates/docs/api.html
View File

@ -86,7 +86,7 @@ one or more tags.</p>
specified value.</p> specified value.</p>
<p>This parameter can be repeated multiple times.</p> <p>This parameter can be repeated multiple times.</p>
<p>Example:</p> <p>Example:</p>
<p><code>SITE_ROOT/api/v1/checks/?tag=foo&amp;amp;tag=bar</code></p> <p><code>SITE_ROOT/api/v1/checks/?tag=foo&amp;tag=bar</code></p>
</dd> </dd>
</dl> </dl>
<h3>Example Request</h3> <h3>Example Request</h3>

2
templates/docs/api.md
View File

@ -66,7 +66,7 @@ tag=&lt;value&gt;
Example: Example:
`SITE_ROOT/api/v1/checks/?tag=foo&amp;tag=bar` `SITE_ROOT/api/v1/checks/?tag=foo&tag=bar`
### Example Request ### Example Request