mirror of
https://github.com/LukeHagar/redocly-cli.git
synced 2025-12-07 12:47: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
78 lines
2.0 KiB
Markdown
78 lines
2.0 KiB
Markdown
---
|
|
slug: /docs/cli/rules/operation-operationId
|
|
---
|
|
|
|
# operation-operationId
|
|
|
|
Requires each operation to have an `operationId` defined.
|
|
|
|
| OAS | Compatibility |
|
|
| --- | ------------- |
|
|
| 2.0 | ✅ |
|
|
| 3.0 | ✅ |
|
|
| 3.1 | ✅ |
|
|
|
|
## API design principles
|
|
|
|
The `operationId` is used by tooling to identify operations (which are otherwise done through scary looking JSON pointers).
|
|
OpenAPI does not consider `operationId` a required field, but we'd describe it as a strongly recommended field.
|
|
|
|
This rule is unopinionated.
|
|
|
|
## Configuration
|
|
|
|
| Option | Type | Description |
|
|
| -------- | ------ | ----------------------------------------------------------------------------------------- |
|
|
| severity | string | Possible values: `off`, `warn`, `error`. Default `warn` (in `recommended` configuration). |
|
|
|
|
An example configuration:
|
|
|
|
```yaml
|
|
rules:
|
|
operation-operationId: error
|
|
```
|
|
|
|
## Examples
|
|
|
|
Given this configuration:
|
|
|
|
```yaml
|
|
rules:
|
|
operation-operationId: error
|
|
```
|
|
|
|
Example of an **incorrect** operation:
|
|
|
|
```yaml
|
|
paths:
|
|
/cars:
|
|
get:
|
|
responses:
|
|
'200':
|
|
$ref: ./Success.yaml
|
|
```
|
|
|
|
Example of a **correct** operation:
|
|
|
|
```yaml
|
|
paths:
|
|
/cars:
|
|
get:
|
|
operationId: GetCar
|
|
responses:
|
|
'200':
|
|
$ref: ./Success.yaml
|
|
```
|
|
|
|
## Related rules
|
|
|
|
- [operation-operationId-unique](./operation-operationId-unique.md)
|
|
- [operation-operationId-url-safe](./operation-operationId-url-safe.md)
|
|
|
|
## Resources
|
|
|
|
- [OperationIds make good API design - Redocly Blog](https://redocly.com/blog/operationid-is-api-design/)
|
|
- [Rule source](https://github.com/Redocly/redocly-cli/blob/main/packages/core/src/rules/common/operation-operationId.ts)
|
|
- [Operation object docs](https://redocly.com/docs/openapi-visual-reference/operation/)
|
|
- Consider using [configurable rules](./configurable-rules.md) for more specific rules for `operationId`s such as length, casing, and pattern enforcement.
|