Skip to content

Commit ee0e483

Browse files
WIP add swagger ui to tech docs
1 parent 9fbd050 commit ee0e483

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

.tool-versions

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ terraform-docs 0.19.0
99
trivy 0.61.0
1010
vale 3.6.0
1111
poetry 2.1.4
12+
java openjdk-25.0.1
1213

1314
# ==============================================================================
1415
# The section below is reserved for Docker image versions.

docs/Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
BASE_URL ?= "/"
22
VERSION ?= ""
33
SHELL = /bin/bash
4+
SDK_DIR := ../sdk
45

56
default: install
67

@@ -19,10 +20,12 @@ define baseurlparam =
1920
$(if $(BASE_URL),-- --baseurl $(BASE_URL),-- --baseurl "")
2021
endef
2122

22-
build: version .generate-includes
23+
build: version .generate-includes $(SDK_DIR)/build
24+
rsync -a --delete $(SDK_DIR)/swagger/ ./assets/swagger
2325
npm run build $(baseurlparam)
2426

25-
debug: version .generate-includes
27+
debug: version .generate-includes $(SDK_DIR)/build
28+
rsync -a --delete $(SDK_DIR)/swagger/ ./assets/swagger
2629
npm run debug
2730

2831
version:
@@ -41,3 +44,6 @@ version:
4144

4245
.generate-includes:
4346
npm run generate-includes
47+
48+
$(SDK_DIR)/build:
49+
$(MAKE) -C $(SDK_DIR) build

docs/generate-includes.sh

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,5 @@ mkdir -p ./docs/_includes/components/generated
1010
npm run -w internal/datastore diagrams
1111
cp ./internal/datastore/src/types.md ./docs/_includes/components/generated/types.md
1212

13-
# Specifications
14-
npm run bundle-oas
15-
npm run generate:html
16-
cp ./sdk/html/index.html ./docs/_includes/components/generated/nhs-notify-supplier-api.html
17-
1813
#Contributing file
1914
cp ./CONTRIBUTING.md ./docs/_includes/components/generated/contributing.md

docs/pages/specification.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,10 @@
1414
permalink: /specification
1515
---
1616

17-
{% include components/generated/nhs-notify-supplier-api.html %}
17+
<div style="height:80vh">
18+
<iframe
19+
src="{{ '/assets/swagger/index.html' | relative_url }}"
20+
style="width:100%;height:100%;border:0"
21+
loading="lazy"
22+
></iframe>
23+
</div>

0 commit comments

Comments
 (0)