Posted by Denis Hoctor 2 years ago
I would like to include multiple request body examples with some comments in the reference API, since readme.io does not support OAS 3 yet, its clunky to try to sqeeze these into swagger I can easily monkey type them by manually adding markdown to the site, but that's honestly a recipe for disaster - any plans supporting OAS 3 specifically around `examples`? - any plans to support anything but monkey typing e.g. API or even better `x-...` parameters? Basically anything but manually typing into reference API?
Posted by Jiri Novak 2 years ago
We have about 100 API methods in our docs. All of them with good description and examples of request/response. When I open the documentation page it freezes my browser for about 30-60 seconds. Because it tries to load all the docs with all their contents at one page. My PC is quite strong, so it's not a problem my computer definitely. Do you have any recommendations how the docs could be optimised to be loaded faster?
Posted by Ilya Savinkov 2 years ago
Is there any way to move the response display section on the right side to under the query params section? Similar to how Lyft does it: https://developer.lyft.com/v1/reference#section-201-success-response-schema Thanks.
Posted by Ross Murphy 2 years ago
Hello, Is there a way to create numbered lists using MarkDown where the items are automatically numbered properly? In some Markdown Parsers, doing 1. Item 1 1. Item 2 1. Item 3 is displayed as 1. Item 1 2. Item 2 3. Item 3 Which is very convenient for long lists where you introduce items in the middle often. Any solution to that? Best, Bastien
Posted by Bastien 2 years ago
Hi there, I'm importing our API spec from a generated swagger file into Readme.io, but every time I sync with my spec file, it adds extra sections for each path despite those paths appearing under other groups (tags in the swagger file). All of the documentation for the endpoints looks good under each group, but I end up having to delete these empty sections (each of them has a path as its title) manually. Any help would be much appreciated.
Posted by Joey Triska 2 years ago
We are running a multi-tenancy API, which provides a different endpoint to each of our customers. In this case, our customers should be able to use their own API endpoint when "trying it" in the API documentation part. There should be a way for them to go to their specific endpoint. Is there a workaround at the moment or does anybody else have that request as well?
Posted by Tobias Knecht 2 years ago
Hey guys, I love readme.io, and basically my company is moving most of our current documentation to readme.io. However, we roll out fairly frequent API updates, and I don't want to risk someone forgetting to come in and hit the 'resync' button for the new swagger docs. Is there an API i can hit to make it happen automatically? Or a way for me to set it up so that it automatically pulls the swagger doc? Any thoughts or solutions are welcome.
Posted by Paras Shah 2 years ago
In my swagger file, I have not added the Content-Type header to any endpoints that use the GET method. However, when I call these endpoints using the "Try It" feature in Readme.io, I get a 500 error message and a Content-Type header appears in the metadata for each API call. I am almost certain that this extra header is causing the error. Can someone please help me solve this issue? My documentation is found at https://cleverbridge-commerce-api.readme.io/. Thanks, Andrew
Posted by Technical Communication 2 years ago
Hi all I've added new APIs to reference document using swagger. but when click button try it , it returns error 500 internal server error. all response values are empty https://myfatoorahapp.readme.io/v1.0/reference#paygatewayservicev2soap12
Posted by Nadir S Firfire 2 years ago
I have a project I don't want to launch to the public quite yet, but I want to share it just with certain people. One option is to make the project not crawlable and just share the domain with people I want to, but can I use some sort of a shareable link without publishing the whole project? Thanks!
Posted by Billy Kovalsky 2 years ago
One of the reasons I prefer documentation in one big file (as opposed to a bunch of little HTML files) is I can search it easily. Fortunately readme.io includes a very capable search function. With one exception: it can't do regular expressions (also kknow as a "regexp".) For example, with regexps I can search on "gr[ae]y" to look for "gray" or "grey." I can search on "\bfail\b" to avoid getting results that include "failing" or "failed." I can search for "(SSL|TLS)" to get results for either SSL or TLS, or "(MySQL|MariaDB)". I can search for "^[[:space:]]When.*something" to look for text that starts with "When" and also has "something" in the line. The ability so search using regular expressions has saved me a lot of time searching through large documentation sets like the MySQL docs. If this is better done as a feature request, I'll post it there.
Posted by Owen 2 years ago