Deploying to gh-pages from @ 8a7252d 🚀

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":{}}},"401":{"description":"Authentication failure","content":{"text/plain":{}}},"403":{"description":"Client role required: `DELIUS_USER_AUTH`","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":{"401":{"description":"Authentication failure","content":{"text/plain":{}}},"200":{"description":"User authenticated","content":{"text/plain":{}}},"403":{"description":"Client role required: `DELIUS_USER_AUTH`","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,14 +50,14 @@ paths:
               $ref: "#/components/schemas/AuthenticationRequest"
         required: true
       responses:
-        "200":
-          description: User authenticated
-          content:
-            text/plain: {}
         "401":
           description: Authentication failure
           content:
             text/plain: {}
+        "200":
+          description: User authenticated
+          content:
+            text/plain: {}
         "403":
           description: "Client role required: `DELIUS_USER_AUTH`"
           content:

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>401</td>
 <td>
-<p>User authenticated</p>
+<p>Authentication failure</p>
 
 
 
@@ -252,9 +252,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/tier-to-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":{"/users/{username}/access/{crn}":{"get":{"tags":["user-controller"],"operationId":"userAccessCheck","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"crn","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseAccess"}}}}}}},"/tier-details/{crn}":{"get":{"tags":["tier-context-controller"],"operationId":"tierContext","parameters":[{"name":"crn","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TierDetails"}}}}}}},"/probation-cases":{"get":{"tags":["crn-resource"],"operationId":"findAllActiveCrns","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/person/{crn}":{"get":{"tags":["person-controller"],"operationId":"personDetails","parameters":[{"name":"crn","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonDetails"}}}}}}},"/docs/asyncapi":{"get":{"tags":["async-api-controller"],"operationId":"asyncApi","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"CaseAccess":{"required":["crn","userExcluded","userRestricted"],"type":"object","properties":{"crn":{"type":"string"},"userExcluded":{"type":"boolean"},"userRestricted":{"type":"boolean"},"exclusionMessage":{"type":"string"},"restrictionMessage":{"type":"string"}}},"Conviction":{"required":["breached","requirements"],"type":"object","properties":{"terminationDate":{"type":"string","format":"date"},"sentenceTypeCode":{"type":"string"},"breached":{"type":"boolean"},"requirements":{"type":"array","items":{"$ref":"#/components/schemas/Requirement"}}}},"Registration":{"required":["code","date","description"],"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"level":{"type":"string"},"date":{"type":"string","format":"date"}}},"Requirement":{"required":["mainCategoryTypeCode","restrictive"],"type":"object","properties":{"mainCategoryTypeCode":{"type":"string"},"restrictive":{"type":"boolean"}}},"TierDetails":{"required":["convictions","gender","previousEnforcementActivity","registrations"],"type":"object","properties":{"gender":{"type":"string"},"currentTier":{"type":"string"},"oGRSScore":{"type":"integer","format":"int64","writeOnly":true},"rSRScore":{"type":"number","format":"double","writeOnly":true},"registrations":{"type":"array","items":{"$ref":"#/components/schemas/Registration"}},"convictions":{"type":"array","items":{"$ref":"#/components/schemas/Conviction"}},"previousEnforcementActivity":{"type":"boolean"},"ogrsscore":{"type":"integer","format":"int64"},"rsrscore":{"type":"number","format":"double"}}},"Name":{"required":["forenames","surname"],"type":"object","properties":{"forenames":{"type":"string"},"surname":{"type":"string"}}},"PersonDetails":{"required":["crn","name"],"type":"object","properties":{"crn":{"type":"string"},"name":{"$ref":"#/components/schemas/Name"}}}},"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":{"/users/{username}/access/{crn}":{"get":{"tags":["user-controller"],"operationId":"userAccessCheck","parameters":[{"name":"username","in":"path","required":true,"schema":{"type":"string"}},{"name":"crn","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaseAccess"}}}}}}},"/tier-details/{crn}":{"get":{"tags":["tier-context-controller"],"operationId":"tierContext","parameters":[{"name":"crn","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TierDetails"}}}}}}},"/probation-cases":{"get":{"tags":["crn-resource"],"operationId":"findAllActiveCrns","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/person/{crn}":{"get":{"tags":["person-controller"],"operationId":"personDetails","parameters":[{"name":"crn","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonDetails"}}}}}}},"/docs/asyncapi":{"get":{"tags":["async-api-controller"],"operationId":"asyncApi","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}}},"components":{"schemas":{"CaseAccess":{"required":["crn","userExcluded","userRestricted"],"type":"object","properties":{"crn":{"type":"string"},"userExcluded":{"type":"boolean"},"userRestricted":{"type":"boolean"},"exclusionMessage":{"type":"string"},"restrictionMessage":{"type":"string"}}},"Conviction":{"required":["breached","requirements"],"type":"object","properties":{"terminationDate":{"type":"string","format":"date"},"sentenceTypeCode":{"type":"string"},"breached":{"type":"boolean"},"requirements":{"type":"array","items":{"$ref":"#/components/schemas/Requirement"}}}},"Registration":{"required":["code","date","description"],"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"level":{"type":"string"},"date":{"type":"string","format":"date"}}},"Requirement":{"required":["mainCategoryTypeCode","restrictive"],"type":"object","properties":{"mainCategoryTypeCode":{"type":"string"},"restrictive":{"type":"boolean"}}},"TierDetails":{"required":["convictions","gender","previousEnforcementActivity","registrations"],"type":"object","properties":{"gender":{"type":"string"},"currentTier":{"type":"string"},"oGRSScore":{"type":"integer","format":"int64","writeOnly":true},"rSRScore":{"type":"number","format":"double","writeOnly":true},"registrations":{"type":"array","items":{"$ref":"#/components/schemas/Registration"}},"convictions":{"type":"array","items":{"$ref":"#/components/schemas/Conviction"}},"previousEnforcementActivity":{"type":"boolean"},"rsrscore":{"type":"number","format":"double"},"ogrsscore":{"type":"integer","format":"int64"}}},"Name":{"required":["forenames","surname"],"type":"object","properties":{"forenames":{"type":"string"},"surname":{"type":"string"}}},"PersonDetails":{"required":["crn","name"],"type":"object","properties":{"crn":{"type":"string"},"name":{"$ref":"#/components/schemas/Name"}}}},"securitySchemes":{"hmpps-auth-token":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}

tech-docs/projects/tier-to-delius/api-docs.yaml

@@ -191,12 +191,12 @@ components:
             $ref: "#/components/schemas/Conviction"
         previousEnforcementActivity:
           type: boolean
-        ogrsscore:
-          type: integer
-          format: int64
         rsrscore:
           type: number
           format: double
+        ogrsscore:
+          type: integer
+          format: int64
     Name:
       required:
       - forenames

tech-docs/projects/tier-to-delius/api-reference.html

@@ -308,8 +308,8 @@ <h4 id="tier-details-crn-get-responses">Responses</h4>
     }
   ],
   "previousEnforcementActivity": "boolean",
