Deploying to gh-pages from @ 62da423 🚀

tech-docs/projects/approved-premises-and-delius/api-docs.yaml

@@ -623,15 +623,15 @@ components:
           format: int32
         sort:
           $ref: '#/components/schemas/SortObject'
-        first:
-          type: boolean
-        last:
-          type: boolean
         numberOfElements:
           type: integer
           format: int32
         pageable:
           $ref: '#/components/schemas/PageableObject'
+        first:
+          type: boolean
+        last:
+          type: boolean
         empty:
           type: boolean
     PageableObject:

tech-docs/projects/approved-premises-and-delius/api-reference.html

@@ -1057,8 +1057,6 @@ <h4 id="approved-premises-code-staff-get-responses">Responses</h4>
     "sorted": "boolean",
     "unsorted": "boolean"
   },
-  "first": "boolean",
-  "last": "boolean",
   "numberOfElements": "integer",
   "pageable": {
     "offset": "integer",
@@ -1072,6 +1070,8 @@ <h4 id="approved-premises-code-staff-get-responses">Responses</h4>
     "pageSize": "integer",
     "unpaged": "boolean"
   },
+  "first": "boolean",
+  "last": "boolean",
   "empty": "boolean"
 }</code></pre>
 
@@ -2131,8 +2131,8 @@ <h3 id="schema-pagestaffresponse">PageStaffResponse</h3>
 </tr>
 
 <tr>
-<td>first</td>
-<td>boolean</td>
+<td>numberOfElements</td>
+<td>integer</td>
 <td>false</td>
 <td></td>
 <td>
@@ -2141,18 +2141,18 @@ <h3 id="schema-pagestaffresponse">PageStaffResponse</h3>
 </tr>
 
 <tr>
-<td>last</td>
-<td>boolean</td>
+<td>pageable</td>
+<td>object</td>
 <td>false</td>
 <td></td>
 <td>
-
+  <a href='#schema-pageableobject'>PageableObject</a>
 </td>
 </tr>
 
 <tr>
-<td>numberOfElements</td>
-<td>integer</td>
+<td>first</td>
+<td>boolean</td>
 <td>false</td>
 <td></td>
 <td>
@@ -2161,12 +2161,12 @@ <h3 id="schema-pagestaffresponse">PageStaffResponse</h3>
 </tr>
 
 <tr>
-<td>pageable</td>
-<td>object</td>
+<td>last</td>
+<td>boolean</td>
 <td>false</td>
 <td></td>
 <td>
-  <a href='#schema-pageableobject'>PageableObject</a>
+
 </td>
 </tr>
 

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 `ROLE_DELIUS_USER_AUTH`.","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 `ROLE_DELIUS_USER_AUTH`.","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: `ROLE_DELIUS_USER_AUTH`","content":{"text/plain":{}}}}}},"/user":{"get":{"tags":["User details"],"description":"Get users by email. Requires `ROLE_DELIUS_USER_AUTH`.","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 `ROLE_DELIUS_USER_AUTH` or `ROLE_DELIUS_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"}}}}}}}},"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 `ROLE_DELIUS_USER_AUTH`.","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 `ROLE_DELIUS_USER_AUTH`.","operationId":"authenticate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthenticationRequest"}}},"required":true},"responses":{"403":{"description":"Client role required: `ROLE_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 `ROLE_DELIUS_USER_AUTH`.","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 `ROLE_DELIUS_USER_AUTH` or `ROLE_DELIUS_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"}}}}}}}},"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,6 +50,10 @@ paths:
               $ref: '#/components/schemas/AuthenticationRequest'
         required: true
       responses:
+        "403":
+          description: "Client role required: `ROLE_DELIUS_USER_AUTH`"
+          content:
+            text/plain: {}
         "401":
           description: Authentication failure
           content:
@@ -58,10 +62,6 @@ paths:
           description: User authenticated
           content:
             text/plain: {}
-        "403":
-          description: "Client role required: `ROLE_DELIUS_USER_AUTH`"
-          content:
-            text/plain: {}
   /user:
     get:
       tags:

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

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