Deploying to gh-pages from @ 681558a 🚀

tech-docs/projects/hmpps-auth-and-delius/api-docs.json

@@ -1 +1 @@
-{"openapi":"3.0.1","info":{"title":"API Reference","contact":{"name":"Probation Integration Team","url":"https://mojdt.slack.com/archives/C02HQ4M2YQN","email":"[email protected]"},"license":{"name":"MIT","url":"https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/LICENSE"},"version":"1.0"},"servers":[{"url":"/"}],"security":[{"hmpps-auth-token":[]}],"paths":{"/user/{username}/password":{"post":{"tags":["User details"],"description":"Change a Delius user's password. Requires `PROBATION_API__HMPPS_AUTH__PASSWORD__RW`.","operationId":"changePassword","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeRequest"}}},"required":true},"responses":{"200":{"description":"Password changed successfully"},"404":{"description":"User not found"}}}},"/authenticate":{"post":{"tags":["Authentication"],"description":"Authenticate a Delius username and password. Requires `PROBATION_API__HMPPS_AUTH__AUTHENTICATE`.","operationId":"authenticate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationRequest"}}},"required":true},"responses":{"200":{"description":"User authenticated","content":{"text/plain":{}}},"403":{"description":"Client role required: `DELIUS_USER_AUTH`","content":{"text/plain":{}}},"401":{"description":"Authentication failure","content":{"text/plain":{}}}}}},"/user":{"get":{"tags":["User details"],"description":"Get users by email. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUsersByEmail","parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"/user/{username}":{"get":{"tags":["User details"],"description":"Get user details. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetails","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}},"/user/details/{userId}":{"get":{"tags":["User details"],"description":"Get user details by Id. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetailsById","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"components":{"schemas":{"PasswordChangeRequest":{"required":["password"],"type":"object","properties":{"password":{"type":"string"}}},"AuthenticationRequest":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"UserDetails":{"required":["enabled","firstName","roles","surname","userId","username"],"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"email":{"type":"string"},"enabled":{"type":"boolean"},"roles":{"type":"array","items":{"type":"string"}}}}},"securitySchemes":{"hmpps-auth-token":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}
+{"openapi":"3.0.1","info":{"title":"API Reference","contact":{"name":"Probation Integration Team","url":"https://mojdt.slack.com/archives/C02HQ4M2YQN","email":"[email protected]"},"license":{"name":"MIT","url":"https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/LICENSE"},"version":"1.0"},"servers":[{"url":"/"}],"security":[{"hmpps-auth-token":[]}],"paths":{"/user/{username}/password":{"post":{"tags":["User details"],"description":"Change a Delius user's password. Requires `PROBATION_API__HMPPS_AUTH__PASSWORD__RW`.","operationId":"changePassword","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PasswordChangeRequest"}}},"required":true},"responses":{"200":{"description":"Password changed successfully"},"404":{"description":"User not found"}}}},"/authenticate":{"post":{"tags":["Authentication"],"description":"Authenticate a Delius username and password. Requires `PROBATION_API__HMPPS_AUTH__AUTHENTICATE`.","operationId":"authenticate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationRequest"}}},"required":true},"responses":{"403":{"description":"Client role required: `DELIUS_USER_AUTH`","content":{"text/plain":{}}},"401":{"description":"Authentication failure","content":{"text/plain":{}}},"200":{"description":"User authenticated","content":{"text/plain":{}}}}}},"/user":{"get":{"tags":["User details"],"description":"Get users by email. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUsersByEmail","parameters":[{"name":"email","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"/user/{username}":{"get":{"tags":["User details"],"description":"Get user details. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetails","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}},"/user/details/{userId}":{"get":{"tags":["User details"],"description":"Get user details by Id. Requires `PROBATION_API__HMPPS_AUTH__USER_DETAILS`.","operationId":"getUserDetailsById","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}}}}},"components":{"schemas":{"PasswordChangeRequest":{"required":["password"],"type":"object","properties":{"password":{"type":"string"}}},"AuthenticationRequest":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"UserDetails":{"required":["enabled","firstName","roles","surname","userId","username"],"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"surname":{"type":"string"},"email":{"type":"string"},"enabled":{"type":"boolean"},"roles":{"type":"array","items":{"type":"string"}}}}},"securitySchemes":{"hmpps-auth-token":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}

tech-docs/projects/hmpps-auth-and-delius/api-docs.yaml

@@ -50,10 +50,6 @@ paths:
               $ref: "#/components/schemas/AuthenticationRequest"
         required: true
       responses:
-        "200":
-          description: User authenticated
-          content:
-            text/plain: {}
         "403":
           description: "Client role required: `DELIUS_USER_AUTH`"
           content:
@@ -62,6 +58,10 @@ paths:
           description: Authentication failure
           content:
             text/plain: {}
+        "200":
+          description: User authenticated
+          content:
+            text/plain: {}
   /user:
     get:
       tags:

tech-docs/projects/hmpps-auth-and-delius/api-reference.html

@@ -239,9 +239,9 @@ <h4 id="authenticate-post-responses">Responses</h4>
 <tbody>
 
 <tr>
-<td>200</td>
+<td>403</td>
 <td>
-<p>User authenticated</p>
+<p>Client role required: <code>DELIUS_USER_AUTH</code></p>
 
 
 
@@ -252,9 +252,9 @@ <h4 id="authenticate-post-responses">Responses</h4>
 </tr>
 
 <tr>
-<td>403</td>
+<td>401</td>
 <td>
-<p>Client role required: <code>DELIUS_USER_AUTH</code></p>
+<p>Authentication failure</p>
 
 
 
@@ -265,9 +265,9 @@ <h4 id="authenticate-post-responses">Responses</h4>
 </tr>
 
 <tr>
-<td>401</td>
+<td>200</td>
 <td>
-<p>Authentication failure</p>
+<p>User authenticated</p>
 
 
 

tech-docs/projects/manage-supervision-and-delius/api-docs.yaml

@@ -1649,6 +1649,38 @@ components:
           $ref: "#/components/schemas/PersonSummary"
         appointment:
           $ref: "#/components/schemas/Activity"
+    MappaDetail:
+      required:
+      - startDate
+      type: object
+      properties:
+        level:
+          type: integer
+          format: int32
+        levelDescription:
+          type: string
+        category:
+          type: integer
+          format: int32
+        categoryDescription:
+          type: string
+        startDate:
+          type: string
+          format: date
+        reviewDate:
+          type: string
+          format: date
+    Opd:
+      required:
+      - date
+      - eligible
+      type: object
+      properties:
+        eligible:
+          type: boolean
+        date:
+          type: string
+          format: date-time
     PersonRiskFlags:
       required:
       - personSummary
@@ -1658,6 +1690,10 @@ components:
       properties:
         personSummary:
           $ref: "#/components/schemas/PersonSummary"
+        opd:
+          $ref: "#/components/schemas/Opd"
+        mappa:
+          $ref: "#/components/schemas/MappaDetail"
         riskFlags:
           type: array
           items:

tech-docs/projects/manage-supervision-and-delius/api-reference.html

@@ -1906,6 +1906,18 @@ <h4 id="risk-flags-crn-get-responses">Responses</h4>
     "pnc": "string",
     "dateOfBirth": "string"
   },
