Discussions

Ask a Question
ANSWERED

Feedback

Nothing worse than taking the time to type up a bunch of feedback only to realize the submit ideas forms is broken, so dropping it here instead: 1. (nice to have) Support for content snippets so content blocks can be reused in multiple places. These are similar to the variables but for lengthier content. 2. (critical) Add a self-help troubleshooting/FAQ section without the ability to comment. Or just disable the ability to comment on the discussions tab. The discussion tab is actually somewhat well suited for this except it doesn't have a more prominent search bar and we don't want to allow for discussions because we don't have the manpower to keep up with that. Users will use it for support tickets and we won't be able to answer and stay on top of that. 3. (important) Add a notifications/announcement page/feed. This is great for seeing upcoming API changes before they happen, broadcast planned changes, mention planned downtime, etc. This would be different than just having a custom page in that it can show an unread notification symbol and re-appear when there's a new message (based on user or if not logged in use local storage). 4. (critical) Within Metrics, I don't just want to see the 400/500 errors. I want to see all calls (200 status codes included). The reason this is important is because the quantity of errors is useless in itself if you don't have the context of the amount of total calls are being made. For example one week endpoint /abcxyz may have 100 calls with 10 returning 400 and the next week there can be 50 calls and again 10 returning 400 errors. The error rate doubled but without the context of the calls made you wouldn't be able to tell. This is important to know for improving the docs. 5. (important) Add the ability to pre-populate parameter inputs WITHOUT needing to use defaults. 6. (critical) When you click the "Try It" button, DO NOT clear the parameter values. This has been a pain point for our users. Honestly surprised this hasn't been done yet. With this you'd also want to add a "clear values" button. 7. (important) The landing page could use better, more modern standard components similar to what is used here: <https://docs.opensea.io/>

API Conventions for /api-specification

**GET /api-specification** returns a collection instead of single api and there is no **GET /api-specification/{id}** call. I would expect an **/api-specifications** endpoint to exist and return a collection Would ReadMe be open to adopting the following? **GET /api-specifications** **POST /api-specification** **GET /api-specification/{id}** **DELETE/api-specification/{id}** **PUT /api-specification/{id}** Ref Google's api design guide <https://cloud.google.com/apis/design/>

Try It feature in the API reference

The c# code generator outputs code that contains the line IRestResponse response = client.Execute(request); According to the RestSharp site IRestResponse is deprecated (and in fact appears to be removed from the package) <https://restsharp.dev/v107/#making-requests> Also, it appears that RestRequest no longer takes the method as a parameter.
ANSWERED

Recipe content

Am I correct in my assessment that we can't format the content in a recipe? Including adding links?
ANSWERED

Invalid request for multiple uploads

We have specification for attachments upload api. It allows to upload multiple files. Open API spec is here: <https://github.com/qase-tms/specs/blob/master/paths/attachment.code.yaml#L2> Readme page is here: <https://developers.qase.io/reference/upload-attachment> If client tries to check API in readme docs, readme generates invalid query. Readme tryes to upload files as base64 encoded payload. If we use openapi-generator, we get correct autogenerated code. So we suggest, that our specification is correct. Can you help to make readme docs work correctly?
ANSWERED

How to write in the results description?

![](https://files.readme.io/48df7e3-image.png) I saw several descriptions in documentations on the internet, but I couldn't reproduce this in mine. Does anyone know how?
ANSWERED

HELP! How to restore a deleted page

Hi, I just delete several pages and saved unexpectedly, how could I restore them? thank you so much
ANSWERED

Custom Login Link

It is unclear to me from the info on this page (and linked to from this page) how to get the login link to appear. <https://dash.readme.com/project/core-os-platform/v1.0/custom-login>
ANSWERED

How to export an exhaustive list of topics in the "hub-sidebar" of a particular page in readme?

I need the list of topics (listed in the left panel) in one place for content structuring. I am able to export the entire data and .md files. But I only need the entire content list.

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.