ReadMe Documentation
Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!
Get StartedWelcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!
Get StartedHi We want the active section in the left navigation to be collapsible as it seems like good user experience when we have a lot of sections as our product contains. The collapsible feature is present on non-active sections. We want a similar to active sections as well. https://gifyu.com/image/InjS ➡️ Link to the gif.
Posted by Achyuth Chandra 6 months ago
The Code Sample widget has a very nice Copy button that appears when you hover. Is there a way to get similar functionality in a raw (i.e., triple-backtick-fenced) markdown code block? Often the Code Sample widget is overkill (for example, we don't want or need the tab header when there is only one language involved). Alternatively, is there a way to get rid of the tab header in the Code Sample widget...? :) Thanks!
Posted by Benjy Weinberger 7 months ago
Hello, Is there a way to replace a variable in the base URL with the provided API Key by the user? So the API URL looks like this: https://api.telegram.org/bot{API_KEY}/getMe (endpoints change). None of your existing supported authentication methods seem to work. Tried query, header and even path params (path params is adding a slash just after the base URL). I know it isn't common for this kinda setup but that's how it is from Telegram sadly. Refer docs: https://telegram-bot-sdk.readme.io/reference
Posted by Syed 7 months ago
Hi Guys, According to Query Parameters chapter of the OAS 3 Serialization standard found at https://swagger.io/docs/specification/serialization/, if we set style=pipeDelimited and explode=true in our parameter definition: { "in": "query", "name": "user", "style": "pipeDelimited", "explode": true, "schema": { "type": "array", "items": { "type": "string", "x-extensible-enum": [ "john", "jane", "bug" ] } } } we're expecting to serialize an array in the query string parameter as: ...?user=jane&user=bug&user=john Swagger doc generator works according to this but readme.io generator seems to always generates a space delimited list thus breaking our client's experience: ...?user=jane%2Cbug%2Cjohn Please instruct how to change our API definition so that the readme.io generator picks up the proper standard or give us the esitmate on when this bug will be fixed. This form of serialization is a requirement for us. Just pointing out that we are a paying customer :) Thanks, Greg
Posted by Grzegorz Kozub 7 months ago
Hi Support team, I've tried multiple times uploading the following file using the URL approach, but always got this error. (In fact, there is no such <span> element in my YMAL file, at line 114, column 71. I'm really confused.) Error parsing https://github.com/Rebeccacy/swagger-ui/blob/master/cloud_recording_restful_api.yaml end of the stream or a document separator is expected at line 114, column 71: ... r-bar top-0 left-0" style="width: 0%;"></span> ^ I've also tried using other approaches, e.g. directly dragging the YAML file from my local directory to the OpenAPI Upload box, but always got this error: You must upload JSON or YAML to this endpoint. This is weird since what I imported was a YAML file. Then I chose the API approach, but could not get authenticated after entering my Readme account password. Rebecca
Posted by rebecca 7 months ago
We are using SEMRush to crawl our main site - including the sub-domain developers.sinch.com and it is giving us a 403 error trying to crawl links to the readme hosted developers site. Is there a setting we need to tweak to allow this?
Posted by Scott Bailey 7 months ago
https://openpath.readme.io/reference#login is our login API. Just immediately hitting 'Try It' causes the spinner to start ... and continue forever (or until canceled via page close/reload). Running the suggested curl command on the CLI immediately responds with error (since there are no credentials to authenticate against). Looking at the chrome browser network tab, the browser is indicating some strange error with Status: (failed), Type: fetch. The problem reproduces both from my home network and work network. As such, this seems somehow a problem with the readme.io page. Any ideas how we get this working again?
Posted by Jim 7 months ago
Hi Support team, I'm new to readme and I've just created my first API reference today. I wanted to try out your Try it feature so I just clicked the Try it button, and expected some empty fields showing up next to each parameter, where I can enter my custom values like appID and channel name. However I don't see such empty field. The URL is https://agora-restful.readme.io/reference/getting-started-with-your-api-1. Please help troubleshoot. This is a much expected feature from my team and will affect the team's decision to use Readme as our API authering tool. Thanks!
Posted by rebecca 7 months ago
I am trying to sync a swagger file via the GitHub actions. Everything about the file seems in order, even uploading it from the front end side works okay (9 other files sync with the GitHub actions properly). However, for this one file, I am getting this error: ##[error]503 - "<!DOCTYPE html> <html> <head> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta charset="utf-8"> <title>Application Error</title> <style media="screen"> html,body,iframe { margin: 0; padding: 0; } html,body { height: 100%; overflow: hidden; } iframe { width: 100%; height: 100%; border: 0; } </style> </head> <body> <iframe src="//readme.io/error"></iframe> </body> </html>" ##[error]Node run failed with exit code 1
Posted by Sagini Abenga 7 months ago
We have a static XML resource hosted on our CDN (it's a code template) that we need to allow customers to download directly. We tried linking it in the documentation using raw mode like this: <a href="http://resources.static.liongard.com/scripts/automate.xml" download>Automate Script Link</a> but the download tag is stripped, so when the user visits the page they are greeted with an ugly error message from Chrome saying it can't render the file. Is there any way to work around this?
Posted by Dylan Barth 7 months ago