Redocly/redoc

Redoc.init callback not working on error

Open

#2233 opened on Dec 9, 2022

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (21,877 stars) (2,272 forks)batch import
Type: Bughelp wanted

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.

Minimal reproducible OpenAPI snippet(if possible)

Screenshots

Additional context Add any other context about the problem here.

Contributor guide

Tech stack
typescriptreact
Domain
documentationfrontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Redoc.init APIFamiliarity with JavaScript callbacks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate the Redoc.init function implementation, specifically how the callback is called. Look at the error handling in the rendering pipeline. The issue mentions that the callback is not invoked on error; check if there is a missing error handler or a conditional that skips the callback. Also examine the code around the callback invocation in the source file where Redoc.init is defined, likely in src/index.ts or similar.