Discussions

What tools are people using to validate their OpenAPI specs before uploading? I have a spec that's considered valid by two separate tools but is being rejected when I upload to Readme. The error is useless: "Unknown error (Cannot read property 'slug' of null)." Ideally there is a tool out there which matches ReadMe's quirks so I can develop my APIs locally and know that when I push the code I will also be able to push the API updates.

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?

Hi I just want to add a open form on my skincare website, so that I can track record of chat of customers through this So please do let me know that how can it be possible? Thank You

I am uploading an OpenAPI specification to the UI that has oneOf options: ``` CompanyInfoField: oneOf: - "$ref": "#/components/schemas/company_name" - "$ref": "#/components/schemas/industry" company_name: type: object description: The name of the company owning the domain industry: type: object description: 'Example: technology' ``` The intended encoding of the schema above (which is correct in Redoc and Swagger) is a list of the oneOf options: ``` [ "company_name", "industry" ] ``` However, in the readme.io UI, it interprets it as a key-value pair. The UI also does not display a list or dropdown of the oneOf options - instead it presents a box for "New Key" and a box for "New Value", even though the options (like company_name) do not have sub-properties in the OpenAPI specification. ``` [ { "newKey": "xxxx" } ] ``` I'm also encountering issues with a second oneOf schema for OpenAPI: ``` DomainSource: oneOf: - "$ref": "#/components/schemas/portfolio" - "$ref": "#/components/schemas/url_list" portfolio: required: - portfolio_id type: object properties: portfolio_id: type: string description: Portfolio UUID ``` The expected encoding of the above example is (which is correct in Swagger and Redoc): ``` "portfolio": { "portfolio_id": "00000000-0000-0000-0000-000000000000" } ``` However, in the readme.io UI, the encoding is instead just the following, which appears under a dropdown under "Option 1". In addition to "Option 1" not rendering the `portfolio` name at all, "Option 1" also changes the intended encoding by erasing the `portfolio` part of the schema (and just encoding the schema under it) ``` "portfolio_id": "00000000-0000-0000-0000-000000000000" ```

Hello, I am very new to readme, and am trying to add a link to a specific word like "Sign up here", and "here" being a link. Is this possible? Appreciate the help. Omar

We're trying to track the percentage of users (if any) are viewing our ReadMe site on mobile and tablet devices. Does ReadMe track this or do I need to look to a Google Analytics integration?

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?

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".

Is it possible to set it up so that readers can send requests to my API and receive results?

Firstly, I'm confused by your conflicting instructions. On the glossary management page in my account (/v1.0/glossary-definitions), the page description reads: "To use, type <<glossary:phrase>> in your documentation" It doesn't say anything about case sensitivity, so I was surprised to discover recently that when a term entered as "Withdrawal" is referenced in a doc as <<glossary:withdrawal>>, it is omitted from the customer view of the page. Then I came across this example [in the documentation](https://rdmd.readme.io/docs/features#glossary-terms): Both **GLOSSARY:EXOGENOUS** and **GLOSSARY:ENDOGENOUS** are long words. Which displays the words in lowercase. Great! However, when I tried that myself, using **GLOSSARY:MAINNET** in a doc, in the hope of it retrieving my definition for <<glossary:mainnet>>, it shows up as: "The functionality described on this page is not yet available on GLOSSARY:MAINNET." Do I have to create duplicate glossary entries to accommodate both upper and lowercase usage of the term?