aws-cloudformation / aws-cloudformation/cloudformation-resource-schema

additionalProperties needs to be enforced to false

Open
#33 1 comment 1 reaction 0 assignees View on GitHub
bug high
Dominant language
Java
Stars
96
Forks
38
PR merge metrics
No merged PRs in 30d

Description

At [several](https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json#L167-L171) [points](https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/blob/master/src/main/resources/schema/provider.definition.schema.v1.json#L256-L260) in the schema, there are JSON schema blocks that force additionalProperties to be false:

https://github.com/aws-cloudformation/aws-cloudformation-resource-schema/blob/6db79a6253e65ee97c55aacfdb7c67f408d2d573/src/main/resources/schema/provider.definition.schema.v1.json#L167-L171

However at no point in the schema is the field marked as required so that this validation applies. This poses a problem since [the default value is true](https://json-schema.org/understanding-json-schema/reference/object.html).

We need to make a change so this field has to be present. Adding it to the `required` arrays where necessary is one possible avenue.

Contributor guide

Open the contributing guide

Research direction

Open src/main/resources/schema/provider.definition.schema.v1.json and inspect the linked schema sections around lines 167-171 and 256-260, then trace the related required arrays. Confirm that every relevant additionalProperties: false declaration is required by the schema, and validate the schema behavior with the repository's available checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
api
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.