Discussions

Ask a Question
ANSWERED

readOnly properties

Hi, i see that readOnly properties are part of OpenAPI 3.0.3, that you support, but when I use your site they are not handled correctly. Intended behaviour of a readOnly property: 1) not being display in body params 2) being displayed in the response body and in the example same property in editor.swagger.io behaves correctly is there any plan to fix it ? thanks in advance
ANSWERED

File Attachments?

Is there a way to embed a file for downloading? - Im trying to attach data dictionaries that are easier to distribute in Excel - and I want to leave a link in there - but I still want to have it secured behind the login.
ANSWERED

Is it possible to disable discussions?

ANSWERED

create tabs with boards inside

is it possible to create tabs with tables inside in the startup plan? ie without using css and javascript.
ANSWERED

Image upload not working in new ReadMe Markdown

Steps to reproduce: 1. Edit guide page 2. Insert image block 3. Attempt to upload image from local drive Expected behavior: image successfully uploads Actual behavior: either nothing happens or the uploading progress wheel appears briefly and then disappears without image uploading successfully. No error message is given.
ANSWERED

Is there a way to create multiple API endpoints with the same HTTP method and path?

In this doc: <https://docs.readme.com/docs/additional-api-settings#section-add-your-endpoints-and-parameters> It says there is a naming limitation: **Please note that due to some current limitations in our API explorer, we currently do not support the creation of multiple API endpoint pages for the same HTTP method and path.** Is there a way around this? How do other clients typically handle this using readme.io? In our use case, we are using the same HTTP Method and Path however the body request is different.
ANSWERED
ANSWERED

Is there a depth limit to API documentation of nested objects in a response?

Hello, Is there a depth limit to what the documentation displays as nested fields in a response schema? We seem to only be able to get a certain depth for our response schemas and our clients are not able to access information on our entire schema response. Example We have a response that follows this structure: ```json { "foo": { "bar": { "baz": [ { "hello": "world" } ] } } } ``` yet in our API reference our clients can only see `foo.bar.baz` with its description but we can not see `foo.bar.baz[].hello` or any other fields within this list. Is this a limitation? Are we doing something wrong? Would like feedback. Thank you! Kyle
ANSWERED

Looking for an easy way to insert an image into a list (ol or ul) without breaking the list in html

I am using a numbered list for describing a step by step procedure, and I need to include an image, for example in step 2, like this: 1. Step 1 2. Step 2 image in step 2 3. Step 3 How can I do this in the "Guide" part of Readme?. The GUI seems to allows to include images either before or after a list. Thank you.
ANSWERED

Allow Viewer to download openAPI spec and/or custom postman collection

Is there a way to add a button to download the openAPI spec that is generating the docs?