cdk-serverless 2.14.6 → 2.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (111) hide show
  1. package/docs/constructs/assets/hierarchy.js +1 -0
  2. package/docs/constructs/assets/icons.js +18 -0
  3. package/docs/constructs/assets/icons.svg +1 -0
  4. package/docs/constructs/assets/main.js +5 -3
  5. package/docs/constructs/assets/navigation.js +1 -0
  6. package/docs/constructs/assets/search.js +1 -1
  7. package/docs/constructs/assets/style.css +1424 -1193
  8. package/docs/constructs/classes/AssetCdn.html +21 -187
  9. package/docs/constructs/classes/BaseApi.html +15 -177
  10. package/docs/constructs/classes/CognitoAuthentication.html +26 -223
  11. package/docs/constructs/classes/GraphQlApi.html +37 -516
  12. package/docs/constructs/classes/LambdaFunction.html +213 -1159
  13. package/docs/constructs/classes/RestApi.html +43 -397
  14. package/docs/constructs/classes/SingleTableDatastore.html +20 -174
  15. package/docs/constructs/classes/Workflow.html +24 -195
  16. package/docs/constructs/hierarchy.html +1 -0
  17. package/docs/constructs/index.html +34 -110
  18. package/docs/constructs/interfaces/AssetCdnProps.html +6 -99
  19. package/docs/constructs/interfaces/BaseApiProps.html +45 -202
  20. package/docs/constructs/interfaces/CognitoAuthenticationProps.html +40 -188
  21. package/docs/constructs/interfaces/GraphQlApiProps.html +46 -218
  22. package/docs/constructs/interfaces/ICognitoAuthentication.html +3 -91
  23. package/docs/constructs/interfaces/IJwtAuthentication.html +7 -103
  24. package/docs/constructs/interfaces/JsResolverOptions.html +11 -106
  25. package/docs/constructs/interfaces/LambdaFunctionProps.html +35 -202
  26. package/docs/constructs/interfaces/LambdaTracingOptions.html +6 -90
  27. package/docs/constructs/interfaces/RestApiProps.html +62 -261
  28. package/docs/constructs/interfaces/SingleTableDatastoreProps.html +12 -111
  29. package/docs/constructs/interfaces/SingleTableDesign.html +12 -121
  30. package/docs/constructs/interfaces/VtlResolverOptions.html +8 -103
  31. package/docs/constructs/interfaces/WorkflowProps.html +6 -109
  32. package/docs/constructs/modules.html +1 -93
  33. package/docs/constructs/types/LambdaOptions.html +1 -62
  34. package/docs/lambda/assets/hierarchy.js +1 -0
  35. package/docs/lambda/assets/icons.js +18 -0
  36. package/docs/lambda/assets/icons.svg +1 -0
  37. package/docs/lambda/assets/main.js +5 -3
  38. package/docs/lambda/assets/navigation.js +1 -0
  39. package/docs/lambda/assets/search.js +1 -1
  40. package/docs/lambda/assets/style.css +1424 -1193
  41. package/docs/lambda/classes/auth.ApiGatewayv1CognitoAuthorizer.html +38 -309
  42. package/docs/lambda/classes/auth.ApiGatewayv1JwtAuthorizer.html +37 -308
  43. package/docs/lambda/classes/auth.ApiGatewayv2CognitoAuthorizer.html +38 -309
  44. package/docs/lambda/classes/auth.ApiGatewayv2JwtAuthorizer.html +37 -306
  45. package/docs/lambda/classes/auth.AppSyncCognitoAuthorizer.html +36 -299
  46. package/docs/lambda/classes/auth.CognitoAuthorizer.html +34 -288
  47. package/docs/lambda/classes/auth.JwtAuthorizer.html +34 -282
  48. package/docs/lambda/classes/errors.BadRequestError.html +16 -181
  49. package/docs/lambda/classes/errors.ForbiddenError.html +16 -181
  50. package/docs/lambda/classes/errors.HttpError.html +17 -189
  51. package/docs/lambda/classes/errors.NotFoundError.html +16 -181
  52. package/docs/lambda/classes/errors.UnauthenticatedError.html +16 -181
  53. package/docs/lambda/functions/api.createAppSyncHandler.html +3 -80
  54. package/docs/lambda/functions/api.createHttpHandler.html +2 -78
  55. package/docs/lambda/functions/api.createOpenApiHandler.html +2 -78
  56. package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html +2 -78
  57. package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html +2 -76
  58. package/docs/lambda/hierarchy.html +1 -0
  59. package/docs/lambda/index.html +34 -90
  60. package/docs/lambda/interfaces/api.AppSyncHandlerContext.html +6 -105
  61. package/docs/lambda/interfaces/api.HttpHandlerContext.html +7 -105
  62. package/docs/lambda/interfaces/api.HttpResponseContext.html +5 -100
  63. package/docs/lambda/interfaces/api.Operation.html +3 -92
  64. package/docs/lambda/interfaces/api.OperationWithRequestBody.html +4 -106
  65. package/docs/lambda/modules/api.html +1 -82
  66. package/docs/lambda/modules/auth.html +1 -64
  67. package/docs/lambda/modules/errors.html +1 -60
  68. package/docs/lambda/modules.html +1 -47
  69. package/docs/lambda/types/api.APIGatewayv1Handler.html +2 -62
  70. package/docs/lambda/types/api.AppSyncHandler.html +2 -82
  71. package/docs/lambda/types/api.HttpHandler.html +2 -84
  72. package/docs/projen/assets/hierarchy.js +1 -0
  73. package/docs/projen/assets/icons.js +18 -0
  74. package/docs/projen/assets/icons.svg +1 -0
  75. package/docs/projen/assets/main.js +5 -3
  76. package/docs/projen/assets/navigation.js +1 -0
  77. package/docs/projen/assets/search.js +1 -1
  78. package/docs/projen/assets/style.css +1424 -1193
  79. package/docs/projen/classes/Datastore.html +26 -246
  80. package/docs/projen/classes/GraphQlApi.html +25 -212
  81. package/docs/projen/classes/RestApi.html +49 -347
  82. package/docs/projen/classes/ServerlessProject.html +245 -1409
  83. package/docs/projen/classes/Workflow.html +39 -273
  84. package/docs/projen/index.html +34 -98
  85. package/docs/projen/interfaces/DatastoreOptions.html +3 -77
  86. package/docs/projen/interfaces/GraphQlApiOptions.html +3 -77
  87. package/docs/projen/interfaces/RestApiOptions.html +3 -77
  88. package/docs/projen/interfaces/ServerlessProjectOptions.html +822 -2053
  89. package/docs/projen/interfaces/WorkflowOptions.html +3 -77
  90. package/docs/projen/modules.html +1 -69
  91. package/docs/projen/variables/PACKAGE_NAME.html +1 -50
  92. package/lib/constructs/authentication.d.ts +13 -0
  93. package/lib/constructs/authentication.js +47 -13
  94. package/lib/constructs/base-api.js +1 -1
  95. package/lib/constructs/func.js +1 -1
  96. package/lib/constructs/graphql.js +21 -11
  97. package/lib/constructs/rest-api.js +18 -8
  98. package/lib/constructs/table.js +1 -1
  99. package/lib/constructs/workflow.js +18 -8
  100. package/lib/lambda/auth.js +1 -1
  101. package/lib/lambda/handler.d.ts +1 -1
  102. package/lib/lambda/handler.js +21 -11
  103. package/lib/lambda/index.js +18 -8
  104. package/lib/projen/core.js +18 -8
  105. package/lib/projen/datastore.js +18 -8
  106. package/lib/projen/graphql.js +21 -11
  107. package/lib/projen/lazy-sampledir.js +1 -1
  108. package/lib/projen/rest-api.js +18 -8
  109. package/lib/projen/workflow.js +18 -8
  110. package/lib/tests/integ-test-util.js +3 -3
  111. package/package.json +26 -25
