Skip to content

Commit df988b4

Browse files
committed
update guides
1 parent 0c18993 commit df988b4

File tree

11 files changed

+306
-592
lines changed

11 files changed

+306
-592
lines changed

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.2.0-${yyyy}${mm}${dd}.${HH}${MM}${SS}+${hash}
1+
1.0.0-${yyyy}${mm}${dd}.${HH}${MM}${SS}+${hash}

docs/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ mermaid:
7575
version: "10.9.1"
7676

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

8181
aux_links_new_tab: false

docs/assets/diagrams/phase1-design.drawio

Lines changed: 0 additions & 181 deletions
This file was deleted.

docs/assets/diagrams/target-architecture.drawio

Lines changed: 292 additions & 387 deletions
Large diffs are not rendered by default.

docs/collections/_consumers/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you have installed the local repository requirements or are utilising the dev
3030

3131
## Documentation
3232

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
33+
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
3434

3535
## SDK Assets
3636

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

5555
There are two ways to access the sandbox:
5656

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

6060
You can build the sandbox locally by installing the repository requirements (or using the devcontainer) and running:

docs/collections/_consumers/integration.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ How you build your integration to meet your needs is your responsibility.
143143

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

146-
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).
146+
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).
147147

148148
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.
149149

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

204204
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.
205205

206-
Digital proof will need to be sent via e-mail using this address: <[email protected]> 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.
206+
Digital proof will need to be sent via e-mail using this address: <[email protected]> and physical proof will need to be sent to:
207+
208+
Mr Wayne Shirt (NHS Notify), 6th Floor, 7 & 8 Wellington Place, Leeds, West Yorkshire, LS1 4AP.
207209

208210
---
209211

docs/collections/_developers/architecture-design/phase1-design.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/pages/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,15 +84,15 @@ Released versions of the specification can be found within [latest releases](htt
8484

8585
## API Consumers
8686

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

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

9292
## API Developers
9393

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

9797
### Contributing
9898

internal/datastore/src/types.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,6 @@ erDiagram
5353
string name
5454
string apimId
5555
string status "enum: ENABLED, DISABLED"
56+
string updatedAt
5657
}
5758
```

scripts/config/vale/styles/config/vocabularies/words/accept.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
actioned
2-
API
2+
API|api
33
[A-Z]+s
44
Bitwarden
55
bot

0 commit comments

Comments
 (0)