From 07a5bf234830553ffd13a4221e421fbe75cc1a6c Mon Sep 17 00:00:00 2001 From: Anthony Britton Date: Tue, 19 Sep 2023 08:55:07 +0100 Subject: [PATCH] PI-1462 add api docs for tier to delius --- .../tech-docs/config/tech-docs.yml | 3 +++ .../source/api-reference.html.md.erb | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+) create mode 100644 projects/tier-to-delius/tech-docs/source/api-reference.html.md.erb diff --git a/projects/tier-to-delius/tech-docs/config/tech-docs.yml b/projects/tier-to-delius/tech-docs/config/tech-docs.yml index 718eea044f..91839e71b2 100644 --- a/projects/tier-to-delius/tech-docs/config/tech-docs.yml +++ b/projects/tier-to-delius/tech-docs/config/tech-docs.yml @@ -39,3 +39,6 @@ github_branch: main # Slack owner_slack_workspace: mojdt default_owner_slack: '#probation-integration-tech' + +# OpenAPI +api_path: https://tier-to-delius-dev.hmpps.service.justice.gov.uk/v3/api-docs.yaml diff --git a/projects/tier-to-delius/tech-docs/source/api-reference.html.md.erb b/projects/tier-to-delius/tech-docs/source/api-reference.html.md.erb new file mode 100644 index 0000000000..0949fc071a --- /dev/null +++ b/projects/tier-to-delius/tech-docs/source/api-reference.html.md.erb @@ -0,0 +1,19 @@ +--- +title: API Reference +source_url: 'https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/projects/tier-to-delius/tech-docs/source/api-reference.html.md.erb' +weight: 20 +--- + +
+ + API Reference +
+ + +The following documentation is also available in these formats: + +* [OpenAPI JSON](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/tier-to-delius/api-docs.json) +* [OpenAPI YAML](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/tier-to-delius/api-docs.yaml) +* [Swagger UI](https://tier-to-delius-dev.hmpps.service.justice.gov.uk/swagger-ui/index.html) + +api>