I am pretty new to this and I have a project I want to set up. All of the stuff in internal however. The files we have are .yaml files and I am attempting to import via the command line. I submit something such as `rdme swagger swagger-sample.yaml --key=xxxxxx` and get a response: `"error":"Bad Request","description":"You must upload JSON to this endpoint","errors":null}` So... do imported files have to be in json format? I converted to json and did the following: `rdme swagger swagger-sample.json --key=xxxxxx` and recieved this subsequent response: `"error":"Bad Request","description":"No version that matches this Swagger file was found","errors"` Can anyone advise on how to resolve such errors, I have tried looking at the readme docs but there seems to be some rendering errors on them currently. Thanks in advance.
Posted by Mildred Rodriguez about a year ago
The Best Practices page mentions "versioning for a staging environment or creating a separate project specifically as a sandbox", but I couldn't find more information about how to do this. Basically, I want to have a live version of the docs (`v1`) and a sandbox (`v1-dev`). In `v1-dev`, I would make and save edits to existing topics for review by others on my team. Once the review is complete, I can merge those changes over to `v1`. Does readme support this workflow or something similar? If not, what is the best way to use readme's versioning features with a development version of the docs?
Posted by Dex Cook about a year ago
We have problems with our reference page on readme.io, here goes: 1. Most important. The anchor tags in the menu does not work unless you click them multiple times. See: https://docs.reepay.com/v1.0/reference and click for example errors in the left menu. This issue also applies when linking direct. 2. No response listing. I know you can get response example, but we (and properly also others) need to shop name, type, opt/mandatory and description. (when using swagger as import) 3. When using swagger as import and using try it, it does not understand if an array is optional. It will then send an empty array.
Posted by robert Mygind about a year ago
Hi there, I am trying to use the rdme cli, but I am hampered (I think!) by our okta integration. When I do "rdme login" it asks for an email, password, and subdomain. When I put my single-sign-on info in there, it doesn't work. We use 2FA here at Box, so I tried "rdme login --2fa", and put in my 2fa key as well. No dice. It keeps saying "Invalid email/password" no matter what I try. Is there any way I can use the rdme cli? Thanks,
Posted by Edwin Hoogerbeets about a year ago
Hello, I just noticed that the default values (being sent via the x-send-defaults: true) in my API explorer are not sending when attempting to 'try my' APIs via the API explorer. I haven't made changes to the Swagger file and when i delete the default and manually enter an API key the calls work. Here's a link to my API explorer page: https://developers.digitalriver.com/v1.0/reference#products. To replicate this issue, click on the link provided, click on try it > the call will fail. If you copy/paste and delete the default API key and paste in the copied API key > click on 'try it' > call works. Can you please help? Thanks, Josh
Posted by Josh about a year ago
## What is happened I wrote API reference by using feature of API Endpoint; I set up the default value of a boolean field in body parameters; I saved the settings and went to the reference page. However, the default value is not displayed. In detail, the default value (e.g. true) is selected at the boolean field in a moment, and then changed to none selected. ## Question Is the above thing a bug? If it is a bug, when could you fix it? Or if it is not a bug, how should I deal with it? Thank you for your help in advance.
Posted by nito about a year ago
I would like to use multibyte characters for anchor links. Currently, the title of multibyte characters is not reflected in anchor links. Example: page url: https://xxx.xx/docs/page-title section name: ユーザーとは <- I would like to use Japanese ASIS: anchor link: https://xxx.xx/docs/page-title/#section-- TOBE: anchor link: https://xxx.xx/docs/page-title/#section-ユーザーとは When will it be available?
Posted by Yohei Meguro about a year ago
Hi, I'm having an issue with a nested list. 1. Item 1 a. subitem b. subitem On the second level list item, if text wraps around a line, it is displaying like so: c. Engaging: Showcases content which is receiving the most likes, comments, and shares on social media. Instead of like so: c. Engaging: Showcases content which is receiving the most likes, comments, and shares on social media. How can I get it to behave like the second example?
Posted by Steve Suranie about a year ago
For a custom domain to work, are these the steps? 1) put in the custom domain in the readme settings (which seem to have disappeared in the last week, incidentally) 2) setup a CNAME on our side to point the custom domain to ssl.readmessl.com Is that it?
Posted by Hong Kwon about a year ago
Posted by Josh Goldberg about a year ago
The Pricing page (https://readme.io/pricing) specifies the following under "Developer Hub" plan: > Customizable landing page However, on the Dashboard (https://dash.readme.io) it says the following in Documentation->Landing Page >Premium Feature Warning! You'll be able to use this feature free during the trial, however you will have to upgrade to the White Label plan ($399.00/mo) to use it when you publish Which one is it? Thanks
Posted by Ankit Arora about a year ago
Why is opening & editing a Readme.io page so slow? We are getting really discouraged with how long it takes to edit pages in Readme.io. It takes on average 30 to 45 seconds to open a single page. As such, moving from page to page is extremely tedious and painful. Any suggestions?
Posted by Quin Eddy about a year ago