+  "opd": {
+    "eligible": "boolean",
+    "date": "string"
+  },
+  "mappa": {
+    "level": "integer",
+    "levelDescription": "string",
+    "category": "integer",
+    "categoryDescription": "string",
+    "startDate": "string",
+    "reviewDate": "string"
+  },
   "riskFlags": [
     {
       "id": "integer",
@@ -6803,6 +6815,110 @@ <h3 id="schema-personappointment">PersonAppointment</h3>
 </tbody>
 </table>
 
+<h3 id="schema-mappadetail">MappaDetail</h3>
+
+
+<table class='schema-mappadetail'>
+<thead>
+<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th><th>Schema</th></tr>
+</thead>
+<tbody>
+
+<tr>
+<td>level</td>
+<td>integer</td>
+<td>false</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+<tr>
+<td>levelDescription</td>
+<td>string</td>
+<td>false</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+<tr>
+<td>category</td>
+<td>integer</td>
+<td>false</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+<tr>
+<td>categoryDescription</td>
+<td>string</td>
+<td>false</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+<tr>
+<td>startDate</td>
+<td>string</td>
+<td>true</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+<tr>
+<td>reviewDate</td>
+<td>string</td>
+<td>false</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+</tbody>
+</table>
+
+<h3 id="schema-opd">Opd</h3>
+
+
+<table class='schema-opd'>
+<thead>
+<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th><th>Schema</th></tr>
+</thead>
+<tbody>
+
+<tr>
+<td>eligible</td>
+<td>boolean</td>
+<td>true</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+<tr>
+<td>date</td>
+<td>string</td>
+<td>true</td>
+<td></td>
+<td>
+
+</td>
+</tr>
+
+</tbody>
+</table>
+
 <h3 id="schema-personriskflags">PersonRiskFlags</h3>
 
 
@@ -6822,6 +6938,26 @@ <h3 id="schema-personriskflags">PersonRiskFlags</h3>
 </td>
 </tr>
 
+<tr>
+<td>opd</td>
+<td>object</td>
+<td>false</td>
+<td></td>
+<td>
+  <a href='#schema-opd'>Opd</a>
+</td>
+</tr>
+
+<tr>
+<td>mappa</td>
+<td>object</td>
+<td>false</td>
+<td></td>
+<td>
+  <a href='#schema-mappadetail'>MappaDetail</a>
+</td>
+</tr>
+
 <tr>
 <td>riskFlags</td>
 <td>array</td>