Discussions

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

In my OAS 3.0 spec, I have a number of oneOf's specified. They render in Readme.com as pulldowns, with the first object defined in the oneOf block selected, and its schema displayed. When a different selection is made in the pulldown, I would expect that the pulldown updates its value, and the schema for the previous selection is replaced by the schema for the new selection. However, this is not occurring. What is the expected behavior when a new selection is made in a pulldown? If the pulldown is supposed to update and the schema for the new selection is supposed to replace the old selection's schema in the display, is there an example spec I can review to see what I may be missing in my spec? Thanks!

Slack integration works for suggested edits but will not send notifications for Discussion questions. Any thoughts on how to fix this?

I'm getting this validation error: ``` The spec you uploaded has validation errors that must be addressed. Here's what we found: Validation failed. /paths/authentication-settings/saml-metadata-upload/put has a file parameter, so it must consume multipart/form-data or application/x-www-form-urlencoded ``` I tried validating my spec against the json schema for swagger 2 from here : https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v2.0/schema.json and it validated successfully. So my question is what extra validation does readme.com does on swagger spec?

trying to import a URL and got this error: ``` Swagger schema validation failed. Data does not match any schemas from 'anyOf' at #/definitions/ResponseListWebhookAction/properties/data/items Array items are not unique (indexes 0 and 22) at #/definitions/ResponseListWebhookAction/properties/data/items/enum Expected type array but found type object at #/definitions/ResponseListWebhookAction/properties/data/items JSON_OBJECT_VALIDATION_FAILED ``` File URL is https://app.harness.io/gateway/pipeline/api/swagger.json

Recently users have been complaining that some of the examples from the documentation are not working. Previously when a file was attached to the payload (multipart/form-data), it was attached the following way: curl -X POST "https://api.emysound.com/api/v1/Tracks" -H "accept: application/json" -F "file=@do_not_go.wav;type=audio/x-wav" Since latest updates, it attaches it the following way: curl --request POST \ --url https://api.emysound.com/api/v1/Tracks \ --header 'Accept: application/json' \ --header 'Content-Type: multipart/form-data; boundary=---011000010111000001101001' \ --form MediaType=Audio \ --form 'file=data:audio/x-wav;name=do_not_go.wav;base64 <ENTIRE BASE 64 OF THE FILE> The difference is in the file form: Previous: --form "file=@do_not_go.wav;type=audio/x-wav" Right now: --form "file=data:audio/x-wav;name=do_not_go.wav;base64 <ENTIRE BASE 64 OF THE FILE>" Notice how it attaches base64 on the entire file which triggers errors on the server side since no base64 payload is expected, rather path to the file. Is there any way to enable back previous behavior?

I wonder is it possible to enable some sort of authentication to the site that is generated by readme? I would like to hide the api information from public user and only show it to some internall group.

In a page of the Guides section, if I want to create a navigational link that jumps to a bookmark or anchor in the same page, is there any quick way to do this other than writing one or more HTML blocks? For example, if I add an HTML block I can use a href="#bookmark" target="_self" and then later on in the page I can have another HTML block with a name="bookmark". This seems to work ok, it but it seems like a lot of extra work and in the rendered page, the styling of the HTML text doesn't match the default styling of other text on the page created using markdown. I've checked a markdown syntax guide, but I don't see anything about anchors/bookmarks. Thanks in advance for any guidance or suggestions. :)

Hi there, so we're working hard to port our API spec (currently in redoc) to ReadMe (to make use of the new API reference section). However, I can't find any information on whether or not you allow the discriminator in the request body? We have a situation that depending on a given parameter selected, the user needs to send different fields. In redocly they have a cool drop-down menu that you select and then the required fields are displayed depending on what you have selected. Is there something similar in ReadMe? Cheers, Dom