Discussions

Ask a Question

The Guide is always seems to get out of sync.

I'm not sure what's happening, but we're updating the API Reference, but then when it's published and a new version is created, it seems to take an older version of the guides. Also is there anyway to sync or replace the guides version? Or do I have to retype in everything on the new version

Ability to ban or delete users

Currently, anyone at anytime can make an account in the Discussions section, and spam the hell out of it. There is no way to prevent this, or stop the spammer from continuing. CAPTCHAs are not a solution, as that does not prevent human driven spam, and the bad actor can do this every day, forever. I'm puzzled how this is not a feature of a public discussion forum. Please make this a thing.

Can you add the ability to export APIs into PDF?

I noticed you can only export Guides, we have lots of internal users asking for PDF exports of the APIs and I have been using <https://www.npmjs.com/package/apibake>, can we get this into the product?

URL encode query parameters in API Reference

My API allows query parameters that can contain special characters (for example, phone numbers with a `+` prefix). When users plug in the string with the special characters into the relevant query param in the API Reference and click "try it!" they expect for the special characters to be encoded correctly into the URL within the generated CURL. Is this a feature we can enable?

Adding a version prompts error: Error submitting form

Hi, When I try to add a new version I'm getting an error 'Error submitting form' without more details for troubleshooting. I'm trying to fork my only other version. Any pointers would be great.

Missing body parameters

![](https://files.readme.io/d20059e-image.png) Hey, I'm trying to configure Readme.com to show OpenApi specs but it does not always work. Some endpoints are ok but most of them have no body params at all (the same works in swagger/other open api hosting tool we currently use). Also, OpenApi file is valid according to rdme: "... is a valid OpenAPI API definition!" Is there any debug mode or logs I could check to analyse this issue?

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 I would like to know how I can achieve nested discriminator oneOf -> oneOf nested. When I have a nested oneOf property it does not take first discriminator for "channel" ![](https://files.readme.io/8cea777-Screenshot_2024-02-09_at_13.06.08.png) ![](https://files.readme.io/260ebad-Screenshot_2024-02-09_at_13.06.21.png) Example Code ```json "oneOf": [ { "$ref": "#/components/schemas/TemplateSMSPostRequestDto" }, { "$ref": "#/components/schemas/TemplateViberPostRequestDto" } ], "discriminator": { "propertyName": "channel", "mapping": { "SMS": "#/components/schemas/TemplateSMSPostRequestDto", "VIBER": "#/components/schemas/TemplateViberPostRequestDto" } } ``` TemplateSMSPostRequestDto ```json { "title": "SMS Template", "type": "object", "required": [ "text", "channel" ], "properties": { "channel": { "type": "string" }, "text": { "type": "string", "maxLength": 1000 } } } ``` TemplateViberPostRequestDto ```json { "title": "Viber Template", "type": "object", "allOf": [ { "required": [ "channel" ], "properties": { "channel": { "type": "string" } } }, { "oneOf": [ { "$ref": "#/components/schemas/TemplateViberImagePostRequestDto" }, { "$ref": "#/components/schemas/TemplateViberDocumentPostRequestDto" } ], "discriminator": { "propertyName": "type", "mapping": { "image": "#/components/schemas/TemplateViberImagePostRequestDto", "document": "#/components/schemas/TemplateViberDocumentPostRequestDto" } } } ] } ``` TemplateViberImagePostRequestDto ```json { "title": "Image Template", "type": "object", "required": [ "type", "channel" ], "properties": { "type": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string", "description": "One of 'url' or 'media_id' is required" }, "media_id": { "type": "string", "format": "uuid", "description": "One of 'url' or 'media_id' is required" } } } ``` TemplateViberDocumentPostRequestDto ```json { "title": "Document Template", "type": "object", "required": [ "type", "filename", "channel" ], "properties": { "type": { "type": "string" }, "filename": { "type": "string" }, "url": { "type": "string" }, "media_id": { "type": "string", "format": "uuid" } } } ```

Reusable content does not show in TOC

Hi Each page under **Guides** shows a small **table of contents** (_top, right_), based on the **page headings**. I notice, however, that headings from a **reusable content snippet** do **not** show up there. Is that something that Readme is planning to address? **Motivation**: Sometimes, we want to create a chunk of reusable content that includes headings. But bc of this limitation, we are forced to break it into smaller chunks, and leave the headings as fixed text. Thanks PS: The reusable content is a _very_ welcome feature. Great job! 👍

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.