You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guides/2-cli.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -63,12 +63,12 @@ Here you can build a [custom ruleset](../getting-started/3-rulesets.md), or exte
63
63
64
64
## Scoring the API
65
65
66
-
Scoring an API definition is a way to understand in a high level, how compliant is the API definition with the rulesets provided. This helps teams to understand the quality of the APIs regarding the definition.
66
+
Scoring an API definition is a way to understand at a high level how compliant the API definition is with the rulesets provided. This helps teams to understand the quality of the APIs regarding the definition.
67
67
68
68
The scoring is produced in two different metrics:
69
69
70
-
- A number scoring. Who cames as substracting from 100% from any error or warning
71
-
- A letter, who groups numeric scorings in letters from A (better) to any
70
+
- A number scoring: Calculated by subtracting any error or warning from 100%.
71
+
- A letter scoring, which groups numeric scoring in letters from A to Z, with A being the best score.
72
72
73
73
Also it introduces a quality gate, were an API scoring below the specific threshold will fail in a pipeline.
74
74
@@ -119,11 +119,11 @@ Heres an example of this scoringFile config file:
119
119
120
120
Where:
121
121
122
-
- scoringSubtract : An object with a key/value pair objects for every result level we want to subtract percentage, with the percentage to subtract from number of results on every result type
123
-
- scoringLetter : An object with key/value pairs with scoring letter and scoring percentage, that the result must be greater, for this letter
122
+
- scoringSubtract : An object with key/value pair objects for every result level we want to subtract percentage, with the percentage to subtract from number of results on every result type
123
+
- scoringLetter : An object with key/value pairs with scoring letter and scoring percentage, that the result must be greater, for this letter
124
124
- threshold : A number with minimum percentage value to provide valid the file we are checking
125
-
- warningsSubtract : A boolean to setup if accumulate the result types to less the scoring percentage or stop counting on most critical result types
126
-
- uniqueErrors : A boolean to setup a count with unique errors or with all of them. An error is considered unique if its code and message have not been seen yet
125
+
- warningsSubtract : A boolean to accumulate the result types to less than the scoring percentage or to stop counting on most critical result types
126
+
- uniqueErrors : A boolean to count unique errors or all errors. An error is considered unique if its code and message have not been seen yet
0 commit comments