Discussions

Ask a Question
ANSWERED

Syncing via CLI: "Path `category` is required."

Hi there! I'm trying to sync a folder of markdown guides up to Readme. My documents all have the [required header](https://docs.readme.com/docs/importing-documentation#expected-file-format) (title, excerpt) and are otherwise plain markdown in a flat directory structure (ie. they're all in one folder with no subfolders). ``` $ npx rdme docs docs/guides --key={MY_KEY} --version=1.0 > We couldn't save this doc (Path `category` is required.). ``` I'm not really sure what that error message means... Where should I put a category? Should they be in a particular subdirectory?
ANSWERED

How can we render a multipart request correctly?

Today we have the following request: ```curl curl --request POST \ --url http://{host} \ --header 'Content-Type: multipart/form-data' \ --header 'Authorization: Bearer <TOKEN>' \ --form ' service={ "id": "svc12345", "sourceType": "my-alerting-solution", "sourceInstance": "my-company", "name": "my-service", "description": "The one and only service with 110% uptime", "data": { "number_of_incidents": "2", "monitoring_dashboard": "https://my-company.my-alerting-solution.com/my-service" } };type=application/json' --form 'bom=@<file>' ``` But when we see it on Readme it's rendered like this: ![](https://files.readme.io/50eb4c7-Screenshot_2022-10-14_at_12.22.50.png) Is there a way to render it like this and not as a form: ![](https://files.readme.io/0efe8e6-Screenshot_2022-10-14_at_12.25.19.png) Thanks
ANSWERED
ANSWERED

Moving a page to a newer version

Hi. Novice user here. I created a new page in a live version of our guide and then made that new page live, not realizing that another editor had already branched a new draft version. Several days later that draft was published, thus removing my new page from our live site. My question is how do I move that page to the new version? I can see that dragging and dropping the page within the old version is easy, but I can't seem to drag it into the new version and republish it live. Do I have to recreate the page in its entirely or is there a way to drag or clone it to the currently live version? Thank you,.
ANSWERED
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?
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

Bearer Authentication

Hey folks - How do I configure readme to show the Bearer token like in these docs (docs.clover.com)? I want it to show Bearer and then fill out the header as the user types in the token. [block:image] { "images": [ { "image": [ "https://files.readme.io/2490a71-image.png", "undefined" ], "caption": "", "sizing": "undefined" } ] } [/block]

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