Skip to content

Commit a130d8b

Browse files
seshubawsdryrun
andauthored
docs: sam-docs descriptions for AWS::Serverless::WebFunction and NetworkConnector (#4015)
Co-authored-by: dryrun <dry@run>
1 parent 65853e2 commit a130d8b

5 files changed

Lines changed: 158 additions & 76 deletions

File tree

‎samtranslator/internal/schema_source/aws_serverless_networkconnector.py‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,13 @@ class Properties(BaseModel):
2828
Name: SamIntrinsicable[str] | None = properties("Name")
2929
VpcConfig: VpcConfig = properties("VpcConfig")
3030
# The single compute type a connector serves. Constrained here (exactly one item; enum values) so
31-
# `sam validate --lint` surfaces the same rules as the transform. Plain field (no doc stem) to avoid
32-
# churning sam-docs.json; intrinsics still validate via SamIntrinsicable.
31+
# `sam validate --lint` surfaces the same rules as the transform; intrinsics still validate via SamIntrinsicable.
3332
ComputeTypes: list[SamIntrinsicable[Literal["MicroVm", "WebFunction"]]] | None = pydantic.Field(
34-
default=None, min_items=1, max_items=1
33+
default=None,
34+
min_items=1,
35+
max_items=1,
36+
title="ComputeTypes",
37+
markdownDescription=properties("ComputeTypes").extra["markdownDescription"],
3538
)
3639
OperatorRole: SamIntrinsicable[str] | None = properties("OperatorRole")
3740
Tags: DictStrAny | None = properties("Tags")

‎samtranslator/internal/schema_source/aws_serverless_webfunction.py‎

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,38 @@
66
BaseModel,
77
ResourceAttributes,
88
SamIntrinsicable,
9+
get_prop,
910
)
1011

12+
PROPERTIES_STEM = "sam-resource-webfunction"
13+
14+
properties = get_prop(PROPERTIES_STEM)
15+
1116

1217
class Properties(BaseModel):
13-
Runtime: SamIntrinsicable[str]
14-
CodeUri: Any | None = None
15-
FunctionName: SamIntrinsicable[str] | None = None
16-
Timeout: SamIntrinsicable[int] | None = None
17-
EnvironmentVariables: dict[str, Any] | None = None
18-
ExecutionRoleArn: Any | None = None
19-
EndpointName: SamIntrinsicable[str] | None = None
20-
EndpointType: SamIntrinsicable[str] | None = None
21-
EndpointDescription: SamIntrinsicable[str] | None = None
22-
AuthType: SamIntrinsicable[str]
23-
AutoDeploymentMode: SamIntrinsicable[str] | None = None
24-
RevisionWeights: dict[str, Any] | None = None
25-
ReplicaRegions: Any | None = None
26-
RevisionDescription: SamIntrinsicable[str] | None = None
27-
KmsKeyArn: SamIntrinsicable[str] | None = None
28-
LoggingConfig: dict[str, Any] | None = None
29-
ScalingConfig: dict[str, Any] | None = None
30-
ThrottleConfig: dict[str, Any] | None = None
31-
MaxConcurrencyPerEnvironment: SamIntrinsicable[int] | None = None
32-
EgressNetworkConnectorArn: SamIntrinsicable[str] | None = None
33-
EntryPoint: SamIntrinsicable[str] | None = None
34-
InlineCode: str | None = None
35-
Tags: dict[str, Any] | None = None
18+
Runtime: SamIntrinsicable[str] = properties("Runtime")
19+
CodeUri: Any | None = properties("CodeUri")
20+
FunctionName: SamIntrinsicable[str] | None = properties("FunctionName")
21+
Timeout: SamIntrinsicable[int] | None = properties("Timeout")
22+
EnvironmentVariables: dict[str, Any] | None = properties("EnvironmentVariables")
23+
ExecutionRoleArn: Any | None = properties("ExecutionRoleArn")
24+
EndpointName: SamIntrinsicable[str] | None = properties("EndpointName")
25+
EndpointType: SamIntrinsicable[str] | None = properties("EndpointType")
26+
EndpointDescription: SamIntrinsicable[str] | None = properties("EndpointDescription")
27+
AuthType: SamIntrinsicable[str] = properties("AuthType")
28+
AutoDeploymentMode: SamIntrinsicable[str] | None = properties("AutoDeploymentMode")
29+
RevisionWeights: dict[str, Any] | None = properties("RevisionWeights")
30+
ReplicaRegions: Any | None = properties("ReplicaRegions")
31+
RevisionDescription: SamIntrinsicable[str] | None = properties("RevisionDescription")
32+
KmsKeyArn: SamIntrinsicable[str] | None = properties("KmsKeyArn")
33+
LoggingConfig: dict[str, Any] | None = properties("LoggingConfig")
34+
ScalingConfig: dict[str, Any] | None = properties("ScalingConfig")
35+
ThrottleConfig: dict[str, Any] | None = properties("ThrottleConfig")
36+
MaxConcurrencyPerEnvironment: SamIntrinsicable[int] | None = properties("MaxConcurrencyPerEnvironment")
37+
EgressNetworkConnectorArn: SamIntrinsicable[str] | None = properties("EgressNetworkConnectorArn")
38+
EntryPoint: SamIntrinsicable[str] | None = properties("EntryPoint")
39+
InlineCode: str | None = properties("InlineCode")
40+
Tags: dict[str, Any] | None = properties("Tags")
3641

3742

3843
class Resource(ResourceAttributes):

0 commit comments

Comments
 (0)