Skip to content
This repository was archived by the owner on Jul 28, 2025. It is now read-only.

Commit 5129981

Browse files
docs: Updated readme
1 parent 7994374 commit 5129981

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Service Layer
1414
- [Configuration](#configuration)
1515
- [Usage](#usage)
1616
- [Testing](#testing)
17+
- [OpenAPI Specifications](#openapi-specifications)
18+
- [API Request Collection](#api-request-collection)
1719
- [Contacts](#contacts)
1820
- [Licence](#licence)
1921

@@ -64,6 +66,18 @@ The full test suite can be ran with `make test`.
6466
6567
Unit tests can be ran with `make test-unit`
6668
69+
## OpenAPI Specifications
70+
71+
The following OpenAPI Specification exist for Service Layer:
72+
73+
- Service Layer API - [Raw](https://raw.githubusercontent.com/NHSDigital/dtos-service-layer/refs/heads/main/api/openapi/openapi.yaml) / [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/NHSDigital/dtos-service-layer/refs/heads/main/api/openapi/openapi.yaml)
74+
75+
## API Request Collection
76+
77+
An API request collection for Service Layer exists in HAR format. It can be imported into Postman or Insomnia.
78+
79+
- [Collection folder](api/api-request-collection)
80+
6781
## Contacts
6882
6983
If you are on the NHS England Slack you can contact the team on #mays-team, otherwise you can open a GitHub issue.

api/openapi/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
openapi: 3.0.3
22
info:
3-
title: ServiceLayer API
3+
title: Service Layer API
44
version: 1.0.0
55
description: API used to ingest episodes from screening services into NSP
66

0 commit comments

Comments
 (0)