Redocly / Redocly/redoc

Redoc.init callback not working on error

Open
#2,233 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted Type: Bug
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Describe the bug
Callback function registered on Redoc.init is not called on error while rendering redoc.

Redoc.init(
  event.data,
  config,
  document.getElementById('redoc-container'),
  callback ---> doesn't seem to be called.
);

If something's wrong in my code, please tell me how to apply callback function on error.

Expected behavior
Callback function should be called on error.
image

Minimal reproducible OpenAPI snippet(if possible)

Screenshots
image

Additional context
Add any other context about the problem here.

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 at the Redoc.init entry point and trace the rendering error path to see where the callback is skipped. Reproduce the reported error, add coverage for the error case, and confirm that the callback is invoked when rendering fails.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
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.