Discussions

Ask a Question
ANSWERED

Multiple Security Schemes not showing up when uploading Swagger or Open API Spec

I'm trialing Readme for potentially utilizing for our developer documentation and dev portal. I have attempted to upload several different versions of my spec that have two different values being passed in as headers. However when I go to the portal it makes me select one or the other but doesn't allow me to pass both which is required. <br /> ``` token: type: "apiKey" name: "token" in: "header" api_key: type: "apiKey" name: "x-api-key" in: "header" ``` If I view the same spec in swagger editor I see below and it lets me pass both. ![](https://files.readme.io/356017f-image.png) How would I accomplish this in readme?
ANSWERED

application/pdf API response content-type

We have an API which responses with PDF binary data using content-type application/pdf and content-disposition: inline; readme.io is displaying the resulting binary as text within the response panel. How do we improve this behaviour to either displaying the PDF inline in the response panel (like Postman or Insomnia would) or triggering a browser file download?

External Links not working

Hi In our guide, we created several page of type "external link". They have worked as expected, but today I realize that they are not working. You can see several of these links on this [page](https://readme.anytrack.io/docs/page-with-external-links). Is this a known bug and is there an ETA for a fix?

Multiversion api spec file

Hey Team, I need assistance with implementing a try out feature for an API spec file that contains two versions of a project. I would like the try out feature to be available in separate links for version v1 and version v2. However, currently, the version parameters and headers are being combined into one link instead of being segregated. I have provided a sample spec file with multiple versions for your reference. Can you please help me resolve this issue? Thank you. <https://drive.google.com/file/d/1Jvzlm36QlRd_Wn7B0bIOISOlQjiSaF99/view?usp=sharing> <https://drive.google.com/file/d/1Jvzlm36QlRd_Wn7B0bIOISOlQjiSaF99/view>

Does the Owlbot/Ask AI understand emoji in tables?

It seems like, in a table about compatibilities, can it correctly parse something like the following to provide answers: _[header row]_. _Capability Y_ \|\| _Capability Z_ - Software A: ✅ || ❌ - Software B: ❌ || ✅ Would using Git-style emoji shortcodes work better (e.g. :check-mark:) or an image or icon with alt-text?
ANSWERED

How to document response parameters in detail

Hi, I want to document response parameters like it is done on this page: <https://docs.readme.com/main/reference/updatedoc> including a definition and example values for each. I cannot find out how to do this. Can you give an advice please? Thank you!
ANSWERED

How to document a custom method

HI! We have custom methods (e.g., `RELOAD`). What should I do to be able to select it in the dropdown when I document a new endpoint? Where to configure it? Thanks a lot!
ANSWERED

How to document a custom method

HI! We have custom methods (e.g., `RELOAD`). What should I do to be able to select it in the dropdown when I document a new endpoint? Where to configure it? Thanks a lot!
ANSWERED

Discussions webhook?

Does readme support a webhook to notify when a new discussion question / response is posted? Apologies if I missed this in the docs. Thanks :)
ANSWERED

CICD of subpages in documentation

Hi, :grinning: I am setting up a pipeline with github actions of my documentation and there are some subpages. In order to do that I am generating the YAML blocks that need to be at the top of the markdown files and writing them into the files. All far all good. The problems start when I want to have a subpage because they way to indicate this is by adding a new key with the parent document ID. I want to have a generic solution that doesn't involve hardcoding IDs. What I was planning to do is first upload the parent documents, then get their IDs and use those for the second round of uploads, where I would upload all of the children documents that reference their parent. Is there any other easier solution? TY