mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-07 20:57:49 +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
1.9 KiB
1.9 KiB
slug
| slug |
|---|
| /docs/cli/rules/paths-kebab-case |
paths-kebab-case
Require kebab-case in paths instead of camelCase or snake_case.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
API design principles
The base URL is case insensitive. The paths are case sensitive. It's a good practice to NOT confuse anyone, including yourself, with that fact, by using lowercase paths.
However, whatsapersontodowhenapathbecomesreallyhardtoread? Use the de facto standard of kebab-case.
Let's see if that question from above is easier to read this time around: whats-a-person-to-do-when-a-path-becomes-really-hard-to-read? That's what we thought!
Configuration
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default off (in recommended configuration). |
An example configuration:
rules:
paths-kebab-case: error
Examples
Given this configuration:
rules:
paths-kebab-case: error
Example of an incorrect path:
paths:
/customer_orders/{id}:
post:
parameters:
- name: id
in: path
required: true
Example of a correct path:
paths:
/customer-orders/{id}:
post:
parameters:
- name: id
in: path
required: true
description: The customer's ID.