Skip to content

docs(toolkit): add missing description for rawErrorResponseSchema on createApi docs page #5257

@aryaemami59

Description

@aryaemami59

Summary

The description for the rawErrorResponseSchema property is missing from the createApi API reference. The section exists (the anchor works) but there is no explanatory text describing the property's purpose or how it differs from errorResponseSchema.

Expected behavior

The rawErrorResponseSchema section should explain:

  • That it validates the error response before transformErrorResponse runs
  • How it differs from errorResponseSchema, which validates after transformation
  • When to use one vs. the other

This distinction is non-obvious and is actively causing user confusion (see #4989).

Actual behavior

The rawErrorResponseSchema anchor exists in the docs but the description is empty/missing.

Root cause

A docblocks plugin issue is causing the JSDoc description for rawErrorResponseSchema to be stripped during docs generation.

Steps to reproduce

  1. Visit https://redux-toolkit.js.org/rtk-query/api/createApi#rawerrorresponseschema
  2. Observe that there is no descriptive text for the property
    errorResponseSchema — validates the error shape after transformErrorResponse runs.
    rawErrorResponseSchema — validates the error shape before transformation (i.e., against the raw server response).

Related: #4989
See related comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationImprovements or additions to documentationRTK-QueryIssues related to Redux-Toolkit-Query

    Type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions