CLOUDP-306575: IPA-118: Extensible by Default

[yelizhenden-mdb]

Proposed changes

Jira ticket: CLOUDP-306575

  xgen-IPA-118-no-additional-properties-false:
    description: |
      Schemas must not use `additionalProperties: false`

      ##### Implementation details
      This rule checks that schemas don't restrict additional properties by setting `additionalProperties: false`.
      Schemas without explicit `additionalProperties` settings (which default to true) or with `additionalProperties` set to `true` are compliant.
      This rule checks all nested schemas, but only parent schemas can be marked for exception.

No violations to fix

Checklist

• I have signed the MongoDB CLA
• I have added tests that prove my fix is effective or that my feature works

Changes to Spectral

• I have read the README file for Spectral Updates

Further comments

[yelizhenden-mdb]

FYI drive-by fix to sync with MMS

[lovisaberggren]

Can you add a test case where there are multiple additionalProperties: false? (In the same schema, nested for example)

[yelizhenden-mdb]

Sure, added them with the name invalid with multiple nested additionalProperties: false and invalid with multiple nested additionalProperties: false - exceptions. Let me know how it looks

[lovisaberggren]

Great, thanks!

[Copilot]

Pull Request Overview

This PR introduces a new rule (IPA-118) to prevent schemas from restricting additional properties by setting additionalProperties: false, reinforcing the principle of extensibility by default.

• Added a utility (findAdditionalPropertiesFalsePaths) to recursively locate instances of additionalProperties: false in schema objects
• Implemented the IPA118NoAdditionalPropertiesFalse rule that leverages this utility, along with comprehensive tests and documentation updates

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tools/spectral/ipa/rulesets/functions/utils/compareUtils.js	Adds a utility function to recursively detect paths with additionalProperties: false in schemas.
tools/spectral/ipa/rulesets/functions/IPA118NoAdditionalPropertiesFalse.js	Implements the new rule that checks schemas using the utility function.
tools/spectral/ipa/rulesets/README.md	Updates documentation to include the IPA-118 rule details.
tools/spectral/ipa/rulesets/IPA-118.yaml	Provides the rule configuration for Spectral.
tools/spectral/ipa/ipa-spectral.yaml	Adds the IPA-118 rule file to the overall Spectral configuration.
tools/spectral/ipa/tests/utils/compareUtils.test.js	Adds tests to verify the correctness of the new utility function.
tools/spectral/ipa/tests/IPA118NoAdditionalPropertiesFalse.test.js	Introduces tests to check the new rule's behavior under various scenarios.