Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.2.0-${yyyy}${mm}${dd}.${HH}${MM}${SS}+${hash}
1.0.0-${yyyy}${mm}${dd}.${HH}${MM}${SS}+${hash}
2 changes: 1 addition & 1 deletion docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ mermaid:
version: "10.9.1"

aux_links:
"NHS Notify Supplier API Template on GitHub":
"NHS Notify Supplier API on GitHub":
- "//github.com/NHSDigital/nhs-notify-supplier-api"

aux_links_new_tab: false
Expand Down
181 changes: 0 additions & 181 deletions docs/assets/diagrams/phase1-design.drawio

This file was deleted.

679 changes: 292 additions & 387 deletions docs/assets/diagrams/target-architecture.drawio

Large diffs are not rendered by default.

116 changes: 86 additions & 30 deletions docs/collections/_consumers/acceptance.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/collections/_consumers/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ If you have installed the local repository requirements or are utilising the dev

## Documentation

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
This documentation is maintained within the [/docs](https://github.com/NHSDigital/nhs-notify-supplier-api/tree/main/docs) folder of the repository and published to [GitHub pages](https://nhsdigital.github.io/nhs-notify-supplier-api/) on PR merge

## SDK Assets

Expand All @@ -54,7 +54,7 @@ It will provide limited, fixed responses and does not require authentication to

There are two ways to access the sandbox:

- The public sandbox [https://sandbox.api.service.nhs.uk/notify-supplier](https://sandbox.api.service.nhs.uk/notify-supplier)
- The public sandbox [https://sandbox.api.service.nhs.uk/notify-supplier](https://sandbox.api.service.nhs.uk/nhs-notify-supplier)
- Local Build

You can build the sandbox locally by installing the repository requirements (or using the devcontainer) and running:
Expand Down
15 changes: 7 additions & 8 deletions docs/collections/_consumers/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ You have 90 calendar days to complete onboarding activities and submit all requi

---

## Pre-onboarding & Conformance
## Pre-onboarding and Conformance

Before you can begin technical onboarding, your organisation must:

Expand All @@ -59,10 +59,8 @@ This triggers an event to make the letter available for you to retrieve.
### List of letters and downloads

Retrieve a list of all available letters, including key details such as the letter ID and current status.
The list only contains the summary information - not the actual PDF files.
To access each full letter, download the PDF directly by making a request to the `/letters/{id}/data` endpoint.
This will redirect to a short-lived URL to download the file.
These links are temporary and expire after about one minute, so downloads should be completed right away or re-requested if the link has expired.
The list only contains the summary information — not the actual PDF files.
To access each full letter, download the PDF directly by making a request to the /the GET letters/{id}/data endpoint. This will redirect to a short-lived URL to download the file. These links are temporary and expire after about one minute, so downloads should be completed right away or re-requested if the link has expired.

### API access

Expand Down Expand Up @@ -121,7 +119,6 @@ Refer to the Letter Status Lifecycle diagram below for the complete sequence of
## Prepare your integration

You must prepare your integration before you can get access to the NHS Notify integration environment.
You’ll need technical or developer support to complete tasks in this step.

### To set up your APIM application

Expand All @@ -146,7 +143,7 @@ How you build your integration to meet your needs is your responsibility.

The API is defined using the [OpenAPI Specification (OAS)](https://spec.openapis.org/oas/latest.html) format.

You can find it on [GitHub](https://github.com/NHSDigital/nhs-notify-supplier-api/tree/main/specification/api) and on the [NHS England Developer Catalogue](https://digital.nhs.uk/developer/api-catalogue/Alphabet/N).
You can find it on [GitHub](https://github.com/NHSDigital/nhs-notify-supplier-api/tree/main/specification/api) and on the [NHS API Catalogue](https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier).

A Postman collection will also be available in [GitHub](https://github.com/NHSDigital/nhs-notify-supplier-api/tree/main/postman) to explore the requests within the API.

Expand Down Expand Up @@ -206,7 +203,9 @@ You’ll need to submit both digital proofs (for content and layout verification

Only once your proofs have been reviewed and approved will you receive confirmation that your system and outputs are ready to move forward into the live (production) environment.

Digital proof will need to be sent via e-mail using this address: <england.nhsnotifysuppliers@nhs.net> and physical proof will need to be sent to: Mr Wayne Shirt (NHS Notify), 6th Floor, 7 & 8 Wellington Place, Leeds, West Yorkshire, LS1 4AP.
Digital proof will need to be sent via e-mail using this address: <england.nhsnotifysuppliers@nhs.net> and physical proof will need to be sent to:

Mr Wayne Shirt (NHS Notify), 6th Floor, 7 & 8 Wellington Place, Leeds, West Yorkshire, LS1 4AP.

---

Expand Down

This file was deleted.

6 changes: 3 additions & 3 deletions docs/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,15 @@ Released versions of the specification can be found within [latest releases](htt

## API Consumers

If you wish to integrate with the Supplier API refer to the [API Consumer](/consumers) pages and
If you wish to integrate with the Supplier API refer to the *API Consumer* pages and
[Getting Started as an API Consumer](/consumers/getting-started)

You may also find it helpful to refer to the [Specification](/specification)

## API Developers

For NHS Developers working on the Supplier API refer to the [API Developer](/developers) pages and
[Getting Started as an API Developer](/developers/getting-started.md)
For NHS Developers working on the Supplier API refer to the *API Developer* pages and
[Getting Started as an API Developer](/developers/getting-started)

### Contributing

Expand Down
1 change: 1 addition & 0 deletions internal/datastore/src/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,6 @@ erDiagram
string name
string apimId
string status "enum: ENABLED, DISABLED"
string updatedAt
}
```
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
actioned
API|api
[A-Z]+s
Bitwarden
Expand Down
2 changes: 1 addition & 1 deletion sdk/_config.version.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version: 0.1
version: 0.2.0-20251120.121539+0c18993
Loading