Repository navigation
docs: sam-docs descriptions for AWS::Serverless::WebFunction and NetworkConnector - #4015
Merged
seshubaws merged 1 commit intoOct 13, 2026
Merged
Conversation
…Function and NetworkConnector ComputeTypes Adds a sam-resource-webfunction stem (23 properties, including EgressNetworkConnectorArn) to sam-docs.json and switches aws_serverless_webfunction.py to get_prop, so every WebFunction property has a markdownDescription in the generated schema. For AWS::Serverless::NetworkConnector, documents ComputeTypes (keeping its min/max item constraints) and updates VpcConfig: AssociatedComputeResourceTypes now comes from ComputeTypes instead of always being [MicroVm]. Descriptions are parsed from the AWS SAM Developer Guide pages for these resources, with relative links made absolute. Property types and required fields are unchanged.
seshubaws
marked this pull request as ready for review
October 13, 2026 18:39
valerena
approved these changes
Oct 13, 2026
Vandita2020
approved these changes
Oct 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds AWS SAM Developer Guide descriptions to the generated schema (IDE hover, schema-based validation) for:
AWS::Serverless::WebFunction: a newsam-resource-webfunctionstem insam-docs.json(23 properties, includingEgressNetworkConnectorArn).aws_serverless_webfunction.pynow usesget_prop.AWS::Serverless::NetworkConnector:ComputeTypes. The field keeps itsminItems/maxItemsof 1 and enum values.VpcConfig:AssociatedComputeResourceTypesnow comes fromComputeTypesinstead of always being[MicroVm].Source
The descriptions come from the AWS SAM Developer Guide CR for these resources (CR-310619431, revision 6, published to alpha). I parsed the built Markdown pages using the same logic as the removed
bin/parse_docs.py, and made relative links absolute (docs.aws.amazon.com/serverless-application-model/...). They now include the published CloudFormation links for theAWS::Lambda::WebFunction*andNetworkConnectorpages.CodeUrirepeats the bucket requirements inline (versioning, the Lambda read policy, and SSE-KMS only with a customer managed key, notaws/s3) instead of pointing to the page note. These requirements were verified by deploying in a dev account.Scope
required(Runtime,AuthType) are unchanged. The rest of the schema diff is generated titles becoming exact property names (for exampleFunctionname→FunctionName).sam-docs.json: the WebFunction stem is inserted alphabetically (betweenstatemachineandwebsocketapi), and NetworkConnector gets one edited entry and one new entry. The rest of the file is unchanged.litewithlnc, which has the LNC code (feat: support Ref: 'AWS::Region' #855).feat/lite-v2has noEgressNetworkConnectorArnor NetworkConnector schema.Testing
pytest tests/schema tests/translator: 3204 passed.mypy --strictare clean.Issue #, if available
Checklist
Examples?
Please reach out in the comments if you want to add an example. Examples will be
added to
sam initthrough aws/aws-sam-cli-app-templates.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.