Skip to content

Commit 892454b

Browse files
author
awstools
committed
feat(client-apigatewayv2): Documentation updates for Amazon API Gateway
1 parent 3eecc64 commit 892454b

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

clients/client-apigatewayv2/src/models/models_0.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -679,7 +679,7 @@ export interface Integration {
679679
PassthroughBehavior?: PassthroughBehavior | undefined;
680680

681681
/**
682-
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
682+
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>
683683
* @public
684684
*/
685685
PayloadFormatVersion?: string | undefined;
@@ -1960,7 +1960,7 @@ export interface CreateIntegrationRequest {
19601960
PassthroughBehavior?: PassthroughBehavior | undefined;
19611961

19621962
/**
1963-
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
1963+
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>
19641964
* @public
19651965
*/
19661966
PayloadFormatVersion?: string | undefined;
@@ -2090,7 +2090,7 @@ export interface CreateIntegrationResult {
20902090
PassthroughBehavior?: PassthroughBehavior | undefined;
20912091

20922092
/**
2093-
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
2093+
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>
20942094
* @public
20952095
*/
20962096
PayloadFormatVersion?: string | undefined;
@@ -3753,7 +3753,7 @@ export interface GetIntegrationResult {
37533753
PassthroughBehavior?: PassthroughBehavior | undefined;
37543754

37553755
/**
3756-
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
3756+
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>
37573757
* @public
37583758
*/
37593759
PayloadFormatVersion?: string | undefined;
@@ -5496,7 +5496,7 @@ export interface UpdateIntegrationRequest {
54965496
PassthroughBehavior?: PassthroughBehavior | undefined;
54975497

54985498
/**
5499-
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
5499+
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>
55005500
* @public
55015501
*/
55025502
PayloadFormatVersion?: string | undefined;
@@ -5626,7 +5626,7 @@ export interface UpdateIntegrationResult {
56265626
PassthroughBehavior?: PassthroughBehavior | undefined;
56275627

56285628
/**
5629-
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>
5629+
* <p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>
56305630
* @public
56315631
*/
56325632
PayloadFormatVersion?: string | undefined;

codegen/sdk-codegen/aws-models/apigatewayv2.json

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,7 @@
425425
"name": "apigateway"
426426
},
427427
"aws.protocols#restJson1": {},
428+
"smithy.api#auth": ["aws.auth#sigv4"],
428429
"smithy.api#documentation": "<p>Amazon API Gateway V2</p>",
429430
"smithy.api#title": "AmazonApiGatewayV2",
430431
"smithy.rules#endpointRuleSet": {
@@ -2606,7 +2607,7 @@
26062607
"PayloadFormatVersion": {
26072608
"target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64",
26082609
"traits": {
2609-
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>",
2610+
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>",
26102611
"smithy.api#jsonName": "payloadFormatVersion"
26112612
}
26122613
},
@@ -2898,7 +2899,7 @@
28982899
"PayloadFormatVersion": {
28992900
"target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64",
29002901
"traits": {
2901-
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>",
2902+
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>",
29022903
"smithy.api#jsonName": "payloadFormatVersion"
29032904
}
29042905
},
@@ -6236,7 +6237,7 @@
62366237
"PayloadFormatVersion": {
62376238
"target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64",
62386239
"traits": {
6239-
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>",
6240+
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>",
62406241
"smithy.api#jsonName": "payloadFormatVersion"
62416242
}
62426243
},
@@ -7821,7 +7822,7 @@
78217822
"PayloadFormatVersion": {
78227823
"target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64",
78237824
"traits": {
7824-
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>",
7825+
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>",
78257826
"smithy.api#jsonName": "payloadFormatVersion"
78267827
}
78277828
},
@@ -10012,7 +10013,7 @@
1001210013
"PayloadFormatVersion": {
1001310014
"target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64",
1001410015
"traits": {
10015-
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>",
10016+
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>",
1001610017
"smithy.api#jsonName": "payloadFormatVersion"
1001710018
}
1001810019
},
@@ -10310,7 +10311,7 @@
1031010311
"PayloadFormatVersion": {
1031110312
"target": "com.amazonaws.apigatewayv2#StringWithLengthBetween1And64",
1031210313
"traits": {
10313-
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs.</p>",
10314+
"smithy.api#documentation": "<p>Specifies the format of the payload sent to an integration. Required for HTTP APIs. Supported values for Lambda proxy integrations are 1.0 and 2.0. For all other integrations, 1.0 is the only supported value. To learn more, see <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html\">Working with AWS Lambda proxy integrations for HTTP APIs</a>.</p>",
1031410315
"smithy.api#jsonName": "payloadFormatVersion"
1031510316
}
1031610317
},

0 commit comments

Comments
 (0)