update severity level for api-insights-openapi-ruleset

CiscoDevNet · Mar 3, 2023 · d27155f · d27155f
1 parent 84c938b
commit d27155f
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 33 deletions.
diff --git a/api-insights-openapi-ruleset.js b/api-insights-openapi-ruleset.js
@@ -101,7 +101,7 @@ export default {
     'resource-pas-camel-case-info': {
       'description': 'Resource names use PasCamelCase.',
       'message': '{{error}}',
-      'severity': 'info',
+      'severity': 'warn',
       'given': '$.paths[*]~',
       'then': {
         'function': resourcePasCamelCase,
@@ -156,7 +156,7 @@ export default {
     'status-codes-in-2xx-4xx-5xx': {
       'description': 'API responds with recommended HTTP status codes in the 2xx/3xx/4xx/5xx ranges.',
       'message': '{{error}}',
-      'severity': 'warn',
+      'severity': 'error',
       'given': "$.paths.*[?( @property === 'get' || @property === 'put' || @property === 'post' || @property === 'delete' || @property === 'options' || @property === 'head' || @property === 'patch' || @property === 'trace' )]",
       'then': {
         'field': 'responses',
@@ -268,7 +268,7 @@ export default {
     'date-response-header-format-pattern-requirement': {
       'description': "All responses include a 'Date' header in the GMT timezone and RFC 5322 format.",
       'message': "All 'Date' response headers should use a custom pattern match for RFC 5322. date-time or other given formats should not be used (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)",
-      'severity': 'info',
+      'severity': 'warn',
       'given': '$.paths.*.*.responses[*].headers.Date.schema',
       'then': [
         {
@@ -284,7 +284,7 @@ export default {
     'date-response-header-regex-check': {
       'description': "All responses include a 'Date' header in the GMT timezone and RFC 5322 format.",
       'message': '{{error}}',
-      'severity': 'info',
+      'severity': 'warn',
       'given': '$.paths.*.*.responses[*].headers.Date.schema',
       'then': {
         'field': 'pattern',
@@ -366,7 +366,7 @@ export default {
     'oas2-tracking-id-header-string-requirement': {
       'description': "'TrackingID' header should be a string in order to accommodate a UUID.",
       'message': "'TrackingID' header should be a string in order to accommodate a UUID (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)",
-      'severity': 'info',
+      'severity': 'warn',
       'given': '$.paths.*.*.responses[*].headers[?( /^trackingid$/i.test(@property) )]',
       'then': {
         'field': 'type',
@@ -379,7 +379,7 @@ export default {
     'oas3-tracking-id-header-string-requirement': {
       'description': "'TrackingID' header should be a string in order to accommodate a UUID.",
       'message': "'TrackingID' header should be a string in order to accommodate a UUID (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)",
-      'severity': 'info',
+      'severity': 'warn',
       'given': '$.paths.*.*.responses[*].headers[?( /^trackingid$/i.test(@property) )].schema',
       'then': {
         'field': 'type',
@@ -674,7 +674,7 @@ export default {
     'oas2-error-response-identifier': {
       'description': 'Error representations include an identifier to help with troubleshooting.',
       'message': 'Error representations include an identifier to help with troubleshooting (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
-      'severity': 'info',
+      'severity': 'warn',
       'given': "$.paths.*[?(@property !== 'head')].responses[?(/^4\\d\\d.*$/i.test(@property) || /^5\\d\\d.*$/i.test(@property))]",
       'formats': [oas2],
       'then': [
@@ -686,7 +686,7 @@ export default {
     'oas3-error-response-identifier': {
       'description': 'Error representations include an identifier to help with troubleshooting.',
       'message': 'Error representations include an identifier to help with troubleshooting (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
-      'severity': 'info',
+      'severity': 'warn',
       'given': "$.paths.*[?(@property !== 'head')].responses[?(/^4\\d\\d.*$/i.test(@property) || /^5\\d\\d.*$/i.test(@property))]",
       'formats': [oas3],
       'then': [
@@ -1218,7 +1218,7 @@ export default {
       'description': "Sorting collections is designed with a 'sort' query parameter.",
       'formats': [oas2],
       'message': '{{error}} (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
-      'severity': 'info',
+      'severity': 'warn',
       'given': '$.paths[?( !(/\\/{.*}$/.test(@property)) )].get',
       'then': {
         'function': checkForSort,
@@ -1228,7 +1228,7 @@ export default {
       'description': "Sorting collections is designed with a 'sort' query parameter.",
       'formats': [oas3],
       'message': '{{error}} (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
-      'severity': 'info',
+      'severity': 'warn',
       'given': '$.paths[?( !(/\\/{.*}$/.test(@property)) )].get',
       'then': {
         'function': checkForSort,
@@ -1307,7 +1307,7 @@ export default {
     'authenticate-requests': {
       'description': 'API.REST.SECURITY.03: My API authenticates and authorizes all requests',
       'message': 'API.REST.SECURITY.03: My API authenticates and authorizes all requests (https://developer.cisco.com/docs/api-insights/#!api-guidelines-analyzer)',
-      'severity': 'warn',
+      'severity': 'error',
       'given': '$.paths.*.*',
       'then': [
         {
@@ -1326,7 +1326,7 @@ export default {
     'reason-phrase': {
       'description': 'Reason phrase needs to match',
       'message': '{{error}}',
-      'severity': 'warn',
+      'severity': 'error',
       'given': '$.paths.*.*.responses.*.description',
       'then': [
         {

diff --git a/test/authenticate-requests.spec.js b/test/authenticate-requests.spec.js
@@ -54,7 +54,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 1,
+        severity: 0,
       },
       {
         code: ruleName,
@@ -74,7 +74,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 1,
+        severity: 0,
       },
       {
         code: ruleName,
@@ -94,7 +94,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 1,
+        severity: 0,
       },
       {
         code: ruleName,
@@ -114,7 +114,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 1,
+        severity: 0,
       },
       {
         code: ruleName,
@@ -134,7 +134,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 1,
+        severity: 0,
       },
     ]);
   });

diff --git a/test/date-response-header-format-pattern-requirement.spec.js b/test/date-response-header-format-pattern-requirement.spec.js
@@ -57,7 +57,7 @@ describe(ruleName, () => {
             character: 33,
           },
         },
-        severity: 2,
+        severity: 1,
       },
       {
         code: ruleName,
@@ -83,7 +83,7 @@ describe(ruleName, () => {
             character: 33,
           },
         },
-        severity: 2,
+        severity: 1,
       },
       {
         code: ruleName,
@@ -108,7 +108,7 @@ describe(ruleName, () => {
             character: 29,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });

diff --git a/test/date-response-header-regex-check.spec.js b/test/date-response-header-regex-check.spec.js
@@ -58,7 +58,7 @@ describe(ruleName, () => {
             character: 183,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });

diff --git a/test/oas2-error-response-identifier.spec.js b/test/oas2-error-response-identifier.spec.js
@@ -56,7 +56,7 @@ describe(ruleName, () => {
               character: 28,
             },
           },
-          severity: 2,
+          severity: 1,
         },
         {
           code: ruleName,
@@ -78,7 +78,7 @@ describe(ruleName, () => {
               character: 28,
             },
           },
-          severity: 2,
+          severity: 1,
         },
       ]);
     });

diff --git a/test/oas2-get-collection-sort-parameter.spec.js b/test/oas2-get-collection-sort-parameter.spec.js
@@ -54,7 +54,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });
@@ -81,7 +81,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });

diff --git a/test/oas2-tracking-id-header-string-requirement.spec.js b/test/oas2-tracking-id-header-string-requirement.spec.js
@@ -58,7 +58,7 @@ describe(ruleName, () => {
             character: 27,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });

diff --git a/test/oas3-error-response-identifier.spec.js b/test/oas3-error-response-identifier.spec.js
@@ -56,7 +56,7 @@ describe(ruleName, () => {
               character: 50,
             },
           },
-          severity: 2,
+          severity: 1,
         },
         {
           code: ruleName,
@@ -78,7 +78,7 @@ describe(ruleName, () => {
               character: 50,
             },
           },
-          severity: 2,
+          severity: 1,
         },
       ]);
     });

diff --git a/test/oas3-get-collection-sort-parameter.spec.js b/test/oas3-get-collection-sort-parameter.spec.js
@@ -54,7 +54,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });
@@ -81,7 +81,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });

diff --git a/test/oas3-tracking-id-header-string-requirement.spec.js b/test/oas3-tracking-id-header-string-requirement.spec.js
@@ -59,7 +59,7 @@ describe(ruleName, () => {
             character: 29,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });

diff --git a/test/resource-pas-camel-case-info.spec.js b/test/resource-pas-camel-case-info.spec.js
@@ -51,7 +51,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 2,
+        severity: 1,
       },
       {
         code: ruleName,
@@ -70,7 +70,7 @@ describe(ruleName, () => {
             character: 25,
           },
         },
-        severity: 2,
+        severity: 1,
       },
     ]);
   });