Redocly / Redocly/redocly-cli

Are nested visitors really not supported for preprocessors and decorators?

Open
#331 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I've noticed that docs says

Preprocessors and decorators do not support nested visitors.

https://github.com/Redocly/openapi-cli/blob/master/docs/custom-rules.md#L19

But in our preprocessing plugin we successfully use nested visitor Parameter > Schema.

Similarly, in the https://github.com/Redocly/openapi-cli/issues/294#issuecomment-871258605 there is a PathItem > Operation nested visitor.

Can you confirm that docs are still right and successful usage is accidental (so we shouldn't rely on it)?

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 with docs/custom-rules.md and review the nested visitor examples referenced in the issue, including the linked issue #294 comment. Confirm whether nested visitors are supported for preprocessors and decorators, then update the documentation to state the confirmed behavior and limitations.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, tooling
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.