Discussions

Ask a Question
ANSWERED

Array property items with oneOf $ref lists supported?

I have a OpenAPI definition that renders as expected when using another openapi viewer called StopLight . I'm trying to load this yml file to our readme site and am encountering an issue with the UI not rendering correctly for array properties using oneOf with $ref's. The property in question is defined like the following: `. configuration_options: type: array description: List of configuration options to present to users when they configure your adapter. The values the user entered for these configuration options will included in the payload send to your webhook_url when your adapter is invoked. items: oneOf: - $ref: "#/components/schemas/StringConfigurationOption" - $ref: "#/components/schemas/RegExConfigurationOption" - $ref: "#/components/schemas/PasswordConfigurationOption"` The UI that is generated for this property does not render the item references correctly. It renders the array portion ok, offering the Add button with a panel for each valid schema allowed for the configuration_options array, but it does not correctly render the shape of each of these schemas if you click to add one. It renders the description but does not display the shape of the ref'ed schema. It simply shows an "Add Field" panel that allows the user to add a key/value rather than the actual defined schema properties. Below is an abbreviated sample of what the StringConfigurationOption looks like (and it's abstract parent): `AbstractConfigurationOption: type: object description: A single UI component that the user will utilize to enter any configuration values that your adapter will require to function. properties: name: type: string description: The name of the configuration option that will be passed to your webhook. example: client_code label: type: string description: The name of the option that will be displayed to the user. ` `StringConfigurationOption: title: StringConfigurationOption type: object description: A UI component that accepts string user input. allOf: - $ref: "#/components/schemas/AbstractConfigurationOption" - type: object properties: config_type: type: string enum: [ string ]`
ANSWERED

How to add Headings in Table of contents from custom HTML in markdown

1. I have created a new page in Guide. 2. I used '/Custom HTML' block and added a h4 tag in the HTML. 3. How can I get this heading to appear in 'Table of contents'
ANSWERED

How to track search events?

Hi - i have implemented the Segment integration and I am surprised not to see search events being sent to segment. Unless I missed something or I am the only one interested in such data, I was wondering if there was a plan to add such events to the segment integration. I am interested in sending search events to destinations: - [AnyTrack attribution platform](https://anytrack.io) - [Hubspot](https://hubspot.com)
ANSWERED

Getting "local issuer certificate" error

When I run the command to upload a new file (or even a simple command such as npx rdm version --key=), I get the following message: request to <https://dash.readme.com/api/v1/version/v2023.1.4> failed, reason: unable to get local issuer certificate. I saw some suggestions about turning off strict SSL checking, but that didn't work. Any ideas?
ANSWERED

Can I programmatically embed recipes?

Our company currently syncs the content of our ReadMe docs from a Git repository using the `rdme` client. Is there a way to embed our recipes in our markdown files programmatically so developers do not have to go into the readme UI to add recipes? Doc: <https://docs.readme.com/main/docs/recipes#embed-into-relevant-endpoints>
ANSWERED

when adding a few code snippets in a doc, can the user select automatically the same coding language in all snippets?

```c blabla ``` ```java kjcdhc ``` ```c bfndghhgm ``` ```java lkjjln ``` so it will look like these snippets in sync of the language
ANSWERED

Multiple changelogs?

Hello, we want multiple separate changelogs for each of our SDKs. They need to be completely separate pages. Is it possible to do that with GitHub Actions in connection with the Update Changelog endpoint in the ReadMe API?
ANSWERED

Sync Docs to GitHub When Making Edits in ReadMe

Is there a way to connect our product Doc markdown files to GitHub when we make edits in the ReadMe platform? Our team wants to ensure we have records in multiple places and I am having trouble figuring out how to set it up?
ANSWERED

Discussion Tags

Can an end-user non-admin add a tag to their questions?
ANSWERED

Bug: page title double encoding

If I use an apostrophe in the title in a guide page metadata, it turns into ' in the browser tab title on the guide public page. It happens because the title is HTML-escaped 2 times, therefore I get the result of the first escaping in the browser tab.