-  "ogrsscore": "integer",
-  "rsrscore": "number"
+  "rsrscore": "number",
+  "ogrsscore": "integer"
 }</code></pre>
 
 </td>
@@ -746,8 +746,8 @@ <h3 id="schema-tierdetails">TierDetails</h3>
 </tr>
 
 <tr>
-<td>ogrsscore</td>
-<td>integer</td>
+<td>rsrscore</td>
+<td>number</td>
 <td>false</td>
 <td></td>
 <td>
@@ -756,8 +756,8 @@ <h3 id="schema-tierdetails">TierDetails</h3>
 </tr>
 
 <tr>
-<td>rsrscore</td>
-<td>number</td>
+<td>ogrsscore</td>
+<td>integer</td>
 <td>false</td>
 <td></td>
 <td>

tech-docs/projects/workforce-allocations-to-delius/api-docs.yaml

@@ -212,9 +212,7 @@ paths:
           content:
             application/json:
               schema:
-                type: array
-                items:
-                  $ref: "#/components/schemas/User"
+                $ref: "#/components/schemas/StreamingResponseBody"
   /staff/{code}/officer-view:
     get:
       tags:
@@ -956,6 +954,8 @@ components:
           format: date
         length:
           type: string
+    StreamingResponseBody:
+      type: object
     OfficerView:
       required:
       - casesDueToEndInNext4Weeks
@@ -1108,8 +1108,6 @@ components:
           $ref: "#/components/schemas/DocumentEvent"
         description:
           type: string
-    StreamingResponseBody:
-      type: object
     PrEvent:
       required:
       - offences

tech-docs/projects/workforce-allocations-to-delius/api-reference.html

@@ -756,7 +756,7 @@ <h4 id="users-get-responses">Responses</h4>
 
 </td>
 <td>
-
+<a href='#schema-streamingresponsebody'>StreamingResponseBody</a>
 </td>
 </tr>
 
@@ -3270,6 +3270,9 @@ <h3 id="schema-sentence">Sentence</h3>
 </tbody>
 </table>
 
+<h3 id="schema-streamingresponsebody">StreamingResponseBody</h3>
+
+
 <h3 id="schema-officerview">OfficerView</h3>
 
 
@@ -3657,9 +3660,6 @@ <h3 id="schema-relatedto">RelatedTo</h3>
 </tbody>
 </table>
 
-<h3 id="schema-streamingresponsebody">StreamingResponseBody</h3>
-
-
 <h3 id="schema-prevent">PrEvent</h3>