Discussions

I have multiple environments for a given api

I have multiple environments for a given api with different endpoints. For the logged on user, I am pre populating an apikey via custom login JWT.

Posted by Naveen Velicheti over 2 years ago

Api deprecation

I want to deprecate particular api end point and make it visible to customer that this endpoint is depreciated. How to do that?

Posted by Revanth over 2 years ago

ANSWERED

Is there a way to upload or manage an XML Sitemap with ReadMe?

I would like to create and manage an XML Sitemap of our Docs website with, which uses ReadMe. Is there an option to manage an XML Sitemap or upload an XML file to a subfolder?

Posted by [email protected] over 2 years ago

Support for date-based API versions

I know that ReadMe is semver-ish with the supported versions, but this is posing a problem for us when we want to create a date-based version. We have a version 2022-09 that is not accepted by semver. Are there any suggestions for what we can do?

Posted by Hannah Horobin over 2 years ago

ANSWERED

Displaying recursive data results from an API

My api response returns data with the following structure

Posted by Ahmed Emad over 2 years ago

ANSWERED

Error submitting form after updating a page

When I update a Guide page, I get a message that says error submitting form. This happens after entering text and clicking the Save to Staging button. The page that I am working on is quite large with many tables. Do you have any ideas why I am getting this error and what I can do?

Posted by Ken Davies over 2 years ago

ANSWERED

Is there a plan to support webhooks in OAS 3.1?

We'd love to be able to upload our webhooks specifications to ReadMe. Are there plans to support it? Any suggested alternatives in the meantime besides creating custom pages?