mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-09 20:57:44 +00:00
88cd624d7a
* docs: Fix typo and remove reference to feature we're planning to drop * docs: re-word the rule explanation, add link to operationId blog post * docs: simplify rule description, pick more relevant related rules to link to * docs: simplify kebab-case explanation
87 lines
2.1 KiB
Markdown
87 lines
2.1 KiB
Markdown
---
|
|
slug: /docs/cli/rules/path-excludes-patterns
|
|
---
|
|
|
|
# path-excludes-patterns
|
|
|
|
Disallow patterns from paths.
|
|
|
|
| OAS | Compatibility |
|
|
| --- | ------------- |
|
|
| 2.0 | ✅ |
|
|
| 3.0 | ✅ |
|
|
| 3.1 | ✅ |
|
|
|
|
## API design principles
|
|
|
|
The [`no-http-verbs-in-paths` rule](./no-http-verbs-in-paths.md) is pre-built for a very specific set of patterns.
|
|
This rule is the general Swiss army knife version.
|
|
If you absolutely know something should not be in the path (for example `foo`), then add the pattern to prevent it.
|
|
|
|
Some common things to check using this rule: other common CRUD verbs, bad words, and internal code or terminology.
|
|
|
|
## Configuration
|
|
|
|
| Option | Type | Description |
|
|
| -------- | -------- | ---------------------------------------------------------------------------------------- |
|
|
| severity | string | Possible values: `off`, `warn`, `error`. Default `off` (in `recommended` configuration). |
|
|
| patterns | [string] | List of patterns to match. For example, `^\/[a-z]`. |
|
|
|
|
An example configuration:
|
|
|
|
```yaml
|
|
rules:
|
|
path-excludes-patterns:
|
|
severity: error
|
|
patterns:
|
|
- ^\/[0-9]
|
|
```
|
|
|
|
## Examples
|
|
|
|
Given this configuration:
|
|
|
|
```yaml
|
|
rules:
|
|
path-excludes-patterns:
|
|
severity: error
|
|
patterns:
|
|
- ^\/[0-9]
|
|
```
|
|
|
|
Example of an **incorrect** path:
|
|
|
|
```yaml
|
|
paths:
|
|
/1customers/{id}:
|
|
post:
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
```
|
|
|
|
Example of a **correct** path:
|
|
|
|
```yaml
|
|
paths:
|
|
/customers/{id}:
|
|
post:
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
```
|
|
|
|
## Related rules
|
|
|
|
- [no-http-verbs-in-paths.md](./no-http-verbs-in-paths.md)
|
|
- [paths-kebab-case](./paths-kebab-case.md)
|
|
- [operation-description](./operation-description.md)
|
|
- [configurable rules](./configurable-rules.md)
|
|
|
|
## Resources
|
|
|
|
- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/parameter-description.ts)
|
|
- [Paths docs](https://redocly.com/docs/openapi-visual-reference/paths/)
|