Skip to content

Bug: Markdown not rendering inside Schema component descriptions #14662

@Devon-White

Description

@Devon-White

Summary

Markdown in OpenAPI spec description fields (links, cross-references, code spans) does not render when displayed via the <Schema> component. The same descriptions render correctly in the auto-generated API reference docs.

Current Behavior

When a spec property has markdown in its description:

StatusCallback:
  type: string
  format: uri
  description: >
    The URL SignalWire will send webhooks to on every requested
    `StatusCallbackEvent` event. See the
    [Voice status callback](/docs/compatibility-api/rest/calls/webhooks/voice-status-callback)
    webhook for the payload your URL will receive.
  examples:
    - https://your-api-endpoint.com/path
  • API reference docs: Markdown renders correctly — links are clickable, code spans are formatted
  • <Schema> component: Raw markdown text is displayed as-is, links are not clickable

Expected Behavior

The <Schema> component should render markdown in description fields identically to how the API reference docs render them. Per the docs, this should be supported: https://buildwithfern.com/learn/docs/api-references/write-markdown-in-api-reference

Reproduction

  1. Define an OpenAPI schema with markdown links in a description field
  2. Reference it via <Schema api="your-api" type="YourType" />
  3. Observe that markdown is not rendered (links show as raw [text](url))
  4. Compare with the same schema rendered in the auto-generated API reference — markdown renders correctly there

Example

Live page showing the issue: https://signalwire.com/docs/compatibility-api/sdks/reference/calls/create#request.StatusCallback

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions