docs improvement

Author: NorseGaud

.github/workflows/python-app.yml

@@ -8,6 +8,9 @@ on:
   pull_request:
     branches:
       - main
+  push:
+    branches:
+      - main
 
 permissions:
   contents: read

DEVELOPMENT.md

@@ -200,13 +200,10 @@ This is included in `./run_ci_checks.sh`.
 ## Release Process
 
 1. Update version in `JSONLib/__version__.py`
-2. Update CHANGELOG (if maintained)
-3. Run full CI checks: `./run_ci_checks.sh`
-4. Build package: `./run_build_only.sh`
-5. Test on TestPyPI: `./run_testpypi_upload.sh --verify`
-6. Publish to PyPI: `twine upload dist/*`
-7. Create GitHub release with tag
-8. Update documentation site if needed
+2. Run full CI checks: `./run_ci_checks.sh`
+3. Test on TestPyPI: `./run_testpypi_upload.sh --verify`
+4. Publish to PyPI: `twine upload dist/*`
+5. Create GitHub release with tag
 
 ## Help & Support
 

JSONLib/jsonlib.py

@@ -108,9 +108,30 @@ def add_object_to_json(self, json_object, json_path, object_to_add):
 
         Return new json object.
 
+        *Behavior:*
+
+        - If the json_path exists and points to a dictionary: the object_to_add keys are merged into it
+        - If the json_path exists and points to a list: the object_to_add is appended to the list
+        - If the json_path does NOT exist: a new field is created with object_to_add as its value
+
+        *Important Note:*
+
+        When creating a new field (non-existent path), the entire object_to_add becomes the value.
+        This means if you add {key1: value1} to $.key1, the result will be {key1: {key1: value1}}.
+        To avoid this nesting, add to an existing path or use a different field name.
+
         Examples:
+        | # Adding to existing path (merges keys) |
+        | ${json}=  | Convert String To Json | {"address": {"street": "Main St"}} |
         | ${dict}=  | Create Dictionary    | latitude=13.1234 | longitude=130.1234 |
-        | ${json}=  |  Add Object To Json  | ${json}          | $..address         |  ${dict} |
+        | ${json}=  | Add Object To Json   | ${json}          | $..address         | ${dict} |
+        | # Result: {"address": {"street": "Main St", "latitude": "13.1234", "longitude": "130.1234"}} |
+        |           |                      |                  |                    |                    |
+        | # Adding to non-existent path (creates new nested object) |
+        | ${json}=  | Convert String To Json | {"name": "John"} |
+        | ${dict}=  | Create Dictionary    | city=Bangkok |
+        | ${json}=  | Add Object To Json   | ${json}          | $.location         | ${dict} |
+        | # Result: {"name": "John", "location": {"city": "Bangkok"}} |
         """
         json_path_expr = self._parse(json_path)
         json_object_cpy = deepcopy(json_object)

acceptance/JSONLib.robot

@@ -23,6 +23,18 @@ TestAddJSONObjectByJSONPath
     Dictionary Should Contain Key    ${json_obj2}    friends
     Dictionaries Should Be Equal    ${json_obj_orignal}      ${json_obj_input}
 
+TestAddObjectToNonExistentPath
+    [Documentation]  When adding to a non-existent path, the entire object becomes the value.
+    ...              For example, adding {city: Bangkok} to $.location creates {location: {city: Bangkok}}.
+    ...              This is the expected behavior - the object is nested under the new field.
+    ${location_data}=    Create Dictionary    city=Bangkok    country=Thailand
+    ${json_with_location}=    Add Object To Json     ${json_obj_input}    $.location    ${location_data}
+    # The entire location_data object becomes the value of the new 'location' field
+    Dictionary Should Contain Key    ${json_with_location}    location
+    Dictionaries Should Be Equal    ${json_with_location['location']}    ${location_data}
+    # Verify original data is preserved
+    Dictionary Should Contain Key    ${json_with_location}    firstName
+    
 TestGetValueByJSONPath
     [Documentation]  Get some json object using JSONPath
     ${values}=     Get Value From Json    ${json_obj_input}    $..address.postalCode