update zoneinfo endpoint to be a list of dicts

ShaunBoughey · Feb 8, 2018 · c866d85 · c866d85
1 parent e982f6e
commit c866d85
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/awx/api/views.py b/awx/api/views.py
@@ -700,7 +700,10 @@ class ScheduleZoneInfo(APIView):
 
     def get(self, request):
         from dateutil.zoneinfo import get_zonefile_instance
-        return Response(sorted(get_zonefile_instance().zones.keys()))
+        return Response([
+            {'name': zone}
+            for zone in sorted(get_zonefile_instance().zones)
+        ])
 
 
 class LaunchConfigCredentialsBase(SubListAttachDetachAPIView):

diff --git a/awx/main/tests/functional/api/test_schedules.py b/awx/main/tests/functional/api/test_schedules.py
@@ -280,3 +280,10 @@ def test_dst_rollback_duplicates(post, admin_user):
         '2030-11-03 02:30:00-05:00',
         '2030-11-03 03:30:00-05:00',
     ]
+
+
+@pytest.mark.django_db
+def test_zoneinfo(get, admin_user):
+    url = reverse('api:schedule_zoneinfo')
+    r = get(url, admin_user, expect=200)
+    assert {'name': 'America/New_York'} in r.data
diff --git a/docs/schedules.md b/docs/schedules.md
@@ -41,9 +41,9 @@ A list of _valid_ zone identifiers (which can vary by system) can be found at:
     HTTP GET /api/v2/schedules/zoneinfo/
 
     [
-        "Africa/Abidjan",
-        "Africa/Accra",
-        "Africa/Addis_Ababa",
+        {"name": "Africa/Abidjan"},
+        {"name": "Africa/Accra"},
+        {"name": "Africa/Addis_Ababa"},
         ...
     ]