Discussions

Ask a Question

Try It Out Not Working With Multiple Security Schemes

My OpenApi spec has multiple security schemes (see the example below). When viewing my API documentation, I can only see the first scheme. How do I select which one should be used in my ReadMe documentation?

Answered

embedding links in the glossary

I want to embed a link in a glossary term's definition... (e.g. look here, go here, follow the rabbit)

Answered

Run Python code within docs

Can I have a try it button for python code. as it is built for API calls?

Answered

How do we upload images in discussions

I'd like to add an image here but dont' see a way to do it without having to add a link (want to be able to drag/upload from local)

Manually added "What's next" pages do not get title updates.

Typically, if when editing a document through the dashboard, I do not modify the "What's next" field at the very bottom, then when viewing the article, I will have two links: one to the previous page, and one to the next page. These links are described with the current titles of the pages they link to. That's great.

Answered

On the changelog page, is it possible to change the amount of content that shows?

How do I control how much is shown on the changelog summary page?

Answered

How to document a custom method

HI! We have custom methods (e.g., RELOAD). What should I do to be able to select it in the dropdown when I document a new endpoint? Where to configure it? Thanks a lot!

Answered

How do I download the used images?

I am taking over a Readme.io project at a company. I want to download the images that are currently used so I can add some visual cues (boxes and arrows) and reload them. Is this possible? Or must I just redo alllll the images and reload them?

Answered

how can i update my rails api documentation automatically

I want to know if readme.io offers any support to update API documentation automatically in the form of gems or any information regarding it will be welcome

Answered