These docs are for v2.0. Click to read the latest docs for v3.0.

Discussions

Ask a Question

404 on api reference section

Im having trouble making a readme file in readme.com where if click api-reference button no navbar takes me to a 404 not foud page, even if i have docs and pages created

Nested Discriminator support

Hey Readme.io community

Reusable content does not show in TOC

Hi

Recover deleted API reference page

I deleted an API reference page as I generated a new one using a different schema for the endpoints. But the old page had manual docs explaining each of the response fields and is now gone. I need these same docs fo the new page. Any way that you can recover this for me ? It just happened less than an hour ago.

Segment Integration sends wrong data

Hi

ANSWERED

How can we implement additional Level of Sidebar Nesting in readMe

Is there any documentation link that explains how we can add Additional Level of Sidebar Nesting in openAPI specification in readMe. Or is there any link of example for this.

ANSWERED

Cannot set a Plan

I've been trying to select a plan for my project after my free trial expired. Selecting the free plan, for instance, causes a 400 error:

How do we change our name from `null` in discussions when logged in?

I understand we can edit our profile via the readme.com dashboard but this does not change the name in when posting in discussions (currently null). Anyone know how to set our default name for all README discussions?

ANSWERED

Boolean enums always set to `true`

In writing OpenAPI files, when I want to enforce a fixed value for some key, I use an enum with a single item, as such:

Try now button

I have imported a OAS file which automatically enabled Try Now button for all endpoints. I understood that I can can turn it off by setting the OpenAPI extension x-explorer-enabled to false. But, with the design our documentation page will be visible to everyone, regardless logged in or not. So I am curious how to handle the case when users not signed in yet my platform so no api key can be retrieved.