NPA-3889: Expanded examples for the related person

sandbox/api/app.py

@@ -4,16 +4,15 @@
 from flask import Flask, request
 
 from .constants import (
-    INTERNAL_ERROR_RESPONSE,
     INTERNAL_SERVER_ERROR_EXAMPLE,
-    LIST_RELATIONSHIP,
-    LIST_RELATIONSHIP_INCLUDE,
+    RELATED__LIST_RELATIONSHIP,
+    RELATED__LIST_RELATIONSHIP_WITH_INCLUDE,
     INVALIDATED_RESOURCE,
-    QUESTIONNAIRE_RESPONSE_SUCCESS,
-    VALIDATE_RELATIONSHIP_009,
-    VALIDATE_RELATIONSHIP_025,
-    VALIDATE_RELATIONSHIP_INCLUDE_009,
-    VALIDATE_RELATIONSHIP_INCLUDE_025,
+    QUESTIONNAIRE_RESPONSE__SUCCESS,
+    RELATED__VERIFY_RELATIONSHIP_09,
+    RELATED__VERIFY_RELATIONSHIP_25,
+    RELATED__VERIFY_RELATIONSHIP_09_WITH_INCLUDE,
+    RELATED__VERIFY_RELATIONSHIP_25_WITH_INCLUDE,
     CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP,
     CONSENT__SINGLE_CONSENTING_ADULT_RELATIONSHIP_INCLUDE_BOTH,
     CONSENT__SINGLE_MOTHER_CHILD_RELATIONSHIP,
@@ -33,9 +32,7 @@
     check_for_related_person_errors,
     check_for_list,
     check_for_validate,
-    generate_response,
     generate_response_from_example,
-    load_json_file,
     remove_system,
     check_for_consent_include_params,
     check_for_consent_filtering,
@@ -84,8 +81,8 @@ def get_related_persons() -> Union[dict, tuple]:
             identifier,
             patient_identifier,
             include,
-            VALIDATE_RELATIONSHIP_009,
-            VALIDATE_RELATIONSHIP_INCLUDE_009,
+            RELATED__VERIFY_RELATIONSHIP_09,
+            RELATED__VERIFY_RELATIONSHIP_09_WITH_INCLUDE,
         ):
             return zero_nine
 
@@ -94,25 +91,25 @@ def get_related_persons() -> Union[dict, tuple]:
             identifier,
             patient_identifier,
             include,
-            VALIDATE_RELATIONSHIP_025,
-            VALIDATE_RELATIONSHIP_INCLUDE_025,
+            RELATED__VERIFY_RELATIONSHIP_25,
+            RELATED__VERIFY_RELATIONSHIP_25_WITH_INCLUDE,
         ):
             return two_five
 
         if one_seven := check_for_list(
             "9000000017",
             identifier,
             include,
-            LIST_RELATIONSHIP,
-            LIST_RELATIONSHIP_INCLUDE,
+            RELATED__LIST_RELATIONSHIP,
+            RELATED__LIST_RELATIONSHIP_WITH_INCLUDE,
         ):
             return one_seven
 
         raise ValueError("Invalid request")
 
     except Exception as e:
         logger.error(e)
-        return generate_response(load_json_file(INTERNAL_ERROR_RESPONSE), 500)
+        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
 
 
 @app.route(f"/{COMMON_PATH}/QuestionnaireResponse", methods=["POST"])
