Discussions

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" } } ], '

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?

We have an API endpoint that is documented in OpenAPI as returning an image: ```Text Example "responses": { "200": { "description": "Return an image.", "content": { "image/png": {} } } } ``` The response header is set to `content-type:image/png` but we see garbled binary data in the Response preview underneath the "Try It!" button. Is it possible to configure the Response preview so that the actual image will be shown?

We're about to push some UX updates on our global landing page as well as some CSS to make things like the Page Quality feedback component more prominent. We'd like to do some kind of UX survey to measure user sentiment on the changes. Has anyone done anything like this? I know that we could get a list of users visiting the site, but I'd love to be able to pop up a CTA within ReadMe that would take folks there while they are viewing the docs

Hi, We have been attempting to create a search via JS/Vue that hooks into the API to allow users to search a guide and then link to the particular guide on readme.io. We have attempted to use the search API: <https://docs.readme.com/docs/search-api>. Using our details we can generate results here: <https://docs.readme.com/reference/searchdocs> but when accessing via our external site we run into a CORS issue. A No 'Access-Control-Allow-Origin' header is present. Is there a way around this? Thx Matt

I set up a Raw JSON Input query param as below and tried to call the API from the published page but it returned everything not the ones I specified with query param. https://example.endpoint.com/v1/path?q={"codes":["abc","efg"]} I threw the same API call thru Postman and it did work ok. Any idea?

Hello, I got two simple questions, for which I didn't find the answer in docs nor here: 1. Is it possible to use JS in HTML code for landing page content without resorting to custom HTML/CSS available in enterprise plans only? 2. Is there any preview functionality for a landing page or do I have to test changes directly on production?

Hi, We're using api/v1/docs/search to return docs on a custom page outside of readme (wordpress). We're using 3 readme.io projects, making 3 API calls to return results. The query matching seems to be partial string matches and returns results, can we pass any options to do a full match? For example, if a user searches for 'ab testing', it will return non-ranked results with "About" in the title - picking up the 'ab' out of about? Anyone have luck with this?

Why is "Suggest edits" not visible for pages in the API Reference? There is often a lot of pages handwritten in this section. Please fix ! :)

We are trying to use the custom javascript for our site to hack in some reusable content blocks - theoretically creating a new element that we can add in html content blocks to add the same content to multiple pages. However, the elements don't appear to be added correctly - they don't extend within the pages. Here is the javascript we are trying to add in the Appearance "Custom Javascript" section - am I missing something to make this actually apply to the site script? \` customElements.define('beta-flag', betaFlag); // Re-useable content to beta-flag class betaFlag extends HTMLElement { connectedCallback() { this.innerHTML = ` <blockquote class="callout callout_warn" theme="🚧"><h3 class="callout-heading"><span class="callout-icon">🚧</span><p>Beta Feature</p></h3><p>This feature is available through the Beta program only and is not released for general availability. If you would like to request access to the Beta program, please contact your Account Manager.</p></blockquote>`; } } \`