Skip to content

Commit

Permalink
Deploying to gh-pages from @ 00cdec0 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@marcus-bcl
marcus-bcl committed Oct 23, 2024
1 parent fb252c2 commit a62bff1
Show file tree
Hide file tree
Showing 41 changed files with 16,338 additions and 12 deletions.
1 change: 1 addition & 0 deletions tech-docs/projects/appointment-reminders-and-delius/api-docs.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +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":{"/example/{inputId}":{"get":{"tags":["api-controller"],"operationId":"handle","parameters":[{"name":"inputId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}}}}},"components":{"securitySchemes":{"hmpps-auth-token":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}
38 changes: 38 additions & 0 deletions tech-docs/projects/appointment-reminders-and-delius/api-docs.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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:
/example/{inputId}:
get:
tags:
- api-controller
operationId: handle
parameters:
- name: inputId
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
components:
securitySchemes:
hmpps-auth-token:
type: http
name: Authorization
in: header
scheme: bearer
bearerFormat: JWT
252 changes: 252 additions & 0 deletions tech-docs/projects/appointment-reminders-and-delius/api-reference.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
<!doctype html>
<html lang="en" class="govuk-template no-js">
<head>
<meta content="IE=edge" http-equiv="X-UA-Compatible">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">

<title>API Reference - HMPPS Appointment Reminders And Delius</title>

<link href="stylesheets/manifest.css" rel="stylesheet" />

<link rel="canonical" href="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius/api-reference.html">

<meta name="twitter:card" content="summary" />
<meta name="twitter:domain" content="ministryofjustice.github.io" />
<meta name="twitter:image" content="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius/images/govuk-large.png" />
<meta name="twitter:title" content="API Reference - HMPPS Appointment Reminders And Delius" />
<meta name="twitter:url" content="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius/api-reference.html" />

<meta property="og:image" content="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius/images/govuk-large.png" />
<meta property="og:site_name" content="HMPPS Appointment Reminders And Delius" />
<meta property="og:title" content="API Reference" />
<meta property="og:type" content="object" />
<meta property="og:url" content="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius/api-reference.html" />


</head>

<body class="govuk-template__body">
<script>document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled');</script>

<div class="app-pane">
<div class="app-pane__header toc-open-disabled">
<a href="#content" class="govuk-skip-link" data-module="govuk-skip-link">Skip to main content</a>

<header class="govuk-header app-header" role="banner" data-module="govuk-header">
<div class="govuk-header__container govuk-header__container--full-width">
<div class="govuk-header__logo">
<a href="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius" class="govuk-header__link govuk-header__link--homepage">
<span class="govuk-header__product-name">
HMPPS Appointment Reminders And Delius
</span>
</a>
</div>
<div class="govuk-header__content">
<nav class="govuk-header__navigation govuk-header__navigation--end" aria-label="Menu">
<button type="button" class="govuk-header__menu-button govuk-js-header-toggle" aria-controls="navigation" aria-label="Show or hide menu">Menu</button>
<ul id="navigation" class="govuk-header__navigation-list">
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs">Home</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="https://github.com/ministryofjustice/hmpps-probation-integration-services#readme">GitHub</a>
</li>
<li class="govuk-header__navigation-item">
<a class="govuk-header__link" href="https://mojdt.slack.com/archives/C02HQ4M2YQN">Slack</a>
</li>
</ul>
</nav>
</div>
</div>
</header>

</div>

<div id="toc-heading" class="toc-show fixedsticky">
<button type="button" class="toc-show__label js-toc-show" aria-controls="toc">
Table of contents <span class="toc-show__icon"></span>
</button>
</div>

<div class="app-pane__body" data-module="in-page-navigation">
<div class="app-pane__toc">
<div class="toc" data-module="table-of-contents" tabindex="-1" aria-label="Table of contents" role="dialog">
<div class="search" data-module="search" data-path-to-site-root="./">
<form action="https://www.google.co.uk/search" method="get" role="search" class="search__form govuk-!-margin-bottom-4">
<input type="hidden" name="as_sitesearch" value="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius"/>
<label class="govuk-label search__label" for="search" aria-hidden="true">
Search (via Google)
</label>
<input
type="text"
id="search" name="q"
class="govuk-input govuk-!-margin-bottom-0 search__input"
aria-controls="search-results"
placeholder="Search">
<button type="submit" class="search__button">Search</button>
</form>
</div>

<button type="button" class="toc__close js-toc-close" aria-controls="toc" aria-label="Hide table of contents"></button>
<nav id="toc" class="js-toc-list toc__list" aria-labelledby="toc-heading" data-module="collapsible-navigation">
<ul>
<li>
<a href="./index.html"><span>appointment-reminders-and-delius</span></a>
</li>
<li>
<a href="./api-reference.html"><span>API Reference v1.0</span></a>
<ul>
<li>
<a href="./api-reference.html#example-inputid"><span>/example/{inputId}</span></a>
</li>
<li>
<a href="./api-reference.html#schemas"><span>Schemas</span></a>
</li>
</ul>
</li>
</ul>


</nav>
</div>
</div>

<div class="app-pane__content toc-open-disabled" aria-label="Content" tabindex="0">
<main id="content" class="technical-documentation" data-module="anchored-headings">
<header id="api" class="anchored-heading govuk-heading-xl" style="padding-top: 30px">
<a href="#api" class="anchored-heading__icon" aria-hidden="true" tabindex="-1"></a>
API Reference
</header>

<style>.technical-documentation > h1 { display: none !important }</style>
<p>The following documentation is also available in these formats:</p>

<ul>
<li><a href="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius/api-docs.json">OpenAPI JSON</a></li>
<li><a href="https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/appointment-reminders-and-delius/api-docs.yaml">OpenAPI YAML</a></li>
<li><a href="https://appointment-reminders-and-delius-dev.hmpps.service.justice.gov.uk/swagger-ui/index.html">Swagger UI</a></li>
</ul>
<h1 id="api-reference">API Reference v1.0</h1>






<h2 id="example-inputid">/example/{inputId}</h2>

<h3 id="example-inputid-get">get</h3>




<h4 id="example-inputid-get-parameters">Parameters</h4>
<table>
<thead>
<tr><th>Parameter</th><th>In</th><th>Type</th><th>Required</th><th>Description</th></tr>
</thead>
<tbody>

<tr>
<td>inputId</td>
<td>path</td>
<td>string</td>
<td>true</td>
<td>

</td>
</tr>

</tbody>
</table>




<h4 id="example-inputid-get-responses">Responses</h4>
<table>
<thead>
<tr><th>Status</th><th>Description</th><th>Schema</th></tr>
</thead>
<tbody>

<tr>
<td>200</td>
<td>
<p>OK</p>



</td>
<td>

</td>
</tr>

</tbody>
</table>





<h2 id="schemas">Schemas</h2>



</main>

<aside>
<ul class="contribution-banner">
<li><a href="https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/projects/appointment-reminders-and-delius/tech-docs/source/api-reference.html.md.erb">View source</a></li>
<li><a href="https://github.com/ministryofjustice/hmpps-probation-integration-services/issues/new?body=Problem+with+%27API+Reference%27+%28https%3A%2F%2Fministryofjustice.github.io%2Fhmpps-probation-integration-services%2Ftech-docs%2Fprojects%2Fappointment-reminders-and-delius%2Fapi-reference.html%29&amp;labels=bug&amp;title=Re%3A+%27API+Reference%27">Report problem</a></li>
<li><a href="https://github.com/ministryofjustice/hmpps-probation-integration-services">GitHub Repo</a></li>
</ul>
</aside>

<footer class="govuk-footer app-footer" role="contentinfo">
<div class="govuk-footer__meta">
<div class="govuk-footer__meta-item govuk-footer__meta-item--grow">


<svg
aria-hidden="true"
focusable="false"
class="govuk-footer__licence-logo"
xmlns="http://www.w3.org/2000/svg"
viewbox="0 0 483.2 195.7"
height="17"
width="41"
>
<path
fill="currentColor"
d="M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21.1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97.8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47.1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145 97.8 145"
/>
</svg>
<span class="govuk-footer__licence-description">
All content is available under the
<a
class="govuk-footer__link"
href="https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/"
rel="license"
>Open Government Licence v3.0</a>, except where otherwise stated
</span>
</div>
<div class="govuk-footer__meta-item">
<a
class="govuk-footer__link govuk-footer__copyright-logo"
href="https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/"
>© Crown copyright</a>
</div>
</div>
</footer>

</div>
</div>
</div>


<script src="javascripts/application.js"></script>
</body>
</html>
1 change: 1 addition & 0 deletions tech-docs/projects/appointment-reminders-and-delius/api/pages.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +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"}]
Binary file added ...ojects/appointment-reminders-and-delius/assets/govuk/assets/fonts/bold-affa96571d-v2.woff
View file
Binary file not shown.
Binary file added ...jects/appointment-reminders-and-delius/assets/govuk/assets/fonts/bold-b542beb274-v2.woff2
View file
Binary file not shown.
Binary file added ...ects/appointment-reminders-and-delius/assets/govuk/assets/fonts/light-94a07e06a1-v2.woff2
View file
Binary file not shown.
Binary file added ...jects/appointment-reminders-and-delius/assets/govuk/assets/fonts/light-f591b13f7d-v2.woff
View file
Binary file not shown.
Binary file added tech-docs/projects/appointment-reminders-and-delius/assets/govuk/assets/images/favicon.ico
View file
Binary file not shown.
Binary file added ...inders-and-delius/assets/govuk/assets/images/govuk-apple-touch-icon-152x152.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...inders-and-delius/assets/govuk/assets/images/govuk-apple-touch-icon-167x167.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...inders-and-delius/assets/govuk/assets/images/govuk-apple-touch-icon-180x180.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...ment-reminders-and-delius/assets/govuk/assets/images/govuk-apple-touch-icon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .../appointment-reminders-and-delius/assets/govuk/assets/images/govuk-crest-2x.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...cts/appointment-reminders-and-delius/assets/govuk/assets/images/govuk-crest.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...ntment-reminders-and-delius/assets/govuk/assets/images/govuk-logotype-crown.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions ...appointment-reminders-and-delius/assets/govuk/assets/images/govuk-mask-icon.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...tment-reminders-and-delius/assets/govuk/assets/images/govuk-opengraph-image.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tech-docs/projects/appointment-reminders-and-delius/favicon.ico
View file
Binary file not shown.
Binary file added ...s/projects/appointment-reminders-and-delius/images/anchored-heading-icon-2x.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...docs/projects/appointment-reminders-and-delius/images/anchored-heading-icon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tech-docs/projects/appointment-reminders-and-delius/images/govuk-icn-close.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tech-docs/projects/appointment-reminders-and-delius/images/[email protected]
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...cs/projects/appointment-reminders-and-delius/images/govuk-icn-numbered-list.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added ...projects/appointment-reminders-and-delius/images/[email protected]
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tech-docs/projects/appointment-reminders-and-delius/images/search-button.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions tech-docs/projects/appointment-reminders-and-delius/images/search-result-caret.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit a62bff1

Please sign in to comment.