API docs Request Body Schema overflows

[wrussell1999]

Describe what's missing in our docs

It's hard to read the "multiline description" for the Request Body schema

It gets a bit easier to read when you make the page narrower as it puts the response below rather than side by side, but still overflows.

[unclebay143]

Checked this out via browser devtool, how about an horizontal scroll for each filter like below:

https://github.com/user-attachments/assets/fe56b726-ae45-4caf-b06b-491585691278

lmkwyt, can work on a PR for this

[MilosPaunovic]

Yup, go ahead and submit a PR @unclebay143, thanks! 🚀

[MilosPaunovic]

Hey @unclebay143, are there any updates on this?

[MilosPaunovic]

Hi @unclebay143,

As there hasn't been any progress or updates on this, I'll unassign you for now. However, if you do open a PR, it will be reviewed, and you'll be reassigned if no one else handles it in the meantime.

Thanks for all the efforts so far! 🍀

[unclebay143]

Hi @MilosPaunovic, was away for a dev talk over the weekend.

I spent some time here last week Thursday, and here are my findings:

• The API reference is using a third party library (RapiDoc), which doesn't support customising that part of the UI
• RapiDoc is rendering a Custom Component using the Shadow DOM approach

Things I've tried

• Custom CSS doesn't override it either ❌
• JavaScript Shadow DOM Injection ❌
• Review of RapiDoc Documentation: ❌
  • Explored css-file, css-classes, and ::part attributes.

So, essentially, we're blocked by the library's choice to encapsulate a non-exposed element.

If you have any insight or alternative approaches I might be missing, I'd appreciate the inspiration!