chore: update error message

Author: DmitryAnansky

packages/core/src/rules/arazzo/__tests__/x-security-scheme-required-values.test.ts

@@ -63,7 +63,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`username\` is required for basic authentication security schema.",
+          "message": "The \`username\` is required when using the basic authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -76,7 +76,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`password\` is required for basic authentication security schema.",
+          "message": "The \`password\` is required when using the basic authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -89,7 +89,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`username\` is required for basic authentication security schema.",
+          "message": "The \`username\` is required when using the basic authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -102,7 +102,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`password\` is required for basic authentication security schema.",
+          "message": "The \`password\` is required when using the basic authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -166,7 +166,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`token\` is required for bearer authentication security schema.",
+          "message": "The \`token\` is required when using the bearer authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -179,7 +179,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`token\` is required for bearer authentication security schema.",
+          "message": "The \`token\` is required when using the bearer authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -245,7 +245,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`apiKey\` is required for apiKey authentication security schema.",
+          "message": "The \`apiKey\` is required when using the apiKey authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -258,7 +258,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`apiKey\` is required for apiKey authentication security schema.",
+          "message": "The \`apiKey\` is required when using the apiKey authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -332,7 +332,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`accessToken\` is required for oauth2 authentication security schema.",
+          "message": "The \`accessToken\` is required when using the oauth2 authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -345,7 +345,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`accessToken\` is required for oauth2 authentication security schema.",
+          "message": "The \`accessToken\` is required when using the oauth2 authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -409,7 +409,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`username\` is required for digest authentication security schema.",
+          "message": "The \`username\` is required when using the digest authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -422,7 +422,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`password\` is required for digest authentication security schema.",
+          "message": "The \`password\` is required when using the digest authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -435,7 +435,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`username\` is required for digest authentication security schema.",
+          "message": "The \`username\` is required when using the digest authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],
@@ -448,7 +448,7 @@ describe('Arazzo x-security-scheme-required-values', () => {
               "source": "arazzo.yaml",
             },
           ],
-          "message": "The \`password\` is required for digest authentication security schema.",
+          "message": "The \`password\` is required when using the digest authentication security schema.",
           "ruleId": "x-security-scheme-required-values",
           "severity": "error",
           "suggest": [],

packages/core/src/rules/respect/x-security-scheme-required-values.ts

@@ -47,7 +47,7 @@ function validateSecuritySchemas(
       for (const requiredValue of requiredValues) {
         if (!values || !(requiredValue in values)) {
           report({
-            message: `The \`${requiredValue}\` is required for ${authType} authentication security schema.`,
+            message: `The \`${requiredValue}\` is required when using the ${authType} authentication security schema.`,
             location: location.child(['x-security', extendedSecurity.indexOf(securitySchema)]),
           });
         }