Discussions
Markdown syntax in changelogs
15 days ago by Jimmy Karlsson
We use Markdown syntax in our changelogs. When describing endpoint and endpoint parameters, we write something similar to
/endpoint/{record_id}
But after migrating to API V2, trying to POST a new changelog results in the following error message
{
"type": "https://docs.readme.com/main/",
"title": "The page body failed an MDX validation check.",
"status": 422,
"detail": "record_id is not defined",
"poem": [
"Writing markdown is fun and easy",
"But we also like react",
"And with the two together",
"It sends this error back"
],
"errors": [{ "message": "record_id is not defined", "key": "content.body" }]
}
I'm assuming this is because you're using React, and the {....} syntax is also React template syntax. My question here is, why are you trying to parse our changelogs as React code? And how can I make this work?