Updating gitleaks.toml to ignore SUBJECT_75TH_BIRTHDAY

Author: adrianoaru-nhs

docs/SubjectCriteriaBuilderApllication.md

@@ -122,7 +122,7 @@ Each entry in the file looks like this:
 
 ```json
 {
-  "key_name": "NHS_NUMBER",
+  "key": "NHS_NUMBER",
   "value_source": "",
   "notes": "Enter the 10-digit NHS Number of the subject you want to search for."
 }
@@ -132,7 +132,7 @@ Or, with allowed values and dependencies:
 
 ```json
 {
-  "key_name": "SUBJECT_HUB_CODE",
+  "key": "SUBJECT_HUB_CODE",
   "value_source": "SubjectHubCode.by_description",
   "notes": "Select the hub or organisation for the subject.",
   "allowed_values": [
@@ -145,7 +145,7 @@ Or, with allowed values and dependencies:
 }
 ```
 
-- **`key_name`:** The unique identifier for the criterion (must match the code).
+- **`key`:** The unique identifier for the criterion (must match the code).
 - **`value_source`:** (Optional) The source of the value, can be left blank. This refers to the class + method used in the subject selection query builder. This is not used by the code but is there to allow easier tracking/mapping.
 - **`notes`:** A clear, user-focused description of what the key is and what the user should input.
 - **`allowed_values`:** (Optional) An array of allowed values for the dropdown selection.
@@ -154,7 +154,7 @@ Or, with allowed values and dependencies:
 #### To add a new criterion
 
 1. Add a new object to the JSON array with the following fields:
-   - `"key_name"`: The `Enum` member name (must match the code).
+   - `"key"`: The `Enum` member name (must match the code).
    - `"value_source"`: (Optional) The value source, can be left blank.
    - `"notes"`: A clear, user-focused description of what the key is and what the user should input.
    - `"allowed_values"`: (Optional) An array of allowed values for the dropdown selection.
@@ -164,7 +164,7 @@ Or, with allowed values and dependencies:
 
 #### To edit a criterion
 
-- Find the object with the matching `"key_name"` and update the `"notes"`, `"allowed_values"`, or `"dependencies"` as needed.
+- Find the object with the matching `"key"` and update the `"notes"`, `"allowed_values"`, or `"dependencies"` as needed.
 - Save the file and reload the app.
 
 #### To remove a criterion
@@ -236,7 +236,7 @@ If you add new keys to the `SubjectSelectionCriteriaKey` `Enum` in your code, yo
 
 ```json
 {
-  "key_name": "SCREENING_STATUS",
+  "key": "SCREENING_STATUS",
   "value_source": "ScreeningStatusType.by_description_case_insensitive",
   "notes": "Select the current screening status for the subject.",
   "allowed_values": [

scripts/config/gitleaks.toml

@@ -17,3 +17,14 @@ regexes = [
 
 [allowlist]
 paths = ['''poetry.lock''', '''yarn.lock''']
+
+[[rules]]
+description = "Ignore SUBJECT_75TH_BIRTHDAY key"
+id = "ignore_subject_75th_birthday"
+regex = '''"key":\s*"SUBJECT_75TH_BIRTHDAY"'''
+
+[rules.allowlist]
+regexTarget = "match"
+regexes = [
+  '''"key":\s*"SUBJECT_75TH_BIRTHDAY"'''
+]

subject_criteria_builder.py

@@ -11,7 +11,7 @@
 import sqlparse
 from typing import Optional
 
-# Load environment variables from local.env. Needed for DB connectios
+# Load environment variables from local.env. Needed for DB connections
 load_dotenv(dotenv_path=os.path.join(os.path.dirname(__file__), "local.env"))
 
 CRITERIA_JSON_PATH = os.path.join(
@@ -51,7 +51,7 @@ def get_metadata_for_key(enum_key: str) -> dict:
         dict: The metadata for the specified criteria key, or an empty dictionary if not found.
     """
     for entry in CRITERIA_METADATA:
-        if entry["key_name"] == enum_key:
+        if entry["key"] == enum_key:
             return entry
     return {}
 
@@ -169,7 +169,7 @@ def get_filtered_keys(search_term: str) -> list:
     """
     Get a list of keys that match the search term.
     Args:
-        search_term (str): What the user is seraching
+        search_term (str): What the user is searching
     Returns:
         list: A list of all criteria matching the user's search
     """