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
I find the base colour scheme of light grey on white difficult to read, especially in the sidebar. Yes, I can change the scheme in my project, but it's not great for things like the knowledge base. Are there plans to make available a higher contrast scheme that's easier for people older the Millennials to read?
Posted by Owen 2 years ago
Has anyone seen a change recently where saved changes don't apply right away- even with a cleared session cookie and hard refreshes, simple changes take a minute or two to show up, so it's not clear if a change was made successfully at first?
Posted by Matt Prytuluk 2 years ago
Hello everyone! I'm new to readme.io and as a french company we need to make our docs as understandable as possible for **french users** - *that is to say, with a very bad english level*. One of our issues is the changelog tags : *improved*, *fixed*, *known issues*. **Does anyone know how to change the text of these tags ?** (*ie* "improved" => "corrigé"). Thaaaaaanks Benjamin
Posted by Benjamin Waterlot 2 years ago
Is there a way to see more dynamic search results on my Docs? This is the search in the right top corner that gives results as you type. Currently it shows 3 results with a link to view more. I can't figure out where to modify it so it shows more, like 8 or so would be great.
Posted by Colin 2 years ago
I import API thru swagger url in readme reference section and want to disable the "Try it" button with the sample code. Is there a way to disable it? I tried set swagger extension value "x-samples-enabled: false" (I tried to add it in info section, paths, or operation parameters in swagger 2.0 file at a time) as described in swagger extensions (https://readme.readme.io/docs/swagger-extensions), but it still can't disable it. Please let me know if you need more information
Posted by Linc Global 2 years ago
Hello, Some of my API endpoints correspond to "List" actions and return a JSON array of records. I think this is a pretty common pattern. I'm trying to get my API Explorer / reference section to communicate this to the user. Ideally, It would show that the response is an array and then give the structure of a single element. Instead, it displays nothing at all. The definition I'm using is pretty simple: clientList: type: array items: "$ref": "#/definitions/client" My site is here if it's helpful: https://liquidplanner.readme.io/v1.0/reference Anything I can do to get this to display properly? Thanks!
Posted by Josh Gross 2 years ago
Posted by Joseph Casey 2 years ago
When I specify two different auth options for the same endpoint: ``` post: tags: - Client summary: clients produces: - application/json security: - Bearer:  - basicAuth:  ``` The "Try It" feature requires *both* types of authentication to be filled out before it will even issue the request. The Swagger 2.0 spec states that this syntax is an OR: https://swagger.io/docs/specification/2-0/authentication/ (under Using Multiple Authentication Types) Is there a way to get ReadMe.io to only require one or the other auth methods?
Posted by Josh Gross 2 years ago