search

aws-cloudformation / cloudformation-resource-schema

The CloudFormation Resource Schema defines the shape and semantic for resources provisioned by CloudFormation. It is used by provider developers using the CloudFormation RPDK.
Apache License 2.0
95 stars 38 forks source link

Resource's schema description #97

Closed miparnisari closed 4 years ago

miparnisari commented 4 years ago

https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/blob/1fd31cdb3ca76f8418c0209753e204e4e12c019a/src/main/resources/examples/resource/initech.tps.report.v1.json#L3

The description in the schema is being used in the Console UI, and this has led to very poorly named descriptions

image

https://github.com/search?q=%22Resource+schema+for%22+org%3Aaws-cloudformation&type=Code

PatMyron commented 4 years ago

This is called out: https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/blob/1e99ac138807111f16c5368cf6977ec09dbd6d42/src/main/resources/schema/provider.definition.schema.v1.json#L278

but maybe that console needs to be re-thought or description shouldn't be required:

https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/blob/1e99ac138807111f16c5368cf6977ec09dbd6d42/src/main/resources/schema/provider.definition.schema.v1.json#L409-L412

based on how non-descriptive the descriptions have been so far