Skip to content

docs: sam-docs descriptions for AWS::Serverless::WebFunction and NetworkConnector - #4015

Merged
seshubaws merged 1 commit into
aws:developfrom
seshubaws:seshub/webfunction-sam-docs-public
Oct 13, 2026
Merged

seshubaws merged 1 commit into
aws:developfrom
seshubaws:seshub/webfunction-sam-docs-public

Conversation

@seshubaws

@seshubaws seshubaws commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

What

Adds AWS SAM Developer Guide descriptions to the generated schema (IDE hover, schema-based validation) for:

  • AWS::Serverless::WebFunction: a new sam-resource-webfunction stem in sam-docs.json (23 properties, including EgressNetworkConnectorArn). aws_serverless_webfunction.py now uses get_prop.
  • AWS::Serverless::NetworkConnector:
    • Documents ComputeTypes. The field keeps its minItems/maxItems of 1 and enum values.
    • Updates VpcConfig: AssociatedComputeResourceTypes now comes from ComputeTypes instead 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 the AWS::Lambda::WebFunction* and NetworkConnector pages.

CodeUri repeats the bucket requirements inline (versioning, the Lambda read policy, and SSE-KMS only with a customer managed key, not aws/s3) instead of pointing to the page note. These requirements were verified by deploying in a dev account.

Scope

  • Docs only. Property types and required (Runtime, AuthType) are unchanged. The rest of the schema diff is generated titles becoming exact property names (for example Functionname → FunctionName).
  • sam-docs.json: the WebFunction stem is inserted alphabetically (between statemachine and websocketapi), and NetworkConnector gets one edited entry and one new entry. The rest of the file is unchanged.
  • Retargeted to litewithlnc, which has the LNC code (feat: support Ref: 'AWS::Region' #855). feat/lite-v2 has no EgressNetworkConnectorArn or NetworkConnector schema.

Testing

  • pytest tests/schema tests/translator: 3204 passed.
  • Schema gate (regenerated schema matches the committed one): pass. black, ruff, and mypy --strict are 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 init through 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.

…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
seshubaws marked this pull request as ready for review October 13, 2026 18:39
@seshubaws
seshubaws requested a review from a team as a code owner October 13, 2026 18:39
@seshubaws seshubaws changed the title docs: sam-docs descriptions for AWS::Serverless::WebFunction and NetworkConnector ComputeTypes docs: sam-docs descriptions for AWS::Serverless::WebFunction and NetworkConnector Oct 13, 2026
@seshubaws
seshubaws added this pull request to the merge queue Oct 13, 2026
Merged via the queue into aws:develop with commit a130d8b Oct 13, 2026
9 checks passed
@seshubaws
seshubaws deleted the seshub/webfunction-sam-docs-public branch October 13, 2026 21:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants