Discussions

Ask a Question
ANSWERED

How we can get the List of all docs?

Hi Is there any api to get all the docs with pagination? Please suggest I tried to fetch all my docs by post api> doc search <https://docs.readme.com/main/reference/searchdocs>

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? When I remove the API Reference link on dash.readme.com/project/\<project_name>/v1.0/usability, it is also removed from dash.readme.com/project/\<project_name>/v2.0/usability. I would expect separate behavior, since the version number is in the URL.
ANSWERED

Is there a way to define custom headers/parameters to be shared across all endpoints/paths in a given JSON?

I have a use case in hand where I have some custom headers that should be **shared across all the described endpoint paths** in a given JSON. Is it possible to define those header parameters **globally** for a particular API JSON?

any api call rate limit

any api call rate limit on the readme apis Lilke 500 request in a min. ?
ANSWERED

Is there a way to add a read only user?

We would like some users to have read only access, but without knowing the password of the site. Is this possible?

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? ``` securitySchemes: apigee_security: type: apiKey name: x-orgid in: header bearer: type: apiKey name: Authorization in: header ```
ANSWERED

Getting error "type must be array" while uploading Swagger file

Hi, While uploading the Swagger ".json" file on readme.io, I'm facing the below error: [block:image] { "images": [ { "image": [ "https://files.readme.io/448b0ca-image.png", null, null ], "align": "center" } ] } [/block] Relevant JSON block from the Swagger file: ``` "getProductInventorySnapshot": { "type": "object", "properties": { "sku": { "required": true, "type": "string", "example": "TEST-750" }, "upc": { "type": "integer", "example": "816136021655" } } } ``` Based on the requirements, that parameter has to be the "string" type but the error is saying to change it to an array. I'm not sure why. Also, there are already other end-point having params with with "string" type and there is no issue with that. Any help would be appreciated. Thanks

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 ``` ``` ``` ```
ANSWERED

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/>