nhs-notify-supplier-api/infrastructure/terraform/components/api/resources/spec.tmpl.json at 51675ac237d7e2770a2b4ad38eb74a139dacf383 · 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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
{
  "components": {
    "securitySchemes": {
      "LambdaAuthorizer": {
        "in": "header",
        "name": "NHSD-Supplier-ID",
        "type": "apiKey",
        "x-amazon-apigateway-authorizer": {
          "authorizerCredentials": "${APIG_EXECUTION_ROLE_ARN}",
          "authorizerResultTtlInSeconds": 0,
          "authorizerUri": "arn:aws:apigateway:${AWS_REGION}:lambda:path/2015-03-31/functions/${AUTHORIZER_LAMBDA_ARN}/invocations",
          "identitySource": "method.request.header.NHSD-Supplier-ID",
          "type": "request"
        },
        "x-amazon-apigateway-authtype": "custom"
      }
    }
  },
  "info": {
    "description": "NHS Notify Supplier API",
    "title": "NHS Notify - Suppliers - Supplier API",
    "version": "v1"
  },
  "openapi": "3.0.1",
  "paths": {
    "/letters": {
      "get": {
        "description": "Returns 200 OK with paginated letter ids.",
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "LambdaAuthorizer": []
          }
        ],
        "summary": "Get letters",
        "x-amazon-apigateway-integration": {
          "contentHandling": "CONVERT_TO_TEXT",
          "credentials": "${APIG_EXECUTION_ROLE_ARN}",
          "httpMethod": "POST",
          "passthroughBehavior": "WHEN_NO_TEMPLATES",
          "responses": {
            ".*": {
              "statusCode": "200"
            }
          },
          "timeoutInMillis": 29000,
          "type": "AWS_PROXY",
          "uri": "arn:aws:apigateway:${AWS_REGION}:lambda:path/2015-03-31/functions/${GET_LETTERS_LAMBDA_ARN}/invocations"
        }
      }
    },
    "/letters/{id}": {
      "parameters": [
        {
          "description": "Unique identifier of this resource",
          "in": "path",
          "name": "id",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "patch": {
        "description": "Update the status of a letter by providing the new status in the request body.",
        "operationId": "patchLetters",
        "requestBody": {
          "required": true
        },
        "responses": {
          "200": {
            "description": "List of letters to process"
          },
          "400": {
            "description": "Bad request, invalid input data"
          },
          "404": {
            "description": "Resource not found"
          },
          "500": {
            "description": "Server error"
          }
        },
        "security": [
          {
            "LambdaAuthorizer": []
          }
        ],
        "x-amazon-apigateway-integration": {
          "contentHandling": "CONVERT_TO_TEXT",
          "credentials": "${APIG_EXECUTION_ROLE_ARN}",
          "httpMethod": "POST",
          "passthroughBehavior": "WHEN_NO_TEMPLATES",
          "responses": {
            ".*": {
              "statusCode": "200"
            }
          },
          "timeoutInMillis": 29000,
          "type": "AWS_PROXY",
          "uri": "arn:aws:apigateway:${AWS_REGION}:lambda:path/2015-03-31/functions/${PATCH_LETTERS_LAMBDA_ARN}/invocations"
        }
      }
    }
  }
}