package/docs/lambda/functions/api.createHttpHandler.html CHANGED
@@ -1,78 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createHttpHandler | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">cdk-serverless</a></li>
16
- <li><a href="../modules/api.html">api</a></li>
17
- <li><a href="api.createHttpHandler.html">createHttpHandler</a></li></ul>
18
- <h1>Function createHttpHandler</h1></div>
19
- <section class="tsd-panel">
20
- <ul class="tsd-signatures">
21
- <li class="tsd-signature tsd-anchor-link" id="createHttpHandler"><span class="tsd-kind-call-signature">create<wbr/>Http<wbr/>Handler</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createHttpHandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></li>
22
- <li class="tsd-description">
23
- <div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler.</p>
24
- </div>
25
- <section class="tsd-panel">
26
- <h4>Type Parameters</h4>
27
- <ul class="tsd-type-parameter-list">
28
- <li>
29
- <h4><span class="tsd-kind-type-parameter">T</span></h4></li>
30
- <li>
31
- <h4><span class="tsd-kind-type-parameter">R</span></h4></li></ul></section>
32
- <div class="tsd-parameters">
33
- <h4 class="tsd-parameters-title">Parameters</h4>
34
- <ul class="tsd-parameter-list">
35
- <li>
36
- <h5><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">R</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
37
- <h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4>
38
- <div class="tsd-comment tsd-typography"></div></li></ul></section></div>
39
- <div class="col-sidebar">
40
- <div class="page-menu">
41
- <div class="tsd-navigation settings">
42
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
43
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
44
- <div class="tsd-accordion-details">
45
- <div class="tsd-filter-visibility">
46
- <h4 class="uppercase">Member Visibility</h4><form>
47
- <ul id="tsd-filter-options">
48
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
49
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
50
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
51
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
52
- <div class="tsd-theme-toggle">
53
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
54
- <div class="site-menu">
55
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
56
- <ul class="tsd-small-nested-navigation">
57
- <li>
58
- <details class="tsd-index-accordion" open data-key="api"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/api.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>api</span></a></summary>
59
- <div class="tsd-accordion-details">
60
- <ul class="tsd-nested-navigation">
61
- <li><a href="../interfaces/api.AppSyncHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Sync<wbr/>Handler<wbr/>Context</span></a></li>
62
- <li><a href="../interfaces/api.HttpHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Handler<wbr/>Context</span></a></li>
63
- <li><a href="../interfaces/api.HttpResponseContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Response<wbr/>Context</span></a></li>
64
- <li><a href="../interfaces/api.Operation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation</span></a></li>
65
- <li><a href="../interfaces/api.OperationWithRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
66
- <li><a href="../types/api.APIGatewayv1Handler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>APIGatewayv1<wbr/>Handler</span></a></li>
67
- <li><a href="../types/api.AppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>App<wbr/>Sync<wbr/>Handler</span></a></li>
68
- <li><a href="../types/api.HttpHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Http<wbr/>Handler</span></a></li>
69
- <li><a href="api.createAppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>App<wbr/>Sync<wbr/>Handler</span></a></li>
70
- <li><a href="api.createHttpHandler.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Http<wbr/>Handler</span></a></li>
71
- <li><a href="api.createOpenApiHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler</span></a></li>
72
- <li><a href="api.createOpenApiHandlerWithRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
73
- <li><a href="api.createOpenApiHandlerWithRequestBodyNoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body<wbr/>No<wbr/>Response</span></a></li></ul></div></details></li>
74
- <li><a href="../modules/auth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>auth</span></a></li>
75
- <li><a href="../modules/errors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>errors</span></a></li></ul></nav></div></div></div>
76
- <div class="tsd-generator">
77
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
78
- <div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createHttpHandler | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="../modules/api.html">api</a></li><li><a href="api.createHttpHandler.html">createHttpHandler</a></li></ul><h1>Function createHttpHandler</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createhttphandler" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createHttpHandler</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createHttpHandler.html#createhttphandlert">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createHttpHandler.html#createhttphandlerr">R</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createHttpHandler.html#createhttphandlert">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createHttpHandler.html#createhttphandlerr">R</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createhttphandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createhttphandlert" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li><li><span><a id="createhttphandlerr" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">R</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createHttpHandler.html#createhttphandlert">T</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createHttpHandler.html#createhttphandlerr">R</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/lambda/functions/api.createOpenApiHandler.html CHANGED
@@ -1,78 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createOpenApiHandler | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">cdk-serverless</a></li>
16
- <li><a href="../modules/api.html">api</a></li>
17
- <li><a href="api.createOpenApiHandler.html">createOpenApiHandler</a></li></ul>
18
- <h1>Function createOpenApiHandler</h1></div>
19
- <section class="tsd-panel">
20
- <ul class="tsd-signatures">
21
- <li class="tsd-signature tsd-anchor-link" id="createOpenApiHandler"><span class="tsd-kind-call-signature">create<wbr/>Open<wbr/>Api<wbr/>Handler</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">SC</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createOpenApiHandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></li>
22
- <li class="tsd-description">
23
- <div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler for an OpenAPI operation.</p>
24
- </div>
25
- <section class="tsd-panel">
26
- <h4>Type Parameters</h4>
27
- <ul class="tsd-type-parameter-list">
28
- <li>
29
- <h4><span class="tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/api.Operation.html" class="tsd-signature-type tsd-kind-interface">Operation</a></h4></li>
30
- <li>
31
- <h4><span class="tsd-kind-type-parameter">SC</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">number</span> = <span class="tsd-signature-type">200</span></h4></li></ul></section>
32
- <div class="tsd-parameters">
33
- <h4 class="tsd-parameters-title">Parameters</h4>
34
- <ul class="tsd-parameter-list">
35
- <li>
36
- <h5><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;responses&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">SC</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
37
- <h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4>
38
- <div class="tsd-comment tsd-typography"></div></li></ul></section></div>
39
- <div class="col-sidebar">
40
- <div class="page-menu">
41
- <div class="tsd-navigation settings">
42
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
43
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
44
- <div class="tsd-accordion-details">
45
- <div class="tsd-filter-visibility">
46
- <h4 class="uppercase">Member Visibility</h4><form>
47
- <ul id="tsd-filter-options">
48
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
49
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
50
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
51
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
52
- <div class="tsd-theme-toggle">
53
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
54
- <div class="site-menu">
55
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
56
- <ul class="tsd-small-nested-navigation">
57
- <li>
58
- <details class="tsd-index-accordion" open data-key="api"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/api.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>api</span></a></summary>
59
- <div class="tsd-accordion-details">
60
- <ul class="tsd-nested-navigation">
61
- <li><a href="../interfaces/api.AppSyncHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Sync<wbr/>Handler<wbr/>Context</span></a></li>
62
- <li><a href="../interfaces/api.HttpHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Handler<wbr/>Context</span></a></li>
63
- <li><a href="../interfaces/api.HttpResponseContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Response<wbr/>Context</span></a></li>
64
- <li><a href="../interfaces/api.Operation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation</span></a></li>
65
- <li><a href="../interfaces/api.OperationWithRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
66
- <li><a href="../types/api.APIGatewayv1Handler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>APIGatewayv1<wbr/>Handler</span></a></li>
67
- <li><a href="../types/api.AppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>App<wbr/>Sync<wbr/>Handler</span></a></li>
68
- <li><a href="../types/api.HttpHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Http<wbr/>Handler</span></a></li>
69
- <li><a href="api.createAppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>App<wbr/>Sync<wbr/>Handler</span></a></li>
70
- <li><a href="api.createHttpHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Http<wbr/>Handler</span></a></li>
71
- <li><a href="api.createOpenApiHandler.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler</span></a></li>
72
- <li><a href="api.createOpenApiHandlerWithRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
73
- <li><a href="api.createOpenApiHandlerWithRequestBodyNoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body<wbr/>No<wbr/>Response</span></a></li></ul></div></details></li>
74
- <li><a href="../modules/auth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>auth</span></a></li>
75
- <li><a href="../modules/errors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>errors</span></a></li></ul></nav></div></div></div>
76
- <div class="tsd-generator">
77
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
78
- <div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createOpenApiHandler | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="../modules/api.html">api</a></li><li><a href="api.createOpenApiHandler.html">createOpenApiHandler</a></li></ul><h1>Function createOpenApiHandler</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler for an OpenAPI operation.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createopenapihandler" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createOpenApiHandler</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandler.html#createopenapihandlerop">OP</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/api.Operation.html" class="tsd-signature-type tsd-kind-interface">Operation</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandler.html#createopenapihandlersc">SC</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">200</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><br/>        <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/>        <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandler.html#createopenapihandlerop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;responses&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandler.html#createopenapihandlersc">SC</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createopenapihandler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createopenapihandlerop" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">OP</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/api.Operation.html" class="tsd-signature-type tsd-kind-interface">Operation</a></span></li><li><span><a id="createopenapihandlersc" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">SC</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">number</span> = <span class="tsd-signature-type">200</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandler.html#createopenapihandlerop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;responses&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandler.html#createopenapihandlersc">SC</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBody.html CHANGED
@@ -1,78 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createOpenApiHandlerWithRequestBody | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">cdk-serverless</a></li>
16
- <li><a href="../modules/api.html">api</a></li>
17
- <li><a href="api.createOpenApiHandlerWithRequestBody.html">createOpenApiHandlerWithRequestBody</a></li></ul>
18
- <h1>Function createOpenApiHandlerWithRequestBody</h1></div>
19
- <section class="tsd-panel">
20
- <ul class="tsd-signatures">
21
- <li class="tsd-signature tsd-anchor-link" id="createOpenApiHandlerWithRequestBody"><span class="tsd-kind-call-signature">create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">SC</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createOpenApiHandlerWithRequestBody" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></li>
22
- <li class="tsd-description">
23
- <div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler for an OpenAPI operation with a request body.</p>
24
- </div>
25
- <section class="tsd-panel">
26
- <h4>Type Parameters</h4>
27
- <ul class="tsd-type-parameter-list">
28
- <li>
29
- <h4><span class="tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/api.OperationWithRequestBody.html" class="tsd-signature-type tsd-kind-interface">OperationWithRequestBody</a></h4></li>
30
- <li>
31
- <h4><span class="tsd-kind-type-parameter">SC</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">number</span> = <span class="tsd-signature-type">200</span></h4></li></ul></section>
32
- <div class="tsd-parameters">
33
- <h4 class="tsd-parameters-title">Parameters</h4>
34
- <ul class="tsd-parameter-list">
35
- <li>
36
- <h5><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;requestBody&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;responses&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type tsd-kind-type-parameter">SC</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
37
- <h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4>
38
- <div class="tsd-comment tsd-typography"></div></li></ul></section></div>
39
- <div class="col-sidebar">
40
- <div class="page-menu">
41
- <div class="tsd-navigation settings">
42
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
43
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
44
- <div class="tsd-accordion-details">
45
- <div class="tsd-filter-visibility">
46
- <h4 class="uppercase">Member Visibility</h4><form>
47
- <ul id="tsd-filter-options">
48
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
49
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
50
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
51
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
52
- <div class="tsd-theme-toggle">
53
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
54
- <div class="site-menu">
55
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
56
- <ul class="tsd-small-nested-navigation">
57
- <li>
58
- <details class="tsd-index-accordion" open data-key="api"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/api.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>api</span></a></summary>
59
- <div class="tsd-accordion-details">
60
- <ul class="tsd-nested-navigation">
61
- <li><a href="../interfaces/api.AppSyncHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Sync<wbr/>Handler<wbr/>Context</span></a></li>
62
- <li><a href="../interfaces/api.HttpHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Handler<wbr/>Context</span></a></li>
63
- <li><a href="../interfaces/api.HttpResponseContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Response<wbr/>Context</span></a></li>
64
- <li><a href="../interfaces/api.Operation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation</span></a></li>
65
- <li><a href="../interfaces/api.OperationWithRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
66
- <li><a href="../types/api.APIGatewayv1Handler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>APIGatewayv1<wbr/>Handler</span></a></li>
67
- <li><a href="../types/api.AppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>App<wbr/>Sync<wbr/>Handler</span></a></li>
68
- <li><a href="../types/api.HttpHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Http<wbr/>Handler</span></a></li>
69
- <li><a href="api.createAppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>App<wbr/>Sync<wbr/>Handler</span></a></li>
70
- <li><a href="api.createHttpHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Http<wbr/>Handler</span></a></li>
71
- <li><a href="api.createOpenApiHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler</span></a></li>
72
- <li><a href="api.createOpenApiHandlerWithRequestBody.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
73
- <li><a href="api.createOpenApiHandlerWithRequestBodyNoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body<wbr/>No<wbr/>Response</span></a></li></ul></div></details></li>
74
- <li><a href="../modules/auth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>auth</span></a></li>
75
- <li><a href="../modules/errors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>errors</span></a></li></ul></nav></div></div></div>
76
- <div class="tsd-generator">
77
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
78
- <div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createOpenApiHandlerWithRequestBody | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="../modules/api.html">api</a></li><li><a href="api.createOpenApiHandlerWithRequestBody.html">createOpenApiHandlerWithRequestBody</a></li></ul><h1>Function createOpenApiHandlerWithRequestBody</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler for an OpenAPI operation with a request body.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createopenapihandlerwithrequestbody" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createOpenApiHandlerWithRequestBody</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodyop">OP</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/api.OperationWithRequestBody.html" class="tsd-signature-type tsd-kind-interface">OperationWithRequestBody</a><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodysc">SC</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">200</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><br/>        <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodyop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;requestBody&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>        <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodyop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;responses&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodysc">SC</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createopenapihandlerwithrequestbody" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createopenapihandlerwithrequestbodyop" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">OP</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/api.OperationWithRequestBody.html" class="tsd-signature-type tsd-kind-interface">OperationWithRequestBody</a></span></li><li><span><a id="createopenapihandlerwithrequestbodysc" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">SC</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">number</span> = <span class="tsd-signature-type">200</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodyop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;requestBody&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodyop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;responses&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBody.html#createopenapihandlerwithrequestbodysc">SC</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/lambda/functions/api.createOpenApiHandlerWithRequestBodyNoResponse.html CHANGED
@@ -1,76 +1,2 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createOpenApiHandlerWithRequestBodyNoResponse | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
- <div class="tsd-toolbar-contents container">
3
- <div class="table-cell" id="tsd-search" data-base="..">
4
- <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
- <div class="field">
6
- <div id="tsd-toolbar-links"></div></div>
7
- <ul class="results">
8
- <li class="state loading">Preparing search index...</li>
9
- <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div>
10
- <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
- <div class="container container-main">
12
- <div class="col-content">
13
- <div class="tsd-page-title">
14
- <ul class="tsd-breadcrumb">
15
- <li><a href="../modules.html">cdk-serverless</a></li>
16
- <li><a href="../modules/api.html">api</a></li>
17
- <li><a href="api.createOpenApiHandlerWithRequestBodyNoResponse.html">createOpenApiHandlerWithRequestBodyNoResponse</a></li></ul>
18
- <h1>Function createOpenApiHandlerWithRequestBodyNoResponse</h1></div>
19
- <section class="tsd-panel">
20
- <ul class="tsd-signatures">
21
- <li class="tsd-signature tsd-anchor-link" id="createOpenApiHandlerWithRequestBodyNoResponse"><span class="tsd-kind-call-signature">create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body<wbr/>No<wbr/>Response</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createOpenApiHandlerWithRequestBodyNoResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></li>
22
- <li class="tsd-description">
23
- <div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler for an OpenAPI operation with a request body and no response.</p>
24
- </div>
25
- <section class="tsd-panel">
26
- <h4>Type Parameters</h4>
27
- <ul class="tsd-type-parameter-list">
28
- <li>
29
- <h4><span class="tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol"> extends </span><a href="../interfaces/api.OperationWithRequestBody.html" class="tsd-signature-type tsd-kind-interface">OperationWithRequestBody</a></h4></li></ul></section>
30
- <div class="tsd-parameters">
31
- <h4 class="tsd-parameters-title">Parameters</h4>
32
- <ul class="tsd-parameter-list">
33
- <li>
34
- <h5><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">OP</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;requestBody&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
35
- <h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4>
36
- <div class="tsd-comment tsd-typography"></div></li></ul></section></div>
37
- <div class="col-sidebar">
38
- <div class="page-menu">
39
- <div class="tsd-navigation settings">
40
- <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
41
- <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
42
- <div class="tsd-accordion-details">
43
- <div class="tsd-filter-visibility">
44
- <h4 class="uppercase">Member Visibility</h4><form>
45
- <ul id="tsd-filter-options">
46
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
47
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
48
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
49
- <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
50
- <div class="tsd-theme-toggle">
51
- <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div>
52
- <div class="site-menu">
53
- <nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>cdk-<wbr/>serverless</span></a>
54
- <ul class="tsd-small-nested-navigation">
55
- <li>
56
- <details class="tsd-index-accordion" open data-key="api"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><a href="../modules/api.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>api</span></a></summary>
57
- <div class="tsd-accordion-details">
58
- <ul class="tsd-nested-navigation">
59
- <li><a href="../interfaces/api.AppSyncHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>App<wbr/>Sync<wbr/>Handler<wbr/>Context</span></a></li>
60
- <li><a href="../interfaces/api.HttpHandlerContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Handler<wbr/>Context</span></a></li>
61
- <li><a href="../interfaces/api.HttpResponseContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Http<wbr/>Response<wbr/>Context</span></a></li>
62
- <li><a href="../interfaces/api.Operation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation</span></a></li>
63
- <li><a href="../interfaces/api.OperationWithRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Operation<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
64
- <li><a href="../types/api.APIGatewayv1Handler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>APIGatewayv1<wbr/>Handler</span></a></li>
65
- <li><a href="../types/api.AppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>App<wbr/>Sync<wbr/>Handler</span></a></li>
66
- <li><a href="../types/api.HttpHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Http<wbr/>Handler</span></a></li>
67
- <li><a href="api.createAppSyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>create<wbr/>App<wbr/>Sync<wbr/>Handler</span></a></li>
68
- <li><a href="api.createHttpHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Http<wbr/>Handler</span></a></li>
69
- <li><a href="api.createOpenApiHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler</span></a></li>
70
- <li><a href="api.createOpenApiHandlerWithRequestBody.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body</span></a></li>
71
- <li><a href="api.createOpenApiHandlerWithRequestBodyNoResponse.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>create<wbr/>Open<wbr/>Api<wbr/>Handler<wbr/>With<wbr/>Request<wbr/>Body<wbr/>No<wbr/>Response</span></a></li></ul></div></details></li>
72
- <li><a href="../modules/auth.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>auth</span></a></li>
73
- <li><a href="../modules/errors.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg><span>errors</span></a></li></ul></nav></div></div></div>
74
- <div class="tsd-generator">
75
- <p>Generated using <a href="https://typedoc.org/" rel="noopener" target="_blank">TypeDoc</a></p></div>
76
- <div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createOpenApiHandlerWithRequestBodyNoResponse | cdk-serverless</title><meta name="description" content="Documentation for cdk-serverless"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">cdk-serverless</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">cdk-serverless</a></li><li><a href="../modules/api.html">api</a></li><li><a href="api.createOpenApiHandlerWithRequestBodyNoResponse.html">createOpenApiHandlerWithRequestBodyNoResponse</a></li></ul><h1>Function createOpenApiHandlerWithRequestBodyNoResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A factory function that creates an HTTP request handler for an OpenAPI operation with a request body and no response.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createopenapihandlerwithrequestbodynoresponse" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createOpenApiHandlerWithRequestBodyNoResponse</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBodyNoResponse.html#createopenapihandlerwithrequestbodynoresponseop">OP</a> <span class="tsd-signature-keyword">extends</span> <a href="../interfaces/api.OperationWithRequestBody.html" class="tsd-signature-type tsd-kind-interface">OperationWithRequestBody</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">handler</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><br/>        <a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBodyNoResponse.html#createopenapihandlerwithrequestbodynoresponseop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;requestBody&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a><a href="#createopenapihandlerwithrequestbodynoresponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createopenapihandlerwithrequestbodynoresponseop" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">OP</span><span class="tsd-signature-keyword"> extends </span><a href="../interfaces/api.OperationWithRequestBody.html" class="tsd-signature-type tsd-kind-interface">OperationWithRequestBody</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">handler</span>: <a href="../types/api.HttpHandler.html" class="tsd-signature-type tsd-kind-type-alias">HttpHandler</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="api.createOpenApiHandlerWithRequestBodyNoResponse.html#createopenapihandlerwithrequestbodynoresponseop">OP</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;requestBody&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;content&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">&quot;application/json&quot;</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/api.APIGatewayv1Handler.html" class="tsd-signature-type tsd-kind-type-alias">APIGatewayv1Handler</a></h4></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">cdk-serverless</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>