Discussions

Ask a Question
ANSWERED

200 sample response not showing in endpoint

I have a swagger 2.0 definition, which seems to get transformed to openapi 3 in readme. Within this definition, some endpoints show the 200 sample response at the right hand side of the page (below the call console), and some others don't show any sample response. I compared the paths between endpoints and they seem to be equal. The only difference between these endpoints is that one path/response points to a schema with required params, while the other pointed schema doesn't have required params (although, if I change that it doesn't seem to have an effect). Here is a definition for checking: https://flex-trial.readme.io/openapi/617b34c5fa41cb078f0f4bf1 This endpoint doesn't have sample response: https://flex-trial.readme.io/v2.0/reference/getconversations This one does: https://flex-trial.readme.io/v2.0/reference/getcontacts Is there any clue on why readme is not picking up the responses?
ANSWERED

How to add font-awesome icons or similar items into a cell in a table?

I want to add a checkmark into a table. Can someone point me to an example how to do so? Thank you!
ANSWERED

Table overflow on page

Hello all, I am creating a page describing the fields of an object in a table, but the table breaks the size of the page. It seems quite similar to this [discussion](https://docs.readme.com/discuss/609272f7d6033f0043924f79), for which the solution was to add CSS to the Custom Stylesheet section of the project. Sounds great! However, this option is not part of our current plan, and upgrading it is not suitable for us at the moment... Since this is mentioned as a tracked bug on readme side in the above discussion link, would it be possible to add this CSS code to our projects? Thanks a lot in advance! Romain
ANSWERED

How do I insert callouts into tables?

Hello everyone, checking to see if anyone knows how to insert callouts into tables, haven't been able to crack this just yet. Thank you!
ANSWERED

Custom Login apiKey Cutoff problem

https://docs.readme.com/docs/custom-login-with-readme Hi readme team. We use Auth0 behind the scenes for login and when we send the apiKey (4731 characters long) it gets cutoff in the readme API explorer. Is there a solution for this problem?
ANSWERED

Export and import Recipes

Is it possible to export existing recipes and import them?
ANSWERED

Get OAS of specific version of API specification?

Hello, It says [here](https://docs.readme.com/reference/intro-to-the-readme-api#api-specification) that the "API Specification" endpoints can be used "to get, post, update, or delete the API specification that generates your API docs." But the only GET request I see for that endpoint is for the specification metadata. Am I missing something, or is it not currently possible to GET the OAS of a particular version of one's API spec from ReadMe via the API? Like, the JSON that got uploaded when creating a new version. Thank you. Zeke (Capable Health)
ANSWERED

Automated deployment of additional information for OpenAPI schema

Hi, I have the problem that I want to deploy a lot of OpenAPI schemas to readme. However these are not just standard schemas, but I would like to add custom annotations in html or markdown to each of the routes. This works nicely if I do it manually, but I need to do this in an automated way and I did not find a way to do it. Is there already an API to do so? If not it would be awesome to add it! Maybe the nicest way to do it would be to accept an extension field in the API spec JSON which can contain html and another for markdown.
ANSWERED

Dark mode support

We were thinking to migrate to Readme and because our previous system has dark mode support, we were thinking if this is planned. Developers staring at night on a bright documentation is something very unpleasant.
ANSWERED