Skip to content

Commit 579bd65

Browse files
nhsd-david-wassnhsd-david-wass
committed
Phase1 OAS file
1 parent a38593a commit 579bd65

File tree

84 files changed

+1063
-484
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1063
-484
lines changed

‎package.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
},
4747
"scripts": {
4848
"build": "npm run generate --buildver=$npm_config_buildver",
49-
"bundle-oas": "mkdir -p build && redocly bundle specification/api/notify-supplier-next.yml --dereferenced --remove-unused-components --ext yml > build/notify-supplier.yml",
49+
"bundle-oas": "mkdir -p build && redocly bundle specification/api/notify-supplier-phase1.yml --dereferenced --remove-unused-components --ext yml > build/notify-supplier.yml",
5050
"generate": "npm run generate:cs --buildver=$npm_config_buildver && npm run generate:html && npm run generate:ts --buildver=$npm_config_buildver && npm run generate:python",
5151
"generate-dependencies": "npm run generate-dependencies --workspaces --if-present",
5252
"generate:cs": "./sdk/generate-cs.sh $npm_config_buildver",
@@ -57,7 +57,7 @@
5757
"lint": "npm run lint --workspaces",
5858
"lint-oas": "redocly lint specification/api/notify-supplier.yml",
5959
"lint:fix": "npm run lint:fix --workspaces",
60-
"publish-oas": "mkdir -p build && redocly bundle specification/api/notify-supplier-next.yml --dereferenced --remove-unused-components --ext json > build/notify-supplier.json",
60+
"publish-oas": "mkdir -p build && redocly bundle specification/api/notify-supplier-phase1.yml --dereferenced --remove-unused-components --ext json > build/notify-supplier.json",
6161
"serve": "npm run serve-html-docs",
6262
"serve-html-docs": "npx serve sdk/html -p 3050",
6363
"serve-oas": "redocly preview-docs -p 5000 build/notify-supplier.json",

‎specification/api/components/endpoints/createMI.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
summary: Create a new MI record
2+
operationId: create-mi
3+
tags:
4+
- mi
5+
requestBody:
6+
$ref: '../requests/PostMIRequest.yml'
7+
responses:
8+
'201':
9+
$ref: "../responses/postMI201.yml"
10+
'404':
11+
$ref: "../responses/errors/ResourceNotFound.yml"
12+
'429':
13+
$ref: "../responses/errors/TooManyRequests.yml"
14+
'500':
15+
$ref: "../responses/errors/ServerError.yml"

‎specification/api/components/endpoints/createWhitemail.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
summary: Create a record capturing metadata for a scanned 'whitemail' correspondence
2+
operationId: create-whitemail
3+
tags:
4+
- whitemail
5+
requestBody:
6+
$ref: '../requests/PostWhitemailRequest.yml'
7+
responses:
8+
'201':
9+
$ref: "../responses/postWhitemail201.yml"
10+
'404':
11+
$ref: "../responses/errors/ResourceNotFound.yml"
12+
'429':
13+
$ref: "../responses/errors/TooManyRequests.yml"
14+
'500':
15+
$ref: "../responses/errors/ServerError.yml"

‎specification/api/components/endpoints/getDataId.yml‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
summary: Fetch a data file
2+
operationId: get-data-id
3+
tags:
4+
- data
5+
x-stoplight:
6+
id: 98lwlebl1vxeq
7+
responses:
8+
"303":
9+
description: See Other
10+
headers:
11+
Location:
12+
description: The signed S3 URL of the data file to download
13+
schema:
14+
type: string
15+
example: "https://examples3bucket.com/filelocation"
16+
"404":
17+
$ref: "../responses/errors/ResourceNotFound.yml"
18+
"429":
19+
$ref: "../responses/errors/TooManyRequests.yml"
20+
"500":
21+
$ref: "../responses/errors/ServerError.yml"

‎specification/api/components/endpoints/getLetterStatus.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
summary: Retrieve the status of a letter
2+
description: Get details the status of a letter.
3+
operationId: get-letter-status
4+
responses:
5+
"200":
6+
$ref: "../responses/getLetter200.yml"
7+
"404":
8+
$ref: "../responses/errors/ResourceNotFound.yml"
9+
"429":
10+
$ref: "../responses/errors/TooManyRequests.yml"
11+
"500":
12+
$ref: "../responses/errors/ServerError.yml"
13+
tags:
14+
- letter

‎specification/api/components/endpoints/getMI.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
summary: Fetch a specific MI record
2+
operationId: get-mi
3+
responses:
4+
"200":
5+
$ref: "../responses/getMI200.yml"
6+
"404":
7+
$ref: "../responses/errors/ResourceNotFound.yml"
8+
"429":
9+
$ref: "../responses/errors/TooManyRequests.yml"
10+
"500":
11+
$ref: "../responses/errors/ServerError.yml"
12+
tags:
13+
- mi

‎specification/api/components/endpoints/getWhitemail.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
summary: Fetch metadata about a specific whitemail letter
2+
operationId: get-whitemail
3+
tags:
4+
- whitemail
5+
description: Get details the status of a whitemail letter.
6+
responses:
7+
"200":
8+
$ref: "../responses/getWhitemail200.yml"
9+
"404":
10+
$ref: "../responses/errors/ResourceNotFound.yml"
11+
"429":
12+
$ref: "../responses/errors/TooManyRequests.yml"
13+
"500":
14+
$ref: "../responses/errors/ServerError.yml"

‎specification/api/components/endpoints/headDataId.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
summary: Check for the existance of a data file
2+
tags:
3+
- data
4+
responses:
5+
200:
6+
description: OK
7+
operationId: head-data-id

‎specification/api/components/endpoints/listLetters.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
summary: Get a list of letters
2+
operationId: list-letters
3+
tags:
4+
- letter
5+
parameters:
6+
- $ref: "../parameters/letterStatus.yml"
7+
description: The key use of this endpoint is to query letters which are ready to be printed
8+
responses:
9+
'200':
10+
$ref: "../responses/getLetters200.yml"
11+
'404':
12+
$ref: "../responses/errors/ResourceNotFound.yml"
13+
'429':
14+
$ref: "../responses/errors/TooManyRequests.yml"
15+
'500':
16+
$ref: "../responses/errors/ServerError.yml"

‎specification/api/components/endpoints/listMI.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
summary: List MI Records
2+
operationId: list-mi
3+
responses:
4+
"200":
5+
$ref: "../responses/getMIList200.yml"
6+
"404":
7+
$ref: "../responses/errors/ResourceNotFound.yml"
8+
"429":
9+
$ref: "../responses/errors/TooManyRequests.yml"
10+
"500":
11+
$ref: "../responses/errors/ServerError.yml"
12+
tags:
13+
- mi

0 commit comments

Comments
 (0)