Redocly / Redocly/redocly-cli

Override operationId `operation-id-override`

Open
#1,802 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
1.5k
Forks
228
Avg merge
1d 14h
Merged PRs (30d)
48

Description

Is your feature request related to a problem? Please describe.

Our "operationId" generation is not reliable (there could be duplicates and naming issues) and we would like to control it on client side.

Describe the solution you'd like

Have a bilt-in decorator to override operationId

Describe alternatives you've considered

Manual patching of swagger.json but before the main processing

Additional context

Similar to https://redocly.com/docs/cli/decorators/operation-description-override

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining how operationId values are currently generated and compare the requested behavior with Redocly's existing operation-description-override decorator. Define the built-in decorator's override semantics and verify that client-supplied values replace generated operationId values without duplicate or naming issues.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.