Discussions

Ask a Question
ANSWERED
ANSWERED
ANSWERED

Download a csv or zip file

Is there a way to embed a download link in the documentation?
ANSWERED

Quick and easy way to copy paste into a table

Hi! Just wondering if there is an easy way to copy and paste tables from one document (Word, Spreadsheet) into ReadMe?
ANSWERED

Import GitHub readme file to Readme

Hi Community, As the title suggests I am trying to import my github readme file to ReadMe without manually doing the work, also can they be synced? so if I make any changes in Git can they be reflected in ReadMe ?
ANSWERED

Arbitrary JSON data in API reference

Hi, we have an API endpoint that can take arbitrary JSON in a part of its request body. We tried to express that by using a field with `type: object` and `additionalProperties: true`, and this renders in the API reference as a field where you can add extra fields and give them names and values, but the values are always encoded as strings. So if we type `{ "foo": 2 }` as the value of one of those fields it ends up as `"fieldName": "{ \"foo\": 2}"` in the payload of the request examples. Is there a way to make the API reference UI not encode those values as strings, but just include them as is in the payload?

Filtering "Contacts - Custom Fields Values"

Hi everyone! I'm trying to use API of Active Campaign to get all the "Contacts - Custom Fields Values" but regarding that, the only way to filter for now is by "fieldedid" or "value" of the custom fields, it's impossible for me to do it. Do you know whether there is a way like in"Contacts" to filter by creation or update date? Kind Regards, Daniel
ANSWERED

OpenAPI download and auto-generated SDKs/code

As we look at and evaluate Readme, one feature that seems common with competitors is the ability for the developer user to download the OpenAPI specification, as well as automatically generated code/SDKs in popular languages from the OpenAPI specification. These features don't exist in Readme, correct?
ANSWERED

readOnly properties

Hi, i see that readOnly properties are part of OpenAPI 3.0.3, that you support, but when I use your site they are not handled correctly. Intended behaviour of a readOnly property: 1) not being display in body params 2) being displayed in the response body and in the example same property in editor.swagger.io behaves correctly is there any plan to fix it ? thanks in advance
ANSWERED

GitHub action timed out

Hello, we have our docs set up to sync automatically through a GitHub action. We are attempting to sync these docs to readme from a different repo. However, when we try to run the action, we now see this error: > Error: We're sorry, your upload request timed out. Please try again or split your file up into smaller chunks. > Error: Process completed with exit code 1. This timeout occurs in less time (9s) than our sync takes in the other repo (14s). Is this timeout occurring on your end? And if so, could you please shed some light on what might be causing this change in behavior?