Discussions
Left menu items - ordering
What is the logic used to order the openapi tags in the rendered page? Is there a way to influence the order of the pages in the left menu? I read this: https://docs.readme.com/main/docs/openapi-categories-pages-subpages#tags - but I still don't understand how is the order of the menu in the left defined.
How to fill the Example / Response fields in JSON format for the following information? ENUM / String / Boolean
Site Navigation with versions
We have 2 versions of our product, with correlating documentation. One of them has API Reference and the other does not. I want show API Reference in the Top Navigation bar on Version 1, but not on Version 2. How do I do that?
any api call rate limit
any api call rate limit on the readme apis Lilke 500 request in a min. ?
Try It Out Not Working With Multiple Security Schemes
My OpenApi spec has multiple security schemes (see the example below). When viewing my API documentation, I can only see the first scheme. How do I select which one should be used in my ReadMe documentation?
while uploading a json multipart file in API endpoint causing an exception , Failed to parse multipart servlet request
I have added a parameter as File in body params and content-type:[multipart/form-data], on click on Try it , it is giving me Failed to parse multipart servlet request
Would be great to also draw graphs with a tool like mermaid
Sometimes its necessary to draw a graph in documentation, so it would be great if you could provide something like https://mermaid.js.org/intro/
Rendered code is not working well when using multipart/form-data
Hello
Looking for recommendations for automatic Python API (docstring) to readme.io markdown pages
We host our API documentation on readme (see here: https://docs.edgeimpulse.com/reference). While we use the OpenAPI integration for our REST API, we are also working on generating and hosting Python API documentation for our Python SDK. At the moment, I have been learning and tinkering with sphinx and pydoc-markdown for markdown generation. Neither seems to provide the output required for readme without modifications to their code or some custom add-ons.
Endpoint not found when testing the Personalized Docs Webhook
Hi, I am trying to set the Personalized Docs Webhook for my application.
I added enpoint and served it with ngrok. I tested that endpoint through the Postman and it's giving me correct result. It's working. Here is the CURL:
curl --location --request POST 'https://8407-85-114-46-238.eu.ngrok.io/webhook'
--header 'Content-Type: application/json'
--data-raw '{
"email": "test"
}'