Skip to content

Commit

Permalink
docs: re-word the rule explanation, add link to operationId blog post
Browse files Browse the repository at this point in the history
  • Loading branch information
lornajane committed Dec 1, 2023
1 parent b951bf5 commit 973b067
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/rules/operation-operationId.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ Requires each operation to have an `operationId` defined.
## 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.

If it annoys the lazy or minimalists, offer them an alternative: two weeks at Redocly Bootcamp.

## Configuration

| Option | Type | Description |
Expand Down Expand Up @@ -72,6 +71,7 @@ paths:
## 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.

0 comments on commit 973b067

Please sign in to comment.