improved
2021-04-28
about 1 year ago by ReadMe API
-
Added support for HTML format in Feature description.
This is the first phase of decomissioning the original, Markdown-like format. The whole process is planned as follows:
- 2021-04-28: HTML format support has been added to the API. Where applicable, it is now possible to use a query parameter
descriptionFormat=html
to opt in for the new format. This change is backward-compatible as the API will fall back to the original Markdown-like format in the absence of said parameter. - 2021-05-10: The default format will be switched to the new, HTML-based one. Where applicable, it will be possible to use a query parameter
descriptionFormat=markdown
to opt out and still receive the original format. In the absence of the parameter, the API will now default to HTML. This is a breaking change and will require all consumers to either be already migrated to support the new format or make use of the opt out mechanism to buy themselves some more time. - 2021-05-17: The original, Markdown-like format will be removed from the API for good together with the
descriptionFormat
query parameter, making the HTML the only description format available on the API.