Clarification of what "GET /case-definition/{id}/xml" returns in "cmmnXml" property

Camunda 7 Topics Discussion & Questions
1

At https://docs.camunda.org/manual/latest/reference/rest/case-definition/get-xml/ , for the “cmmnXml” property, it says this:

An escaped XML string containing the XML that this case definition was deployed with. Carriage returns, line feeds and quotation marks are escaped.

The example response has this value:
“cmmnXml”:“<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance\”

The part of the description starting with “Carriage returns …” is a little odd. As written, that carriage return and linefeed sequence isn’t “escaped”. It’s not clear to me whether there’s a better way to say that.

2

Would something like

Carriage returns and line feeds are included as \r and \n respectively. Quotation marks are escaped.

make it more clear?

3

That sounds fine. I might say “rendered” instead of “included”, but that’s still an improvement.

4

Sounds good. Would you mind making a pull request to the docs repository?

5