aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap

CloudformationSchema.zip: Descriptions longer than 1,000 chars are cut off

Open
#1,930 3 comments 1 reaction 0 assignees View on GitHub
bug
Dominant language
No language data
Stars
1.1k
Forks
62
PR merge metrics
No merged PRs in 30d

Description

### Name of the resource

Other

### Resource Name

All resources with a long description

### Issue Description

In the CF schema from both https://schema.cloudformation.us-east-1.amazonaws.com/CloudformationSchema.zip and https://schema.cloudformation.us-west-2.amazonaws.com/CloudformationSchema.zip, the `Description` properties are cut off after 1,000 characters. This started on February 15.

This leads to broken docs for tools that are generated based on the CF schema.

For instance, the description of `IdentitySource` in aws-apigateway-authorizer.json ends with
> Only when thi

### Expected Behavior

The full, untruncated description is preserved in CloudformationSchema.zip.

### Observed Behavior

See description.

### Test Cases

Download https://schema.cloudformation.us-east-1.amazonaws.com/CloudformationSchema.zip, unzip, open aws-apigateway-authorizer.json, observe the truncated description on line 31.

### Other Details

_No response_

Contributor guide

Open the contributing guide

Research direction

Download CloudformationSchema.zip from the us-east-1 or us-west-2 URL, unzip it, and inspect aws-apigateway-authorizer.json around line 31. Compare the IdentitySource description with the source schema or expected full text; done means descriptions in the published archive are no longer truncated at 1,000 characters.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.