CLOUDP-306577: IPA-121: Datetime

[yelizhenden-mdb]

Proposed changes

Jira ticket: CLOUDP-306577

  xgen-IPA-121-date-time-fields-mention-iso-8601:
    description: |
      Fields with format="date-time" should mention ISO 8601 and UTC in their description.

Found 48 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

[Copilot]

Pull Request Overview

This pull request implements a new Spectral rule (IPA-121) to ensure that any API field with a date-time format explicitly mentions the ISO 8601 standard in its description.

• Adds a new function (IPA121DateTimeFieldsMentionISO8601.js) to check for the ISO 8601 mention in date-time fields.
• Updates Spectral rulesets and documentation (IPA-121.yaml and README.md) accordingly.
• Introduces tests for various valid and invalid cases in IPA121DateTimeFieldsMentionISO8601.test.js.

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tools/spectral/ipa/rulesets/functions/IPA121DateTimeFieldsMentionISO8601.js	Implements the new rule function to enforce ISO 8601 description requirement.
tools/spectral/ipa/rulesets/README.md	Documents the new rule with a brief description and usage details.
tools/spectral/ipa/rulesets/IPA-121.yaml	Defines the rule in the Spectral ruleset configuration.
tools/spectral/ipa/ipa-spectral.yaml	Adds the new IPA-121 ruleset to the overall IPA Spectral configuration.
tools/spectral/ipa/tests/IPA121DateTimeFieldsMentionISO8601.test.js	Provides test cases for validating the rule’s behavior.

[lovisaberggren]

[Nit] I think you could do this by using the unresolved oas, and this check isn't needed

[yelizhenden-mdb]

I can't think of a way to capture whether a property belongs to a referenced schema. Do you have any suggestions?

[lovisaberggren]

Not sure I understand the question. I tested locally to remove this check and by setting resolved: false in the rule definition, and the results are the same. Since the unresolved oas will not send matches for places where $ref is included, it will only validate inline schemas, params and schemas in the components.schemas section

[yelizhenden-mdb]

Ah okay, you suggested changing the resolved flag to false. Sure, makes sense 👍

[lovisaberggren]

TY!