@@ -124,10 +121,10 @@ def post_questionnaire_response() -> Union[dict, tuple]:
     """
 
     try:
-        return generate_response(load_json_file(QUESTIONNAIRE_RESPONSE_SUCCESS), 200)
+        return generate_response_from_example(QUESTIONNAIRE_RESPONSE__SUCCESS, 200)
     except Exception as e:
         logger.error(e)
-        return generate_response(load_json_file(INTERNAL_ERROR_RESPONSE), 500)
+        return generate_response_from_example(INTERNAL_SERVER_ERROR_EXAMPLE, 500)
 
 
 @app.route(f"/{COMMON_PATH}/Consent", methods=["GET"])

sandbox/api/constants.py

@@ -1,29 +1,5 @@
-EMPTY_RESPONSE = "./api/responses/GET_RelatedPerson/empty_response_9000000033.json"
-LIST_RELATIONSHIP = (
-    "./api/responses/GET_RelatedPerson/list_relationship_9000000017.json"
-)
-LIST_RELATIONSHIP_INCLUDE = (
-    "./api/responses/GET_RelatedPerson/list_relationship_include_9000000017.json"
-)
-VALIDATE_RELATIONSHIP_009 = (
-    "./api/responses/GET_RelatedPerson/verify_relationship_9000000009.json"
-)
-VALIDATE_RELATIONSHIP_INCLUDE_009 = (
-    "./api/responses/GET_RelatedPerson/verify_relationship_include_9000000009.json"
-)
-VALIDATE_RELATIONSHIP_025 = (
-    "./api/responses/GET_RelatedPerson/verify_relationship_9000000025.json"
-)
-VALIDATE_RELATIONSHIP_INCLUDE_025 = (
-    "./api/responses/GET_RelatedPerson/verify_relationship_include_9000000025.json"
-)
-INTERNAL_ERROR_RESPONSE = "./api/responses/internal_server_error.json"
 INCLUDE_FLAG = "RelatedPerson:patient"
 
-QUESTIONNAIRE_RESPONSE_SUCCESS = (
-    "./api/responses/POST_QuestionnaireResponse/questionnaire_response_success.json"
-)
-
 PATIENT_IDENTIFIERS = ["9000000017", "9000000033"]
 RELATED_IDENTIFIERS = ["9000000009", "9000000025"]
 
@@ -78,3 +54,33 @@
 CONSENT__STATUS_PARAM_INVALID = (
     f"{CONSENT__DIRECTORY}errors/invalid-status-parameter.yaml"
 )
+
+QR_DIRECTORY = "./api/examples/POST_QuestionnaireResponse/"
+QUESTIONNAIRE_RESPONSE__SUCCESS = f"{QR_DIRECTORY}success.yaml"
+
+RELATED_DIRECTORY = "./api/examples/GET_RelatedPerson/"
+RELATED__ERROR_IDENTIFIER_MISSING = (
+    f"{RELATED_DIRECTORY}errors/invalid-identifier-missing.yaml"
+)
+RELATED__ERROR_IDENTIFIER_SYSTEM = (
+    f"{RELATED_DIRECTORY}errors/invalid-identifier-system.yaml"
+)
+RELATED__ERROR_IDENTIFIER = f"{RELATED_DIRECTORY}errors/invalid-identifier.yaml"
+RELATED__EMPTY_RESPONSE = f"{RELATED_DIRECTORY}empty_response.yaml"
+RELATED__LIST_RELATIONSHIP = f"{RELATED_DIRECTORY}list_relationship_9000000017.yaml"
+RELATED__LIST_RELATIONSHIP_WITH_INCLUDE = (
+    f"{RELATED_DIRECTORY}list_relationship_9000000017_include.yaml"
+)
+RELATED__VERIFY_RELATIONSHIP_09 = (
+    f"{RELATED_DIRECTORY}verify_relationship_9000000009.yaml"
+)
+RELATED__VERIFY_RELATIONSHIP_09_WITH_INCLUDE = (
+    f"{RELATED_DIRECTORY}verify_relationship_9000000009_include.yaml"
+)
+RELATED__VERIFY_RELATIONSHIP_25 = (
+    f"{RELATED_DIRECTORY}verify_relationship_9000000025.yaml"
+)
+RELATED__VERIFY_RELATIONSHIP_25_WITH_INCLUDE = (
+    f"{RELATED_DIRECTORY}verify_relationship_9000000025_include.yaml"
+)
+RELATED__EMPTY_RESPONSE = f"{RELATED_DIRECTORY}empty_response_9000000033.yaml"