better endpoint

Author: Dana Stiefel

backend/compact-connect/docs/internal/api-specification/latest-oas30.json

@@ -10,7 +10,7 @@
     }
   ],
   "paths": {
-    "/v1/compacts/live": {
+    "/v1/public/compacts/jurisdictions/live": {
       "get": {
         "summary": "Get live compact jurisdictions",
         "description": "Returns all jurisdictions that are live (enabled for operations) across all compacts or for a specific compact if the optional compact query parameter is provided.",

backend/compact-connect/lambdas/python/compact-configuration/handlers/compact_configuration.py

@@ -28,7 +28,7 @@ def compact_configuration_api_handler(event: dict, context: LambdaContext):  # n
         return _get_staff_users_compact_jurisdictions(event, context)
     if event['httpMethod'] == 'GET' and event['resource'] == '/v1/public/compacts/{compact}/jurisdictions':
         return _get_public_compact_jurisdictions(event, context)
-    if event['httpMethod'] == 'GET' and event['resource'] == '/v1/compacts/live':
+    if event['httpMethod'] == 'GET' and event['resource'] == '/v1/public/compacts/jurisdictions/live':
         return _get_live_public_compact_jurisdictions(event, context)
     if event['httpMethod'] == 'GET' and event['resource'] == '/v1/compacts/{compact}':
         return _get_staff_users_compact_configuration(event, context)

backend/compact-connect/lambdas/python/compact-configuration/tests/function/test_compact_configuration.py

@@ -12,7 +12,7 @@
 
 STAFF_USERS_COMPACT_JURISDICTION_ENDPOINT_RESOURCE = '/v1/compacts/{compact}/jurisdictions'
 PUBLIC_COMPACT_JURISDICTION_ENDPOINT_RESOURCE = '/v1/public/compacts/{compact}/jurisdictions'
-LIVE_COMPACT_JURISDICTIONS_ENDPOINT_RESOURCE = '/v1/compacts/live'
+LIVE_COMPACT_JURISDICTIONS_ENDPOINT_RESOURCE = '/v1/public/compacts/jurisdictions/live'
 
 COMPACT_CONFIGURATION_ENDPOINT_RESOURCE = '/v1/compacts/{compact}'
 JURISDICTION_CONFIGURATION_ENDPOINT_RESOURCE = '/v1/compacts/{compact}/jurisdictions/{jurisdiction}'

backend/compact-connect/stacks/api_stack/v1_api/api.py

@@ -127,6 +127,10 @@ def __init__(
         # POST /v1/public/compacts/{compact}/providers/query
         # GET  /v1/public/compacts/{compact}/providers/{providerId}
         self.public_compacts_resource = self.public_resource.add_resource('compacts')
+        # /v1/public/compacts/jurisdictions
+        self.public_compacts_jurisdictions_resource = self.public_compacts_resource.add_resource('jurisdictions')
+        # /v1/public/compacts/jurisdictions/live
+        self.live_compacts_jurisdictions_resource = self.public_compacts_jurisdictions_resource.add_resource('live')
         self.public_compacts_compact_resource = self.public_compacts_resource.add_resource('{compact}')
         self.public_compacts_compact_providers_resource = self.public_compacts_compact_resource.add_resource(
             'providers'
@@ -160,8 +164,6 @@ def __init__(
 
         # /v1/compacts
         self.compacts_resource = self.resource.add_resource('compacts')
-        # /v1/compacts/live
-        self.live_compacts_resource = self.compacts_resource.add_resource('live')
         # /v1/compacts/{compact}
         self.compact_resource = self.compacts_resource.add_resource('{compact}')
 
@@ -207,7 +209,7 @@ def __init__(
         self.compact_configuration_api = CompactConfigurationApi(
             api=self.api,
             compact_resource=self.compact_resource,
-            live_compacts_resource=self.live_compacts_resource,
+            live_compacts_jurisdictions_resource=self.live_compacts_jurisdictions_resource,
             jurisdictions_resource=self.jurisdictions_resource,
             public_jurisdictions_resource=self.public_compacts_compact_jurisdictions_resource,
             jurisdiction_resource=self.jurisdiction_resource,

backend/compact-connect/stacks/api_stack/v1_api/compact_configuration_api.py

@@ -25,7 +25,7 @@ def __init__(
         *,
         api: CCApi,
         compact_resource: Resource,
-        live_compacts_resource: Resource,
+        live_compacts_jurisdictions_resource: Resource,
         jurisdictions_resource: Resource,
         public_jurisdictions_resource: Resource,
         jurisdiction_resource: Resource,
@@ -39,8 +39,8 @@ def __init__(
         self.api = api
         # /v1/compacts/{compact}
         self.staff_users_compact_resource = compact_resource
-        # /v1/compacts/live
-        self.live_compacts_resource = live_compacts_resource
+        # /v1/public/compacts/jurisdictions/live
+        self.live_compacts_jurisdictions_resource = live_compacts_jurisdictions_resource
         # /v1/compacts/{compact}/jurisdictions
         self.staff_users_jurisdictions_resource = jurisdictions_resource
         # /v1/compacts/{compact}/jurisdictions/{jurisdiction}
@@ -162,8 +162,8 @@ def _add_public_get_compact_jurisdictions_endpoint(self, compact_configuration_a
         )
 
     def _add_get_live_compact_jurisdictions_endpoint(self, compact_configuration_api_handler: PythonFunction):
-        """Add GET endpoint for /v1/compacts/live"""
-        get_live_compact_jurisdictions_method = self.live_compacts_resource.add_method(
+        """Add GET endpoint for /v1/public/compacts/jurisdictions/live"""
+        get_live_compact_jurisdictions_method = self.live_compacts_jurisdictions_resource.add_method(
             'GET',
             LambdaIntegration(compact_configuration_api_handler),
             method_responses=[

backend/compact-connect/tests/app/test_api/test_compact_configuration_api.py

@@ -146,33 +146,47 @@ def test_synth_generates_get_public_compact_jurisdictions_resource(self):
         )
 
     def test_synth_generates_get_live_compact_jurisdictions_resource(self):
-        """Test that the GET /v1/compacts/live endpoint is properly configured as a public endpoint"""
+        """Test that the GET /v1/public/compacts/jurisdictions/live endpoint is properly configured as a public endpoint"""
         api_stack = self.app.sandbox_backend_stage.api_stack
         api_stack_template = Template.from_stack(api_stack)
 
-        # Ensure the resource is created with expected path
+        # Ensure the /v1/public/compacts/jurisdictions resource is created
+        api_stack_template.has_resource_properties(
+            type=CfnResource.CFN_RESOURCE_TYPE_NAME,
+            props={
+                'ParentId': {
+                    # Verify the parent id matches the expected 'public/compacts' resource
+                    'Ref': api_stack.get_logical_id(api_stack.api.v1_api.public_compacts_resource.node.default_child),
+                },
+                'PathPart': 'jurisdictions',
+            },
+        )
+
+        # Ensure the /v1/public/compacts/jurisdictions/live resource is created
         api_stack_template.has_resource_properties(
             type=CfnResource.CFN_RESOURCE_TYPE_NAME,
             props={
                 'ParentId': {
-                    # Verify the parent id matches the expected 'compacts' resource
-                    'Ref': api_stack.get_logical_id(api_stack.api.v1_api.compacts_resource.node.default_child),
+                    # Verify the parent id matches the expected 'public/compacts/jurisdictions' resource
+                    'Ref': api_stack.get_logical_id(
+                        api_stack.api.v1_api.public_compacts_jurisdictions_resource.node.default_child
+                    ),
                 },
                 'PathPart': 'live',
             },
         )
 
-        # Get the live compacts resource
-        live_compacts_resource_id = api_stack.get_logical_id(
-            api_stack.api.v1_api.live_compacts_resource.node.default_child
+        # Get the live compacts jurisdictions resource
+        live_compacts_jurisdictions_resource_id = api_stack.get_logical_id(
+            api_stack.api.v1_api.live_compacts_jurisdictions_resource.node.default_child
         )
 
         # Ensure the GET method is configured with the lambda integration (no authorizer since it's public)
         api_stack_template.has_resource_properties(
             type=CfnMethod.CFN_RESOURCE_TYPE_NAME,
             props={
                 'HttpMethod': 'GET',
-                'ResourceId': {'Ref': live_compacts_resource_id},
+                'ResourceId': {'Ref': live_compacts_jurisdictions_resource_id},
                 # ensure the lambda integration is configured with the expected handler
                 'Integration': TestApi.generate_expected_integration_object(
                     api_stack.get_logical_id(