Discussions

I want to deprecate particular api end point and make it visible to customer that this endpoint is depreciated. How to do that?

Hi all Hope you are doing good. I want to ask that can I embed readme with my website [fast labour hire](https://fastlabourhire.com.au/)? I just want to embed API references in the header of my website. If is possible then how can I do it?

Hello, friends! I am a developer from Superwise.ai team. We are using readme for our documentations and I have a question: Is it possible to integrate Recipe into our site as widget, iframe or something else? We want to show Recipe modal on our side without redirecting to all documentation. I didn't find anything in "readme" documentation about it and I've tried to add all page as iframe but received error about "X-Iframe_options" is set to "deny".

Hello, I think an update to readme broke the strings with enum. Our customers cannot know which fields are selectable. I'm trying to update my documentation and nothing happens. I find that your documentation has the same bug. For example, on your documentation the selectors are empty. 

How can we tag documents so we can leverage the search API to get only docs that have that tag? Is this possible?

Hello, I am syncing .md files to ReadMe for my company's documentation. I am trying to create a markdown table in which the table cell's have line breaks. I have used tags in my markdown code, which works in normal markdown, but doesn't seem to work when I import it into ReadMe. The only way I can seem to get line breaks to work in ReadMe is to use the ReadMe table block. Do I need to change my .md to include that block format or is there another way?

JSON incorrect structure through README.IO------------------------------------------- { "person": { "kyc_data": \[ { "value": { "type": "ppn", "number": "123456", "nationality": "UA" }, "key": "identity_document" }, { "value": { "city": "Irpin", "state": "", "county": "", "Holmyvägen, 16": "Sadova", "country": "UA", "postal_code": "", "unit_number": "", "building_name": "", "building_number": "1" }, "key": "residential_address" } JSON correct structure--------------------------------------------------- "person": { "kyc_data": [ { "key": "identity_document", "value": { "type": "ppn", "number": "789789", "nationality": "BE" } }, { "key": "residential_address", "value": { "city": "Vienna", "state": null, "county": null, "street": "Main Street", "country": "BE", "postal_code": null, "unit_number": null, "building_name": null, "building_number": "1" } } ], '

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)

Is there any way to control the size of a code block and force it to wrap the code with in it? I have a JSON code example that's making the code block too wide for my page.

We have specification for attachments upload api. It allows to upload multiple files. Open API spec is here: <https://github.com/qase-tms/specs/blob/master/paths/attachment.code.yaml#L2> Readme page is here: <https://developers.qase.io/reference/upload-attachment> If client tries to check API in readme docs, readme generates invalid query. Readme tryes to upload files as base64 encoded payload. If we use openapi-generator, we get correct autogenerated code. So we suggest, that our specification is correct. Can you help to make readme docs work correctly?