Discussions
Error submitting form after updating a page
When I update a Guide page, I get a message that says error submitting form. This happens after entering text and clicking the Save to Staging button. The page that I am working on is quite large with many tables. Do you have any ideas why I am getting this error and what I can do?
Posted by Ken Davies over 1 year ago
Is there a plan to support webhooks in OAS 3.1?
We'd love to be able to upload our webhooks specifications to ReadMe. Are there plans to support it? Any suggested alternatives in the meantime besides creating custom pages?
Posted by Hannah Horobin over 1 year ago
Moving conent around
Is it possible to make an existing page a subpage of another existing page?
Posted by Don Glover almost 2 years ago
How to recreate the reference getting started page?
I really like the Getting Started page here when you go to the API Reference:
<https://docs.readme.com/reference/introduction>
1. How can I recreate those Pick a language, Authenticate, Try it sections?
2. How to recreate the blue "Get API Key" button in the authentication form?
3. When you view an endpoint, how to recreate that "Log in to use your API keys" text/link?
Posted by Hanni almost 2 years ago
Editor woes
It appears that legacy editor no longer saves content correctly (or sometimes at all)
Then new editor freezes when trying to change the type of a code block.
Did you bother testing any of this?
Posted by Don Glover almost 2 years ago
Is it possible to make categories expandable?
Our left-hand navigation is getting quite long. Is it possible to make a category retractable and expandable so that users only see the category name until they choose to expand it?
Posted by [email protected] almost 2 years ago
Can I recover a documentation page within API Reference?
I see how to use Page History within Guides to recover content, but have found no way to recover a deleted documentation page with the API Reference section.
Posted by Lisa Wood almost 2 years ago
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/>
Posted by hanniabu almost 2 years ago
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/>
Posted by Gage Miller almost 2 years ago
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.
Posted by Don Glover almost 2 years ago