fixes

Author: yelizhenden-mdb

tools/spectral/ipa/__tests__/IPA121DateTimeFieldsMentionISO8601.test.js

@@ -26,10 +26,10 @@ testRule('xgen-IPA-121-date-time-fields-mention-iso-8601', [
           TestParameter: {
             name: 'createdAt',
             in: 'query',
+            description: 'The creation timestamp in ISO 8601 format in UTC.',
             schema: {
               type: 'string',
               format: 'date-time',
-              description: 'The creation timestamp in ISO 8601 format in UTC.',
             },
           },
         },
@@ -82,10 +82,10 @@ testRule('xgen-IPA-121-date-time-fields-mention-iso-8601', [
           TestParameter: {
             name: 'createdAt',
             in: 'query',
+            description: 'The creation timestamp',
             schema: {
               type: 'string',
               format: 'date-time',
-              description: 'The creation timestamp',
             },
           },
         },
@@ -127,7 +127,7 @@ testRule('xgen-IPA-121-date-time-fields-mention-iso-8601', [
         code: 'xgen-IPA-121-date-time-fields-mention-iso-8601',
         message:
           'API producers must use ISO 8601 date-time format in UTC for all timestamps. Fields must note ISO 8601 in their description.',
-        path: ['components', 'parameters', 'TestParameter', 'schema'],
+        path: ['components', 'parameters', 'TestParameter'],
         severity: DiagnosticSeverity.Warning,
       },
     ],
@@ -154,13 +154,13 @@ testRule('xgen-IPA-121-date-time-fields-mention-iso-8601', [
           TestParameter: {
             name: 'createdAt',
             in: 'query',
+            description: 'The creation timestamp',
             schema: {
               type: 'string',
               format: 'date-time',
-              description: 'The creation timestamp',
-              'x-xgen-IPA-exception': {
-                'xgen-IPA-121-date-time-fields-mention-iso-8601': 'Legacy field format',
-              },
+            },
+            'x-xgen-IPA-exception': {
+              'xgen-IPA-121-date-time-fields-mention-iso-8601': 'Legacy field format',
             },
           },
         },
@@ -178,19 +178,19 @@ testRule('xgen-IPA-121-date-time-fields-mention-iso-8601', [
               {
                 name: 'since',
                 in: 'query',
+                description: 'Filter resources created since this ISO 8601 timestamp in UTC',
                 schema: {
                   type: 'string',
                   format: 'date-time',
-                  description: 'Filter resources created since this ISO 8601 timestamp in UTC',
                 },
               },
               {
                 name: 'until',
                 in: 'query',
+                description: 'Filter resources created until this timestamp', // Missing ISO 8601 and UTC
                 schema: {
                   type: 'string',
                   format: 'date-time',
-                  description: 'Filter resources created until this timestamp', // Missing ISO 8601 and UTC
                 },
               },
             ],
@@ -203,7 +203,7 @@ testRule('xgen-IPA-121-date-time-fields-mention-iso-8601', [
         code: 'xgen-IPA-121-date-time-fields-mention-iso-8601',
         message:
           'API producers must use ISO 8601 date-time format in UTC for all timestamps. Fields must note ISO 8601 in their description.',
-        path: ['paths', '/resources', 'get', 'parameters', '1', 'schema'],
+        path: ['paths', '/resources', 'get', 'parameters', '1'],
         severity: DiagnosticSeverity.Warning,
       },
     ],

tools/spectral/ipa/rulesets/IPA-121.yaml

@@ -8,10 +8,11 @@ rules:
   xgen-IPA-121-date-time-fields-mention-iso-8601:
     description: |
       Fields with format="date-time" should mention ISO 8601 and UTC in their description.
+      It collects adoption metrics at schema property level and parameter level
     message: '{{error}} https://mdb.link/mongodb-atlas-openapi-validation#xgen-IPA-121-date-time-fields-mention-iso-8601'
     given:
-      - $.paths..parameters[*].schema
-      - $.components.parameters.*.schema
+      - $.paths..parameters[*]
+      - $.components.parameters[*]
       - $.components.schemas..properties[*]
       - $.paths..requestBody..schema..properties[*]
       - $.paths..responses..schema..properties[*]

tools/spectral/ipa/rulesets/README.md

@@ -810,6 +810,7 @@ Rules are based on [http://go/ipa/IPA-121](http://go/ipa/IPA-121).
 
  ![warn](https://img.shields.io/badge/warning-yellow) 
 Fields with format="date-time" should mention ISO 8601 and UTC in their description.
+It collects adoption metrics at schema property level and parameter level
 
 
 

tools/spectral/ipa/rulesets/functions/IPA121DateTimeFieldsMentionISO8601.js

@@ -9,7 +9,7 @@ const ERROR_MESSAGE =
 export default (input, options, { path, documentInventory }) => {
   const oas = documentInventory.unresolved;
   const propertyObject = resolveObject(oas, path);
-
+  const fieldType = path[path.length - 2];
   // Not to duplicate the check for referenced schemas
   if (!propertyObject) {
     return;
@@ -20,8 +20,16 @@ export default (input, options, { path, documentInventory }) => {
     return;
   }
 
-  if (input.format === 'date-time') {
-    if (!input.description?.includes('ISO 8601') && !input.description?.includes('UTC')) {
+  let format;
+  let description = input.description;
+  if (fieldType === 'parameters') {
+    format = input.schema?.format;
+  } else if (fieldType === 'properties') {
+    format = input.format;
+  }
+
+  if (format === 'date-time') {
+    if (!description?.includes('ISO 8601') && !description?.includes('UTC')) {
       return collectAndReturnViolation(path, RULE_NAME, [
         {
           path,