Skip to content

Commit 0581cfa

Browse files
committed
chore: update docs
1 parent c040303 commit 0581cfa

File tree

3 files changed

+29
-1
lines changed

3 files changed

+29
-1
lines changed

docs/rules/arazzo/struct.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
slug: /docs/cli/rules/arazzo/struct
3+
---
4+
5+
# struct
6+
7+
Ensures that your API document conforms to the [OpenAPI specification](https://spec.openapis.org/arazzo/latest.html#arazzo-specification).
8+
9+
| Arzzo | Compatibility |
10+
| ----- | ------------- |
11+
| 1.0.0 ||
12+
13+
The default setting for this rule (in the `recommended` and `minimal` configuration) is `error`.
14+
15+
This is an essential rule that should not be turned off except in rare and special cases.
16+
17+
## Configuration
18+
19+
| Option | Type | Description |
20+
| -------- | ------ | ------------------------------------------------------------------------------------------ |
21+
| severity | string | Possible values: `off`, `warn`, `error`. Default `error` (in `recommended` configuration). |
22+
23+
An example configuration:
24+
25+
```yaml
26+
rules:
27+
struct: error
28+
```

docs/rules/oas/struct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ paths: {}
6363
6464
## Related rules
6565
66-
- [configurable rules](./configurable-rules.md)
66+
- [configurable rules](../configurable-rules.md)
6767
6868
## Resources
6969
File renamed without changes.

0 commit comments

Comments
 (0)