Discussions

Hello everyone,
I’m working on documentation for a project that offers two service tiers (basic & premium) with slightly different API behaviours. I’d love to get feedback on how other teams handle docs versioning in such cases.

Hey everyone 👋

I recently uploaded a new API definition using the rdme CLI tool with the following command:

We’re experiencing an issue when trying to make API requests that involve a redirect_uri parameter from within a ReadMe API Explorer (iframe). Normally, standard API calls work fine within the embedded iframe, but when the endpoint requires a redirect flow (such as OAuth authorization), the request fails or does not behave as expected. Thanks for the help!!!
Here’s an example of the request that fails:
const options = { method: 'GET', headers: { accept: 'application/json' } };

Hi there,

Where is the previous slug parameter gone?

The appearance of the video insertion is broken. It currently displays as if it were a static image with a hover zoom (magnifying glass) effect. When clicked, the user is redirected to the video, but the overall design does not look good and is not intuitive.

There is a bug where the code is not being properly interpreted, causing it to spill into a new, separate section. Once this happens, the section cannot be edited or deleted.

We use Markdown syntax in our changelogs. When describing endpoint and endpoint parameters, we write something similar to