nhs-notify-supplier-api/specification/api/notify-supplier-phase1.yml at 1164e6f1b7e49a2c662f2bfbe3ae48cdd217df9b · NHSDigital/nhs-notify-supplier-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
openapi: 3.0.3
info:
  version: next
  title: NHS Notify Supplier API
  description: |
    API for communication suppliers to integrate with NHS Notify.

    This specification represents the in-development 'next' version of the API schema
    and should be treated as unstable.
security:
  - $ref: 'components/security/security.yml'
paths:
  /letters:
    parameters:
      - $ref: 'components/parameters/requestId.yml'
      - $ref: 'components/parameters/correlationId.yml'
    post:
      $ref: 'components/endpoints/postLetters.yml'
    get:
      $ref: 'components/endpoints/listLetters.yml'
  '/letters/{id}':
    parameters:
      - $ref: 'components/parameters/requestId.yml'
      - $ref: 'components/parameters/correlationId.yml'
      - $ref: 'components/parameters/resourceId.yml'
    get:
      $ref: 'components/endpoints/getLetterStatus.yml'
    patch:
      $ref: 'components/endpoints/patchLetter.yml'
  /mi:
    parameters:
      - $ref: 'components/parameters/requestId.yml'
      - $ref: 'components/parameters/correlationId.yml'
    get:
      $ref: 'components/endpoints/listMI.yml'
    post:
      $ref: 'components/endpoints/createMI.yml'

  '/mi/{id}':
    parameters:
      - $ref: 'components/parameters/requestId.yml'
      - $ref: 'components/parameters/correlationId.yml'
      - $ref: 'components/parameters/resourceId.yml'
    get:
      $ref: 'components/endpoints/getMI.yml'

  '/data/{id}':
    parameters:
      - $ref: 'components/parameters/resourceId.yml'
      - $ref: 'components/parameters/requestId.yml'
      - $ref: 'components/parameters/correlationId.yml'
    get:
      $ref: 'components/endpoints/getDataId.yml'
    head:
      $ref: 'components/endpoints/headDataId.yml'
components:
  securitySchemes:
    app-level3:
      $ref: https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/app-level3
    app-level0:
      $ref: https://proxygen.ptl.api.platform.nhs.uk/components/securitySchemes/app-level0

tags:
  - name: letter
    description: ''
  - name: mi
    description: ''
  - name: data
    description: ''
servers:
  - url: 'http://127.0.0.1:3000'
    description: Local development server
  - url: 'https://sandbox-server.nhs.uk/nhs-notify-supplier-api'
    description: Public sandbox
x-nhsd-apim:
  temporary: true
  monitoring: false
  access:
    $ref: ./components/x-nhsd-apim/access.yml
  target:
    $ref: ./components/x-nhsd-apim/target.yml
  target-attributes:
    $ref: ./components/x-nhsd-apim/target-attributes.yml