Discussions

Ask a Question
ANSWERED

Changing the alt text of images

Hi there! I have some questions about alt text in ReadMe docs. **Background** I was inspecting our ReadMe docs in dev tools and noticed that the alt text for our images are all numbers. Here's an example to clarify what I mean: \<img src="<https://files.readme.io/e9b47be-element_compare_to.png>" **alt="585"** title="element_compare_to.png" class="" align="" caption="" height="auto" width="auto" loading="lazy"> When I searched for "alt text images" in the ReadMe docs, I found this post - <https://docs.readme.com/discuss/618c4415962803001689666c> - which made me think I could update in the raw text version of the page. Unfortunately, when I toggled the raw text setting on, I couldn't figure out how to add the suggested Markdown to provide a more helpful alt tag. **My questions** 1. Is it possible to change the alt text for images in ReadMe? 2. If yes, how can I go about doing this? Thanks in advance! Molly
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?

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>

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

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
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?
ANSWERED

Is there a way to embed your OpenAPI calls in the Guides

When you are writing the descriptive guides, it would be nice to be able to embed an interactive API call in the guide that can be tracked.

Support for date-based API versions

I know that ReadMe is semver-ish with the supported versions, but this is posing a problem for us when we want to create a date-based version. We have a version 2022-09 that is not accepted by semver. Are there any suggestions for what we can do?
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?