docs(APIv2): RHINENG-15551 specify what counts as a failed rule

manually updated changes in openapi.json reverted in previous commit
RedHatInsights · Jan 24, 2025 · d18f4c1 · d18f4c1
1 parent 55fd635
commit d18f4c1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/spec/api/v2/schemas/test_result.rb b/spec/api/v2/schemas/test_result.rb
@@ -107,7 +107,7 @@ module TestResult
               type: %w[integer null],
               examples: [3],
               readOnly: true,
-              description: 'Number of failed rules in the Test Result'
+              description: 'Number of failures, errors and unknown states for rules in the Test Result.'
             },
             end_time: {
               type: :string,

diff --git a/swagger/v2/openapi.json b/swagger/v2/openapi.json
@@ -17349,7 +17349,7 @@
               3
             ],
             "readOnly": true,
-            "description": "Number of failed rules in the Test Result"
+            "description": "Number of failures, errors and unknown states for rules in the Test Result."
           },
           "end_time": {
             "type": "string",