Discussions

Hello there, Is it possible to use search box as a custom html code? I don't want to use it as a button, I want to embed it to the page and if there is a way, I'll be happy

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

Hi Please do let me know that how can I use API of Readme in my website [Edenderma](https://www.edenderma.com)? I am trying to embed with plugin and also manually embed API references in the header or footer of my website but it's not working. If you have any idea please do let me know. Thank You

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