healthchecks/hc/api/urls.py

from urllib.parse import quote, unquote

from django.urls import path, register_converter
from hc.api import views


class QuoteConverter:
    regex = "[\w%~_.-]+"

    def to_python(self, value):
        return unquote(value)

    def to_url(self, value):
        return quote(value, safe="")


register_converter(QuoteConverter, "quoted")

urlpatterns = [
    path("ping/<uuid:code>/", views.ping, name="hc-ping-slash"),
    path("ping/<uuid:code>", views.ping, name="hc-ping"),
    path("ping/<uuid:code>/fail", views.ping, {"action": "fail"}, name="hc-fail"),
    path("ping/<uuid:code>/start", views.ping, {"action": "start"}, name="hc-start"),
    path("api/v1/checks/", views.checks),
    path("api/v1/checks/<uuid:code>", views.update, name="hc-api-update"),
    path("api/v1/checks/<uuid:code>/pause", views.pause, name="hc-api-pause"),
    path("api/v1/notifications/<uuid:code>/bounce", views.bounce, name="hc-api-bounce"),
    path("api/v1/channels/", views.channels),
    path(
        "badge/<slug:badge_key>/<slug:signature>/<quoted:tag>.svg",
        views.badge,
        name="hc-badge",
    ),
    path(
        "badge/<slug:badge_key>/<slug:signature>.svg",
        views.badge,
        {"tag": "*"},
        name="hc-badge-all",
    ),
    path(
        "badge/<slug:badge_key>/<slug:signature>/<quoted:tag>.json",
        views.badge,
        {"format": "json"},
        name="hc-badge-json",
    ),
    path(
        "badge/<slug:badge_key>/<slug:signature>.json",
        views.badge,
        {"format": "json", "tag": "*"},
        name="hc-badge-json-all",
    ),
    path("api/v1/status/", views.status),
]