-
Notifications
You must be signed in to change notification settings - Fork 91
/
config-file.yaml
84 lines (84 loc) · 2.54 KB
/
config-file.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
$schema: http://json-schema.org/draft-07/schema#
title: IBM OpenAPI Validator Configuration File Schema
description: >
The structure of the configuration file supported by the IBM OpenAPI Validator
type: object
additionalProperties: false
properties:
colorizeOutput:
description: A flag that indicates whether the validator should colorize its output
type: boolean
default: true
errorsOnly:
description: A flag that causes the validator to include only errors in the output
type: boolean
default: false
files:
description: >
The names of the files to be validated.
Each element of the array is a glob-like string that will be evaluated relative
to the current directory at the time the validator is being run.
Examples: 'a.yaml', '../b.json', '../../c/foo.yml'
type: array
items:
type: string
ignoreFiles:
description: >
The fully-qualified names of files to be ignored
type: array
items:
type: string
limits:
description: >
An object containing various threshold limits supported by the validator
type: object
properties:
warnings:
description: >
If the number of warnings exceeds this threshold, an error is logged.
-1 indicates no threshold.
type: integer
default: -1
required:
- warnings
default:
warnings: -1
additionalProperties: false
logLevels:
description: >
An object that defines logLevel settings for loggers used by the validator.
It is a map of loggerName -> logLevel.
Valid logLevel values are: error, warn, info, debug
type: object
additionalProperties:
type: string
default:
root: info
outputFormat:
description: The type of output to be displayed by the validator
type: string
enum:
- json
- text
default: text
ruleset:
description: >
The name of a Specral ruleset file to be used instead
of the IBM Cloud Validation Ruleset
type: string
default: null
summaryOnly:
description: >
A flag that causes the validator to display only the summary in the output
type: boolean
default: false
produceImpactScore:
description: >
A flag that causes the validator to display an aggregated score based on the API impact of rule violations
type: boolean
default: false
markdownReport:
description: >
A flag that causes the validator to generate a report with rule violations and impact scores as a Markdown file
type: boolean
default: false