Discussions

Ask a Question
ANSWERED

How can I decrease the padding from the right and left sides of the ReadMe portal?

Hi Team, I have a feedback from few of my team members, to decrease the padding from the right and left sides of the ReadMe portal. ReadMe portal is not utilizing complete space available in the browser and there is blank space before the left TOC and after the right TOC. What can be done to change the view similar to https://docs.readme.com/docs page? Thanks in advance!
ANSWERED

Trouble Configuring Cloudflare Workers

I have had some issues trying to get the cloudflare connection working with ReadMe. <https://www.cloudflare.com/apps/readme-api-metrics> When you get to the step to do OAUTH with ReadMe a window pops open asking you to login with your ReadMe credentials, and the Auth window itself seems a bit glitchy. After trying to login it just spits out "Failed to fetch" - I have tried a few different browsers, and disabling the custom domain, but cant seem to get it to flow. Anyone had any luck setting this up recently?
ANSWERED

Custom Login apiKey Cutoff problem

https://docs.readme.com/docs/custom-login-with-readme Hi readme team. We use Auth0 behind the scenes for login and when we send the apiKey (4731 characters long) it gets cutoff in the readme API explorer. Is there a solution for this problem?
ANSWERED

Remove 'Community Discussion' menu item

Hi We'd like to remove the community discussion feature, as we have a separate community forum. How might we do this? Cheers, Ed

Property Names Camel Case

Hi guys, I developed an endpoint that request body xml. Then i set swagger settings Pascal Case ("PropertyName1") like below. <?xml version="1.0" encoding="UTF-8"?> <root> <subRoot> <PropertyName1>string</PropertyName1> <PropertyName2>string</PropertyName2> </subRoot> </root> But when i push to readme, property names are camel case ("propertyName1"). How can i fix this problem ? <root> <subRoot> <propertyName1>string</propertyName1> <propertyName2>string</propertyName2> <subRoot> </root>
ANSWERED

How to merge "manual" edits with OpenAPI docs generated from source code?

My team currently updates API docs manually via the readme UI, but we're exploring auto-generating the docs from the code of our rails app, and updating them via the readme API. We're stuck on what the correct pattern would be to resolve potential conflicts between manual edits directly in readme, and whatever new edits are generated from code and synced up via OpenAPI. Does Readme have functionality to handle that? Has anyone found a pattern that works well for it?
ANSWERED

Automate the cli prompt

Hi I want to deploy my swagger files through automated process . But rdme login as well as rdme openapi path has a prompt to input the value. Is there a way to pass username and password through cli so that it does not ask for prompt? Also is there way to upload swagger file without prompt?

How do I make links not appear as White?

Hello, I have a problem regarding the appearance of links, they appear as white even when you hover over them. How do I make them any other color than white?
ANSWERED

Show Headers First in API References

Hi there! Is there any way to customize the ordering of the parameters in a reference section from the OpenAPI template? It seems like however you format the template, the order is always path params -> body params -> headers. Is there any way to show the headers first?
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)