Ask a Question

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

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

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

Does it support LaTex or any other math visualisation?

I was trying to figure out how to embed/type Latex. Most markdown readers/editors allow for Latex. However, this does not seem to be the case. Any idea if this is possible yet?

AsyncAPI support

does readme support AsyncAPI specification ?

Rendered code is not working well for a nullable object

Hello I'm using OpenAPI 3.0 I have a **nullable **object `reminder_settings` wich is composed of 2 fields that are required **if **reminder_setting is set So you can call the endpoint without having to set reminder_settings. But if you do so, you have to fill the 2 fields (`interval_in_days` and `max_occurrences`) - `interval_in_days` is an enum - `max_occurrences`is integer ![](https://files.readme.io/46933af-image.png) When i load my documentation page, generated code is not working well since it already fills `interval_in_days` whereas it shouldn't because the `reminder_settings` is nullable. And since both fields must be filled when `reminder_settings`is created it throws an error ![](https://files.readme.io/517e45b-image.png) ![](https://files.readme.io/0643fda-image.png) Expected behavior: the `reminder_settings`json should not be present by default on generated code since it's nullable How can i fix my problem ? Thank you

Rendered code is not working well when using multipart/form-data

Hello I face an issue when using multipart/form-data and object in body. Here is snapshot of current openapi 3.0 ![](https://files.readme.io/f430275-image.png) The problem is with `initials` and its content: `alignment` and` y` In documentation generated code looks like this: ![](https://files.readme.io/9957dc7-image.png) In shell generated, we can see `--form alignment=hello --form y=10` Whereas i would expect `--form initials[alignment]=hello --form initials[y]=10` When using `application/json` instead of `multipart/form-data `is works very well, so i'm assuming this is a generation code problem related to `multipart/form-data`. Within the same endpoint i'm also upload a file so i need to keep `multipart/form-data` You can see our public doc here: <https://developers.yousign.com/reference/post-signature_requests-signaturerequestid-documents> Could you help me one this one, or tell me when this will be fixed ? Thanks