CLOUDP-305862: IPA 106 documentation standard

Author: wtrocki

tools/spectral/ipa/__tests__/exceptionExtensionFormat.test.js renamed to tools/spectral/ipa/__tests__/IPA105exceptionExtensionFormat.test.js

@@ -51,25 +51,25 @@ testRule('xgen-IPA-005-exception-extension-format', [
     errors: [
       {
         code: 'xgen-IPA-005-exception-extension-format',
-        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa/5',
+        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa-spectral#IPA-102',
         path: ['paths', '/path1', 'x-xgen-IPA-exception'],
         severity: DiagnosticSeverity.Warning,
       },
       {
         code: 'xgen-IPA-005-exception-extension-format',
-        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa/5',
+        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa-spectral#IPA-102',
         path: ['paths', '/path2', 'x-xgen-IPA-exception', 'xgen-IPA-100-rule-name'],
         severity: DiagnosticSeverity.Warning,
       },
       {
         code: 'xgen-IPA-005-exception-extension-format',
-        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa/5',
+        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa-spectral#IPA-102',
         path: ['paths', '/path3', 'x-xgen-IPA-exception', 'invalid-rule-name'],
         severity: DiagnosticSeverity.Warning,
       },
       {
         code: 'xgen-IPA-005-exception-extension-format',
-        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa/5',
+        message: 'IPA exceptions must have a valid rule name and a reason. http://go/ipa-spectral#IPA-102',
         path: ['paths', '/path4', 'x-xgen-IPA-exception', 'xgen-IPA-100-rule-name'],
         severity: DiagnosticSeverity.Warning,
       },

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

@@ -2,13 +2,20 @@
 # http://go/ipa/5
 
 functions:
-  - exceptionExtensionFormat
+  - IPA105ExceptionExtensionFormat
 
 rules:
   xgen-IPA-005-exception-extension-format:
-    description: 'IPA exception extensions must follow the correct format. http://go/ipa/5'
-    message: '{{error}} http://go/ipa/5'
+    description: |
+      IPA exception extensions must follow the correct format. http://go/ipa/5
+      
+      ##### Implementation details
+      Rule checks for the following conditions:
+        - Exception rule names must start with 'xgen-IPA-' prefix
+        - Each exception must include a non-empty reason as a string
+        - This rule itself does not allow exceptions
+    message: '{{error}} http://go/ipa-spectral#IPA-102'
     severity: error
     given: '$..x-xgen-IPA-exception'
     then:
-      function: 'exceptionExtensionFormat'
+      function: 'IPA105ExceptionExtensionFormat'

tools/spectral/ipa/rulesets/README.md

@@ -17,6 +17,13 @@ Rule is based on [http://go/ipa/IPA-5](http://go/ipa/IPA-5).
  ![error](https://img.shields.io/badge/error-red) 
 IPA exception extensions must follow the correct format. http://go/ipa/5
 
+##### Implementation details
+Rule checks for the following conditions:
+  - Exception rule names must start with 'xgen-IPA-' prefix
+  - Each exception must include a non-empty reason as a string
+  - This rule itself does not allow exceptions
+
+
 
 
 ### IPA-102