diff --git a/hc/api/models.py b/hc/api/models.py index 3f980b2c..dcc8105a 100644 --- a/hc/api/models.py +++ b/hc/api/models.py @@ -224,7 +224,7 @@ class Check(models.Model): if readonly: result["unique_key"] = self.unique_key else: - update_rel_url = reverse("hc-api-update", args=[self.code]) + update_rel_url = reverse("hc-api-single", args=[self.code]) pause_rel_url = reverse("hc-api-pause", args=[self.code]) result["ping_url"] = self.url() diff --git a/hc/api/tests/test_get_check.py b/hc/api/tests/test_get_check.py new file mode 100644 index 00000000..3b0c30a8 --- /dev/null +++ b/hc/api/tests/test_get_check.py @@ -0,0 +1,55 @@ +from datetime import timedelta as td +import uuid + +from django.utils.timezone import now +from hc.api.models import Channel, Check +from hc.test import BaseTestCase + + +class GetCheckTestCase(BaseTestCase): + def setUp(self): + super(GetCheckTestCase, self).setUp() + + self.now = now().replace(microsecond=0) + + self.a1 = Check(project=self.project, name="Alice 1") + self.a1.timeout = td(seconds=3600) + self.a1.grace = td(seconds=900) + self.a1.n_pings = 0 + self.a1.status = "new" + self.a1.tags = "a1-tag a1-additional-tag" + self.a1.desc = "This is description" + self.a1.save() + + self.c1 = Channel.objects.create(project=self.project) + self.a1.channel_set.add(self.c1) + + def get(self, code): + url = "/api/v1/checks/%s" % code + return self.client.get(url, HTTP_X_API_KEY="X" * 32) + + def test_it_works(self): + r = self.get(self.a1.code) + self.assertEqual(r.status_code, 200) + self.assertEqual(r["Access-Control-Allow-Origin"], "*") + + doc = r.json() + self.assertEqual(len(doc), 13) + + self.assertEqual(doc["timeout"], 3600) + self.assertEqual(doc["grace"], 900) + self.assertEqual(doc["ping_url"], self.a1.url()) + self.assertEqual(doc["last_ping"], None) + self.assertEqual(doc["n_pings"], 0) + self.assertEqual(doc["status"], "new") + self.assertEqual(doc["channels"], str(self.c1.code)) + self.assertEqual(doc["desc"], "This is description") + + def test_it_handles_invalid_uuid(self): + r = self.get("not-an-uuid") + self.assertEqual(r.status_code, 404) + + def test_it_handles_missing_check(self): + made_up_code = "07c2f548-9850-4b27-af5d-6c9dc157ec02" + r = self.get(made_up_code) + self.assertEqual(r.status_code, 404) \ No newline at end of file diff --git a/hc/api/urls.py b/hc/api/urls.py index f4e5a3ef..28050a25 100644 --- a/hc/api/urls.py +++ b/hc/api/urls.py @@ -23,7 +23,6 @@ urlpatterns = [ path("ping//start", views.ping, {"action": "start"}, name="hc-start"), path("api/v1/checks/", views.checks), path("api/v1/checks/", views.single, name="hc-api-single"), - path("api/v1/checks/", views.update, name="hc-api-update"), path("api/v1/checks//pause", views.pause, name="hc-api-pause"), path("api/v1/notifications//bounce", views.bounce, name="hc-api-bounce"), path("api/v1/channels/", views.channels), diff --git a/templates/docs/api.html b/templates/docs/api.html index 9f0801a6..c896f2f3 100644 --- a/templates/docs/api.html +++ b/templates/docs/api.html @@ -15,6 +15,10 @@ checks in user's account.

GET SITE_ROOT/api/v1/checks/ +Create a single check +GET SITE_ROOT/api/v1/checks/<uuid> + + Create a new check POST SITE_ROOT/api/v1/checks/ @@ -174,6 +178,40 @@ is added. This identifier is stable across API calls. Example:

+

Get a single Check

+

GET SITE_ROOT/api/v1/checks/<uuid>

+

Returns a JSON object containing information information from a single check.

+

Response Codes

+
+
200 OK
+
The request succeeded.
+
401 Unauthorized
+
The API key is either missing or invalid.
+
+

Example Request

+
curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/checks/<uuid>
+
+ + +

Example Response

+
{
+  "channels": "4ec5a071-2d08-4baa-898a-eb4eb3cd6941,746a083e-f542-4554-be1a-707ce16d3acc",
+  "desc": "Longer free-form description goes here",
+  "grace": 900,
+  "last_ping": "2017-01-04T13:24:39.903464+00:00",
+  "n_pings": 1,
+  "name": "Api test 1",
+  "next_ping": "2017-01-04T14:24:39.903464+00:00",
+  "pause_url": "SITE_ROOT/api/v1/checks/662ebe36-ecab-48db-afe3-e20029cb71e6/pause",
+  "ping_url": "PING_ENDPOINT662ebe36-ecab-48db-afe3-e20029cb71e6",
+  "status": "up",
+  "tags": "foo",
+  "timeout": 3600,
+  "update_url": "SITE_ROOT/api/v1/checks/662ebe36-ecab-48db-afe3-e20029cb71e6"
+}
+
+ +

Create a Check

POST SITE_ROOT/api/v1/checks/

Creates a new check and returns its ping URL. diff --git a/templates/docs/api.md b/templates/docs/api.md index f23d69b6..d04bac9e 100644 --- a/templates/docs/api.md +++ b/templates/docs/api.md @@ -8,6 +8,7 @@ checks in user's account. Endpoint Name | Endpoint Address ------------------------------------------------------|------- [Get a list of existing checks](#list-checks) | `GET SITE_ROOT/api/v1/checks/` +[Create a single check](#get-check) | `GET SITE_ROOT/api/v1/checks/` [Create a new check](#create-check) | `POST SITE_ROOT/api/v1/checks/` [Update an existing check](#update-check) | `POST SITE_ROOT/api/v1/checks/` [Pause monitoring of a check](#pause-check) | `POST SITE_ROOT/api/v1/checks//pause` @@ -157,6 +158,45 @@ is added. This identifier is stable across API calls. Example: } ``` +## Get a single Check {: #get-check .rule } +`GET SITE_ROOT/api/v1/checks/` + +Returns a JSON object containing information information from a single check. + +### Response Codes + +200 OK +: The request succeeded. + +401 Unauthorized +: The API key is either missing or invalid. + +### Example Request + +```bash +curl --header "X-Api-Key: your-api-key" SITE_ROOT/api/v1/checks/ +``` + +### Example Response + +```json +{ + "channels": "4ec5a071-2d08-4baa-898a-eb4eb3cd6941,746a083e-f542-4554-be1a-707ce16d3acc", + "desc": "Longer free-form description goes here", + "grace": 900, + "last_ping": "2017-01-04T13:24:39.903464+00:00", + "n_pings": 1, + "name": "Api test 1", + "next_ping": "2017-01-04T14:24:39.903464+00:00", + "pause_url": "SITE_ROOT/api/v1/checks/662ebe36-ecab-48db-afe3-e20029cb71e6/pause", + "ping_url": "PING_ENDPOINT662ebe36-ecab-48db-afe3-e20029cb71e6", + "status": "up", + "tags": "foo", + "timeout": 3600, + "update_url": "SITE_ROOT/api/v1/checks/662ebe36-ecab-48db-afe3-e20029cb71e6" +} +``` + ## Create a Check {: #create-check .rule } `POST SITE_ROOT/api/v1/checks/`