Skip to content

Commit

Permalink
Deploying to gh-pages from @ d027556 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mxco86 committed Sep 17, 2024
1 parent ae32a93 commit c1254d6
Show file tree
Hide file tree
Showing 31 changed files with 217 additions and 44 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"}]

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion tech-docs/projects/dps-and-delius/api/pages.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
2 changes: 1 addition & 1 deletion tech-docs/projects/dps-and-delius/search.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion tech-docs/projects/hmpps-auth-and-delius/api-docs.json
Original file line number Diff line number Diff line change
@@ -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":{"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"}}}}
{"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":{}}},"200":{"description":"User authenticated","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"}}}}
8 changes: 4 additions & 4 deletions tech-docs/projects/hmpps-auth-and-delius/api-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,16 @@ paths:
$ref: "#/components/schemas/AuthenticationRequest"
required: true
responses:
"401":
description: Authentication failure
"403":
description: "Client role required: `DELIUS_USER_AUTH`"
content:
text/plain: {}
"200":
description: User authenticated
content:
text/plain: {}
"403":
description: "Client role required: `DELIUS_USER_AUTH`"
"401":
description: Authentication failure
content:
text/plain: {}
/user:
Expand Down
8 changes: 4 additions & 4 deletions tech-docs/projects/hmpps-auth-and-delius/api-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -239,9 +239,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>DELIUS_USER_AUTH</code></p>



Expand All @@ -265,9 +265,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>



Expand Down
2 changes: 1 addition & 1 deletion tech-docs/projects/hmpps-auth-and-delius/search.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"AsyncAPI Reference","url":"../asyncapi-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"}]

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,18 @@
<nav id="toc" class="js-toc-list toc__list" aria-labelledby="toc-heading" data-module="collapsible-navigation">
<ul>
<li>
<a href="./index.html"><span>prison-education-and-delius</span></a>
<a href="./index.html"><span>Prison Education and Delius</span></a>
<ul>
<li>
<a href="./index.html#business-need"><span>Business Need</span></a>
</li>
<li>
<a href="./index.html#context-map"><span>Context Map</span></a>
</li>
<li>
<a href="./index.html#interfaces"><span>Interfaces</span></a>
</li>
</ul>
</li>
<li>
<a href="./api-reference.html"><span>API Reference v1.0</span></a>
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
[{"title":"Search","url":"../search/index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"About","url":"../index.html","review_by":null,"owner_slack":"#probation-integration-tech"},{"title":"API Reference","url":"../api-reference.html","review_by":null,"owner_slack":"#probation-integration-tech"}]
Loading

0 comments on commit c1254d6

Please sign in to comment.