search

aws-cloudformation / cloudformation-coverage-roadmap

The AWS CloudFormation Public Coverage Roadmap
https://aws.amazon.com/cloudformation/
Creative Commons Attribution Share Alike 4.0 International
1.1k stars 53 forks source link

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

Open thomas11 opened 5 months ago

thomas11 commented 5 months ago

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

kddejong commented 4 months ago

I'm working with internal resources on this. I'll update this issue as I know more.

flostadler commented 1 month ago

Hey @kddejong, do you have any updates on this issue?

mariswa commented 1 month ago

The fix was deployed in May - could you please confirm folks?