Discussions

Ask a Question
ANSWERED

how can i update my rails api documentation automatically

I want to know if readme.io offers any support to update API documentation automatically in the form of gems or any information regarding it will be welcome Thanks
ANSWERED

Is there a plan to support the null type in OAS 3.1?

One of the [changes from OpenAPI 3.0 to 3.1](https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0) was removing the `nullable` keyword in favor of allowing `type` to be an array, and having `null` as a type there. The places our schema uses this seem to render in the docs unexpectedly, as "nullstring" in the response detail view, and ""Unknown Type: null,string"" in the example response. `null` is not listed in the [docs as a supported data type](https://docs.readme.com/docs/openapi-compatibility-chart#data-types) - is that expected to be added as part of OAS 3.1 support?
ANSWERED

Is there an image libarary—a way to view all the uploaded images in my project?

I want to be able to add an image on a page that functions like a button, where if i click it, it opens a specified topic. I can do this in an HTML macro, but only if I have the image elsewhere on the page, whose path I can identify in Raw text mode. It would be easier if there were a place where i could view a library of images in the project. Is this possible?
ANSWERED

Reference page/section is returning 500 internal server

Hello ReadMe Community, Our reference section is inaccessible due to internal server error being returned by ReadMe. Do we have other Enterprise accounts experiencing the same?

Nav item for Link URL not working?

I've tried editing both the right nav and left nav in Site Navigation, but my Link URL is only showing on the deprecated version page and not the main version page.
ANSWERED

Receipts

how can I find reciepts for me payment

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

How do we upload images in discussions

I'd like to add an image here but dont' see a way to do it without having to add a link (want to be able to drag/upload from local) ![](<>)
ANSWERED

Allow Viewer to download openAPI spec and/or custom postman collection

Is there a way to add a button to download the openAPI spec that is generating the docs?
ANSWERED

Rdme docs sync without version

Hi readme team, I have been syncing docs from a Github repo to our Readme project. We have a set of markdown files which have headers containing category IDs. The sync happens via the following Github action ``` - name: Github Action (API sync) uses: readmeio/[email protected] env: README_API_KEY: ${{ secrets.README_API_KEY }} with: rdme: docs temp --key="$README_API_KEY" --version=v5.2-unstable ``` It would greatly help us if we could remove the version tag (i.e. `--version=v5.2-unstable`) in the Github Action. After all, the category ids are version specific. Is there any way that we could perform this sync without specifying version? Correct me if I'm wrong but I feel like in the past the action could run without the tag, albeit that it created extra files rather than updating existing ones. Even this would be very helpful for us. Thanks in advance