Discussions
OpenAPI file - Way to avoid all body param defined as required?
When uploading an OpenAPI file in JSON format (transformed from Postman export), all body raw parameters are defined as required in the ReadMe API Reference page but shouldn't. Is there any way or other format that properly recognizes what's optional? Thanks.
Posted by [email protected] about 2 months ago
Can we modify request payloads by using personalized webhooks?
Hi, I need to know that, can we modify request payloads for different users, using personalized webhooks or using any other method? I need to modify request payload attributes and prefill them with the data that belong to different users.
Posted by Dilip Roshitha about 2 months ago
How do I update my page slug
Hi,
I want to update my documentation and sub page's page slugs as they are not accurate to the documentation it renders or the title of the document.
How do I do this on Readme
Posted by Shreyas Sridhar about 2 months ago
Changelog Short/Long Format Toggle
My apologies if this has been addressed already, but here's my question.
Would it be possible to have a toggle for the changelog to allow for short or long format?
Currently we can only use the short format. For each changelog post, the list view of posts cuts off the post at the first line break. It isn't clear to a user on the list view that there is more in the post. So they would either not read the rest of the post, or they'd have to click into each post individually.
What I would like (if it doesn't exist already) is to toggle to a long format where the list view shows the entirety of all the posts. That not only makes it more of a story to tell for a user, but also saves them from missing out on information or making more clicks.
In the meantime, my coping mechanisms are:
- Include a "click through for more" style phrase in the initial paragraph like y'all do in your changelog, or
- Think about embedding the changelog via API somewhere else, which detracts from using the Readme hosting as our primary interface for docs.
Thanks for your consideration and time!
Posted by null about 2 months ago
What is our plan
Hello, we have a plan for $99/month for documentation. I'm currently going through our vendors and wanted to know more information.
What plan is it? Month to month, or annual? If annual, what is our renewal date? What day during the month do we get charged?
Thank you
Posted by Raina Anderson about 2 months ago
Regaring empty parameter
How to set default value null or empty string?
Posted by Rasheth 2 months ago
Parameters in header using openapi format
Hey, I have a problem with parameters in header using format openapi. What I have to do in my schema to send all parameter in one header json format? Now, when I add a parameter type object, e.g.:
{params: {option1: value1; option2: value2}}
readme build a example of code like:
X-params: object
X-option1: value1
X-option2: value2
How I can change this to:
X-params: {option1: value1; option2: value2}
Posted by Grzegorz Szukalski 2 months ago
How to search in readme discussions?
How to search?
Posted by Ash 2 months ago
Side-wide password - Pass password through url param
For a documentation protected by a site-wide password control, is there the ability to pass the password somehow in a url parameter in order the user signs in automatically ?
Posted by Vincent Dieulesaint 3 months ago
sitemap.xml bug!
I reported several months ago that the sitemap.xml format of the docs was wrong. Still hasn't been fixed.
And now, instead of building the sitemap with our custom domain, you've added the readme.io domain!
```
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1" data-tag-assistant-present="">
<url>
<loc>https://anytrack.readme.io/</loc>
<changefreq>daily</changefreq>
<priority>0.3</priority>
</url>
<url>
<loc>https://anytrack.readme.io/</loc>
<changefreq>weekly</changefreq>
<priority>0.3</priority>
</url>
<url>
<loc>https://anytrack.readme.io/docs/what-is-anytrack</loc>
<changefreq>daily</changefreq>
<priority>0.3</priority>
</url>
<url>
<loc>https://anytrack.readme.io/docs/for-whom</loc>
<changefreq>daily</changefreq>
<priority>0.3</priority>
</url>
<url>
<loc>https://anytrack.readme.io/docs/why-anytrack</loc>
<changefreq>daily</changefreq>
<priority>0.3</priority>
</url>
<url>
<loc>https://anytrack.readme.io/docs/getting-started</loc>
<changefreq>daily</changefreq>
<priority>0.3</priority>
</url>
```
Posted by laurent malka 3 months ago