Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4d94bf9

Browse files
committed
docs: minor docs fixes
1 parent 0fcae46 commit 4d94bf9

5 files changed

Lines changed: 27 additions & 26 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -115,35 +115,35 @@ Below is the `recommended` preset:
115115

116116
```yaml
117117
rules:
118-
info-description: warning
118+
info-description: warn
119119
info-contact: off
120120
info-license: off
121121
info-license-url: off
122122
123-
tag-description: warning
123+
tag-description: warn
124124
tags-alphabetical: off
125125
126-
no-server-example.com: warning
126+
no-server-example.com: warn
127127
no-server-trailing-slash: error
128-
no-empty-servers: warning
128+
no-empty-servers: warn
129129
130130
parameter-description: off
131131
no-path-trailing-slash: error
132132
path-declaration-must-exist: error
133133
path-not-include-query: error
134134
path-parameters-defined: error
135135
operation-description: off
136-
operation-2xx-response: warning
136+
operation-2xx-response: warn
137137
operation-operationId-unique: error
138138
operation-parameters-unique: error
139139
operation-tag-defined: off
140-
operation-security-defined: warning
140+
operation-security-defined: warn
141141
operationId-valid-in-url: error
142142
operation-singular-tag: off
143143
144144
no-example-value-and-externalValue: error
145145
146-
no-unused-components: warning
146+
no-unused-components: warn
147147
no-unresolved-refs: error
148148
no-enum-type-mismatch: error
149149
@@ -159,11 +159,11 @@ Here is an example of a modified use `.redocly.yaml` file:
159159
```yaml
160160
lint:
161161
rules:
162-
parameter-description: warning
162+
parameter-description: warn
163163
operationId-valid-in-url: off
164164
```
165165

166-
Each rule can be turned `off`. In addition, you can control the log-level severity, between `warning` and `error`.
166+
Each rule can be turned `off`. In addition, you can control the log-level severity, between `warn` and `error`.
167167

168168
Enabling a rule:
169169
```yaml
@@ -201,7 +201,7 @@ lint:
201201

202202
Possible values are:
203203

204-
* warning
204+
* warn
205205
* error
206206

207207
#### Ignore file
@@ -232,7 +232,8 @@ Ignore file can be autogenerated to add all messages to it by running `openapi l
232232
[Plugins](docs/plugins.md)
233233
[Type extensions](docs/type-extensions.md)
234234
[Custom rules](docs/custom-rules.md)
235-
[Transformers](docs/transformers.md)
235+
[Decorators](docs/decorators.md)
236+
[Preprocessors](docs/preprocessors.md)
236237

237238
## Credits
238239

docs/TRANSFORMERS.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/preprocessors.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Preprocessors
2+
3+
> NOTE: this feature is experimental. Modifying your data may break codeframes in errors.
4+
5+
## Rationale
6+
7+
There might appear such situation, when the input data should be mutated before applying default rules and/or bundling. For this case, you might want to run certain custom preprocessors before rules.
8+
9+
You can do it with `preprocessors`.
10+
11+
## Usage
12+
13+
TBD

docs/rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
All supported rules are listed below. To change your settings for any given rule, just add or modify a corresponding item in the `rules` section of the `.redocly.yaml` in your working directory.
66

77
Each of the `rules` entries can be one of following:
8-
- `rule-name`: `{severity}`, where `{severity}` is on of `error`, `warning` or `off`
8+
- `rule-name`: `{severity}`, where `{severity}` is on of `error`, `warn` or `off`
99
- ```
1010
rule-name:
1111
severity: {severity}

resources/.redocly.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ lint:
66
- recommended
77
- local/all
88
rules:
9-
operation-2xx-response: warning
9+
operation-2xx-response: warn
1010
no-invalid-media-type-examples: error
1111
operation-description: off
1212
path-http-verbs-order: error

0 commit comments

Comments
 (0)