Adding Safeguarding Issues to the API docs (#198)

* Adding Safeguarding Issues to the API docs

* Replace all localhost with secure.tutorcruncher.com

* Rename all

* Changes to wellbeing concerns

* Add role_type in all locations

* Rename

* Actions script

* Add to subject type href

Author: DanJezeph15

data/actions.json

@@ -2062,5 +2062,33 @@
     "subject_types": [
       "Client"
     ]
+  },
+  {
+    "key": "RAISED_A_WELLBEING_CONCERN",
+    "value": "RAISED_A_WELLBEING_CONCERN",
+    "msg": "Created a Safeguarding/Wellbeing Concern",
+    "help_text": "When a Safeguarding/Wellbeing Concern is created.",
+    "extra_msg": "",
+    "subject_types": [
+      "Safeguarding/Wellbeing Concern"
+    ]
+  },
+  {
+    "key": "RESOLVED_A_WELLBEING_CONCERN",
+    "value": "RESOLVED_A_WELLBEING_CONCERN",
+    "msg": "Resolved a Safeguarding/Wellbeing Concern",
+    "help_text": "When a Safeguarding/Wellbeing Concern is resolved.",
+    "extra_msg": "",
+    "subject_types": [
+      "Safeguarding/Wellbeing Concern"
+    ]
+  },
+  {
+    "key": "EXPORTED_WELLBEING_CONCERNS",
+    "value": "EXPORTED_WELLBEING_CONCERNS",
+    "msg": "Exported Safeguarding/Wellbeing Concerns",
+    "help_text": "When someone exports a list of Safeguarding/Wellbeing Concerns.",
+    "extra_msg": "",
+    "subject_types": []
   }
 ]

extensions.py

@@ -58,6 +58,7 @@ def json_line_list(ctx, file_name):
     'Task': 'tasks',
     'Note': 'notes',
     'Package': 'package',
+    'Safeguarding/Wellbeing Concern': 'wellbeing-concerns',
 }
 
 

pages/adhoccharges/ad-hoc-charge-object.json

@@ -22,6 +22,7 @@
     "first_name": "Nicole",
     "last_name": "Beggs",
     "email": "[email protected]",
+    "role_type": "Client",
     "url": "https://secure.tutorcruncher.com/api/clients/37/"
   },
   "contractor": null,
@@ -42,6 +43,7 @@
         "first_name": "Nicole",
         "last_name": "Beggs",
         "email": "[email protected]",
+        "role_type": "Client",
         "url": "https://secure.tutorcruncher.com/api/clients/37/"
       },
       "status": "paid",

pages/adhoccharges/create-an-ad-hoc-charge.json

@@ -22,14 +22,16 @@
     "first_name": "Nicole",
     "last_name": "Beggs",
     "email": "[email protected]",
+    "role_type": "Client",
     "url": "https://secure.tutorcruncher.com/api/clients/37/"
   },
   "contractor": null,
   "creator": {
     "email": "[email protected]",
     "first_name": "Billy",
     "id": 59,
-    "last_name": "Holiday"
+    "last_name": "Holiday",
+    "role_type": "Administrator"
   },
   "currency": "GBP",
   "currency_conversion": null,

pages/adhoccharges/get-an-ad-hoc-charge.json

@@ -22,6 +22,7 @@
     "first_name": "Nicole",
     "last_name": "Beggs",
     "email": "[email protected]",
+    "role_type": "Client",
     "url": "https://secure.tutorcruncher.com/api/clients/37/"
   },
   "contractor": null,
@@ -42,6 +43,7 @@
         "first_name": "Nicole",
         "last_name": "Beggs",
         "email": "[email protected]",
+        "role_type": "Client",
         "url": "https://secure.tutorcruncher.com/api/clients/37/"
       },
       "status": "paid",

pages/adhoccharges/update-an-ad-hoc-charge.json

@@ -22,14 +22,16 @@
     "first_name": "Nicole",
     "last_name": "Beggs",
     "email": "[email protected]",
+    "role_type": "Client",
     "url": "https://secure.tutorcruncher.com/api/clients/37/"
   },
   "contractor": null,
   "creator": {
     "email": "[email protected]",
     "first_name": "Billy",
     "id": 59,
-    "last_name": "Holiday"
+    "last_name": "Holiday",
+    "role_type": "Administrator"
   },
   "currency": "GBP",
   "currency_conversion": null,

pages/api.yml

@@ -122,6 +122,10 @@ endpoint_sections:
     title: Reviews
     id: reviews
     layout: /reviews/reviews.yml
+  -
+    title: Safeguarding/Wellbeing Concerns
+    id: wellbeing-concerns
+    layout: /wellbeing-concerns/wellbeing-concerns.yml
   -
     title: Services (Jobs)
     id: services

pages/contractor-skills/contractor-skills-object.json

@@ -5,6 +5,7 @@
     "first_name": "James",
     "last_name": "Higgins",
     "email": "[email protected]",
+    "role_type": "Tutor",
     "url": "https://secure.tutorcruncher.com/api/contractors/52/"
   },
   "subject": {

pages/contractor-skills/create-a-contractor-skill.json

@@ -5,7 +5,8 @@
         "first_name": "Billy",
         "last_name": "Holiday",
         "email": null,
-        "url": "https://secure.tutorcruncher.com/api/69/"
+        "role_type": "Tutor",
+        "url": "https://secure.tutorcruncher.com/api/contractors/69/"
     },
     "subject": {
         "id": 51,

pages/contractor-skills/get-a-contractor-skill.json

@@ -5,6 +5,7 @@
     "first_name": "James",
     "last_name": "Higgins",
     "email": "[email protected]",
+    "role_type": "Tutor",
     "url": "https://secure.tutorcruncher.com/api/contractors/52/"
   },
   "subject": {
@@ -20,4 +21,4 @@
     "ranking": 50.0,
     "custom_to_branch": null
   }
-} 
+}