Discussions
Using the ReadMe Explorer for Private APIs
Hi,
We are planning to use ReadMe for our API Documentation and API Explorer. Our API's are private in nature. IP Address is needed for someone to access the API as they are whitelisted in our Route53/Cloudflate.
We have following questions
1. Does all the calls from the API Reference (API Explorer) go through the proxy server (try.readme.io) ?
2. Does the above scenario work where we can whitelist ReadMe.io server IP on our end and only the ReadMe users can access the API Explorer?
3. What things does ReadMe takeup on preventing DDOS attacks etc?. Any Rate Limiting , maximum number of users who can access the Api explorer at the same time ?
Would love to have references to documentation if this is covered already.
Posted by Kumar almost 2 years ago
Link validation
Is there a link validation tool availble in Readme?
Posted by Don Glover almost 2 years ago
Updating API specification doesn't work
I am doing a PUT request, tried both with a JSON and YAML, I'm getting a 503 error.
The tried specifications are valid.
`curl -X PUT -T "openapi/spec301.json" -u "$README_KEY:" "https://dash.readme.com/api/v1/api-specification/$SPEC_ID"`
Response:
```html html
<!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.com/error"></iframe>
</body>
</html>
```
Posted by Marcin Szle almost 2 years ago
Slow loading endpoints
Hello there.
I have the following issue..
L5 swagger openapi endpoints imported into readme via file load very slow.
My question is does the file size matter, because when smaller sized file is imported every endpoint loads fast. And if the larger file is imported the endpoints load too slow?
Thank you in advance !
Posted by Deivid Handzhiev almost 2 years ago
Sharing content in a toc
Is it possible to share a topic in more than one node (ie have it as sub page in more than one location)?
OR
Is it possible to embed shared content in to a page so that we have one source of truth for identical content blocks?
Posted by Don Glover almost 2 years ago
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?
Posted by Andrew Tutoveanu about 2 years ago
PR into preview?
Is it possible to have a PR auto-generate a preview app in Readme? I know merging can automatically make updates to the site, but I'd love a way to preview a change before it hits production.
Posted by Scott McClellan about 2 years ago
How to change position of "Did this page help you?" and make it sticky or fixed so it's always in the viewport?
Posted by Unmesh about 2 years ago
Is it possible to pass a list of objects to choose from to a field in readme?
It'd be nice to give my users a dropdown selector for ID instead of forcing them to copy paste from our service.
I could pass a big list of values to README when the customer logs in, and that could populate the dropdowns.
Posted by Andrew Roberts about 2 years ago
Can we link the two different contents on the same URL page?
Can we link the two different contents on the same URL page with each other?
Posted by Surya about 2 years ago