Skip to content

Commit a5f5723

Browse files
masl2masl2
committed
CCM-11207: more pages & placeholders
1 parent 3f395e0 commit a5f5723

File tree

21 files changed

+1027
-27
lines changed

21 files changed

+1027
-27
lines changed

‎docs/.gitignore‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,4 @@ node_modules
99
_config.version.yml
1010

1111
# Generated or copied from other repo resources
12-
_includes/components/nhs-notify-supplier-api.html
13-
_includes/components/contributing.md
14-
assets/diagrams/types.md
12+
_includes/components/generated/*

‎docs/_config.yml‎

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,6 @@ url: "https://nhsdigital.github.io" # the base hostname & protocol for your site
2828
collections_dir: collections
2929

3030
collections:
31-
architecture:
32-
output: true
33-
sort_by: order
3431
repos:
3532
output: true
3633
sort_by: order
@@ -58,14 +55,10 @@ just_the_docs:
5855
# Exclude the collection from the search
5956
# Supports true or false (defaul
6057
search_exclude: false
61-
architecture:
62-
name: Architecture & Design
63-
guides:
64-
name: Guides & How Tos
6558

6659
defaults:
6760
- scope:
68-
path: ""
61+
path: "repositories"
6962
type: "repos"
7063
values:
7164
layout: "notify-repo"
@@ -74,16 +67,16 @@ defaults:
7467
author: NHS Notify
7568
last_modified_date: 2025-10-08
7669
- scope:
77-
path: ""
78-
type: "onboarding"
70+
path: "api-consumers"
71+
type: "consumers"
7972
values:
8073
layout: "page"
8174
is_not_draft: false
8275
owner: NHS Notify
8376
author: NHS Notify
8477
last_modified_date: 2025-10-08
8578
- scope:
86-
path: ""
79+
path: "api-developers"
8780
type: "developers"
8881
values:
8982
layout: "page"

‎docs/assets/diagrams/phase1-design.drawio‎

Lines changed: 181 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/assets/diagrams/target-architecture.drawio‎

Lines changed: 578 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/assets/diagrams/types.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Data Store Schemas
2+
3+
This document contains the mermaid diagrams for the data store schemas used in the application.
4+
5+
The schemas are generated from Zod definitions and provide a visual representation of the data structure.
6+
7+
## Letter schema
8+
9+
```mermaid
10+
erDiagram
11+
Letter {
12+
string id
13+
string status "enum: PENDING, ACCEPTED, REJECTED, PRINTED, ENCLOSED, CANCELLED, DISPATCHED, FAILED, RETURNED, DESTROYED, FORWARDED, DELIVERED"
14+
string specificationId
15+
string groupId
16+
number reasonCode
17+
string reasonText
18+
string supplierId
19+
string url "url"
20+
string createdAt
21+
string updatedAt
22+
string supplierStatus
23+
string supplierStatusSk
24+
number ttl "min: -9007199254740991, max: 9007199254740991"
25+
}
26+
```
27+
28+
## MI schema
29+
30+
```mermaid
31+
erDiagram
32+
MI {
33+
string id
34+
string supplierId "ref: Supplier"
35+
string specificationId
36+
string groupId
37+
string lineItem
38+
number quantity
39+
number stockRemaining
40+
string createdAt
41+
string updatedAt
42+
}
43+
Supplier {
44+
}
45+
MI }o--|| Supplier : "supplierId"
46+
```

‎docs/collections/_consumers/acceptance.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Acceptance Pack
3+
order: 0
4+
nav_order: 3
5+
has_children: false
6+
has_toc: false
7+
---
8+
9+
[[Placeholder for Conformance Pack]]

‎docs/collections/_consumers/getting-started.md‎

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,64 @@
11
---
22
title: API Consumers - Getting Started
3-
order: 0
43
nav_order: 1
54
has_children: false
65
has_toc: false
76
---
7+
8+
## Integration Guide
9+
10+
The primary resource for integrating and onboarding with the NHS Notify Supplier API can be found within the [Integration Guide](/consumers/integration)
11+
12+
## Specifications
13+
14+
The OAS defines the scope, behaviour, and interactions with the Supplier API.
15+
16+
Released versions of the specification can be found within [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases):
17+
18+
```text
19+
api-oas-specification-[version].zip
20+
```
21+
22+
### Building the Specification
23+
24+
If you have installed the local repository requirements or are utilising the devcontainer, you can build/serve the documentation locally:
25+
26+
```text
27+
- make bundle-oas
28+
- make serve-oas
29+
```
30+
31+
## Documentation
32+
33+
This documentation is maintained within the [/docs](/docs) folder of the repository and published to [GitHub pages](https://nhsdigital.github.io/nhs-notify-supplier-api/) on PR merge
34+
35+
## SDK Assets
36+
37+
SDKs are generated for Python, TypeScript and C# using [@openapitools](https://github.com/OpenAPITools/openapi-generator-cli)
38+
39+
If packages are not available, then SDKs can be downloaded directly from [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases):
40+
41+
```text
42+
- Python sdk-python-[Version].zip
43+
- TypeScript sdk-ts-[Version].zip
44+
- CSharp sdk-csharp-[Version].zip
45+
```
46+
47+
An [NPM nhsnotifysupplier packages](https://github.com/NHSDigital/nhs-notify-supplier-api/pkgs/npm/nhsnotifysupplier) is published on pre-releases and releases
48+
49+
## Sandbox
50+
51+
A sandbox environment is available to aid in discovery and development of your integration.
52+
53+
It will provide limited, fixed responses and does not require authentication to use.
54+
55+
Their are two ways to access the sandbox:
56+
57+
- The public sandbox [https://sandbox.api.service.nhs.uk/notify-supplier](https://sandbox.api.service.nhs.uk/notify-supplier)
58+
- Local Build
59+
60+
You can build the sandbox locally by installing the repository requirements (or using the devcontainer) and running:
61+
62+
```text
63+
make generate-sandbox
64+
```

‎docs/collections/_consumers/integration.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: Integration Guide
3+
nav_order: 2
4+
has_children: false
5+
has_toc: false
6+
---
7+
8+
[[Placeholder for Integration Guide]]

‎docs/collections/_consumers/onboarding.md‎

Whitespace-only changes.

‎docs/collections/_developers/architecture-design/data-structures.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Data Structures
3+
nav_order: 3
4+
has_children: false
5+
has_toc: false
6+
parent: Architecture & Design
7+
---
8+
9+
The following mermaid diagram is generated from the [internal datastore](/internal/datastore) implementation, and is generated by the generate dependencies hook.
10+
11+
{% include components/generated/types.md %}

0 commit comments

Comments
 (0)