Skip to content

Commit 8814f6a

Browse files
hoffahoffa
authored
chore: update schema docs (#3052)
1 parent 517e692 commit 8814f6a

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

‎samtranslator/internal/schema_source/aws_serverless_api.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ class Properties(BaseModel):
190190
Cors: Optional[CorsType] = properties("Cors")
191191
DefinitionBody: Optional[DictStrAny] = properties("DefinitionBody")
192192
DefinitionUri: Optional[DefinitionUriType] = properties("DefinitionUri")
193-
MergeDefinitions: Optional[MergeDefinitions] # TODO: update docs when live
193+
MergeDefinitions: Optional[MergeDefinitions] = properties("MergeDefinitions")
194194
Description: Optional[PassThroughProp] = properties("Description")
195195
DisableExecuteApiEndpoint: Optional[PassThroughProp] = properties("DisableExecuteApiEndpoint")
196196
Domain: Optional[Domain] = properties("Domain")
@@ -207,7 +207,7 @@ class Properties(BaseModel):
207207
Tags: Optional[DictStrAny] = properties("Tags")
208208
TracingEnabled: Optional[TracingEnabled] = properties("TracingEnabled")
209209
Variables: Optional[Variables] = properties("Variables")
210-
AlwaysDeploy: Optional[AlwaysDeploy] # TODO: Add docs
210+
AlwaysDeploy: Optional[AlwaysDeploy] = properties("AlwaysDeploy")
211211

212212

213213
class Globals(BaseModel):
@@ -216,7 +216,7 @@ class Globals(BaseModel):
216216
DefinitionUri: Optional[PassThroughProp] = properties("DefinitionUri")
217217
CacheClusterEnabled: Optional[CacheClusterEnabled] = properties("CacheClusterEnabled")
218218
CacheClusterSize: Optional[CacheClusterSize] = properties("CacheClusterSize")
219-
MergeDefinitions: Optional[MergeDefinitions] # TODO: update docs when live
219+
MergeDefinitions: Optional[MergeDefinitions] = properties("MergeDefinitions")
220220
Variables: Optional[Variables] = properties("Variables")
221221
EndpointConfiguration: Optional[PassThroughProp] = properties("EndpointConfiguration")
222222
MethodSettings: Optional[MethodSettings] = properties("MethodSettings")
@@ -229,7 +229,7 @@ class Globals(BaseModel):
229229
TracingEnabled: Optional[TracingEnabled] = properties("TracingEnabled")
230230
OpenApiVersion: Optional[OpenApiVersion] = properties("OpenApiVersion")
231231
Domain: Optional[Domain] = properties("Domain")
232-
AlwaysDeploy: Optional[AlwaysDeploy] # TODO: Add docs
232+
AlwaysDeploy: Optional[AlwaysDeploy] = properties("AlwaysDeploy")
233233

234234

235235
class Resource(ResourceAttributes):

‎samtranslator/schema/schema.json

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199272,7 +199272,9 @@
199272199272
"title": "AccessLogSetting"
199273199273
},
199274199274
"AlwaysDeploy": {
199275-
"title": "Alwaysdeploy",
199275+
"description": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199276+
"markdownDescription": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199277+
"title": "AlwaysDeploy",
199276199278
"type": "boolean"
199277199279
},
199278199280
"Auth": {
@@ -199378,7 +199380,9 @@
199378199380
"type": "object"
199379199381
},
199380199382
"MergeDefinitions": {
199381-
"title": "Mergedefinitions",
199383+
"description": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199384+
"markdownDescription": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199385+
"title": "MergeDefinitions",
199382199386
"type": "boolean"
199383199387
},
199384199388
"MethodSettings": {
@@ -199462,7 +199466,9 @@
199462199466
"title": "AccessLogSetting"
199463199467
},
199464199468
"AlwaysDeploy": {
199465-
"title": "Alwaysdeploy",
199469+
"description": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199470+
"markdownDescription": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199471+
"title": "AlwaysDeploy",
199466199472
"type": "boolean"
199467199473
},
199468199474
"ApiKeySourceType": {
@@ -199620,7 +199626,9 @@
199620199626
"type": "object"
199621199627
},
199622199628
"MergeDefinitions": {
199623-
"title": "Mergedefinitions",
199629+
"description": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199630+
"markdownDescription": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
199631+
"title": "MergeDefinitions",
199624199632
"type": "boolean"
199625199633
},
199626199634
"MethodSettings": {

‎schema_source/sam.schema.json

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3360,7 +3360,9 @@
33603360
"title": "AccessLogSetting"
33613361
},
33623362
"AlwaysDeploy": {
3363-
"title": "Alwaysdeploy",
3363+
"description": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3364+
"markdownDescription": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3365+
"title": "AlwaysDeploy",
33643366
"type": "boolean"
33653367
},
33663368
"Auth": {
@@ -3466,7 +3468,9 @@
34663468
"type": "object"
34673469
},
34683470
"MergeDefinitions": {
3469-
"title": "Mergedefinitions",
3471+
"description": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3472+
"markdownDescription": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3473+
"title": "MergeDefinitions",
34703474
"type": "boolean"
34713475
},
34723476
"MethodSettings": {
@@ -3550,7 +3554,9 @@
35503554
"title": "AccessLogSetting"
35513555
},
35523556
"AlwaysDeploy": {
3553-
"title": "Alwaysdeploy",
3557+
"description": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3558+
"markdownDescription": "Always deploys the API, even when no changes to the API have been detected\\. \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3559+
"title": "AlwaysDeploy",
35543560
"type": "boolean"
35553561
},
35563562
"ApiKeySourceType": {
@@ -3708,7 +3714,9 @@
37083714
"type": "object"
37093715
},
37103716
"MergeDefinitions": {
3711-
"title": "Mergedefinitions",
3717+
"description": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3718+
"markdownDescription": "AWS SAM generates an OpenAPI specification from your API event source\\. Specify `true` to have AWS SAM merge this into the inline OpenAPI specification defined in your `AWS::Serverless::Api` resource\\. Specify `false` to not merge\\. \n`MergeDefinitions` requires the `DefinitionBody` property for `AWS::Serverless::Api` to be defined\\. `MergeDefinitions` is not compatible with the `DefinitionUri` property for `AWS::Serverless::Api`\\. \n*Default value*: `false` \n*Type*: Boolean \n*Required*: No \n*AWS CloudFormation compatibility*: This property is unique to AWS SAM and doesn't have an AWS CloudFormation equivalent\\.",
3719+
"title": "MergeDefinitions",
37123720
"type": "boolean"
37133721
},
37143722
"MethodSettings": {

0 commit comments

Comments
 (0)