Forum Discussion

lucasf1's avatar
lucasf1
New Contributor
7 days ago
Solved

Test case upload comment markdown

Hey Community! I am currently making some edits to our API interface login and there is 

"scriptResults": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "required": true }, "status": { "type": "string", "required": true }, "comment": { "type": "string" } } } }

This is on the current documentation for this endpoint

/testrun/{testRunKey}/testcase/{testCaseKey}/testresult

https://support.smartbear.com/zephyr-scale-server/api-docs/v1/

Everything is uploading fine and I am adding an addition to work with the "comment:" specifically that adds content to the "Actual Result" section

This specific section on the test step shows there is a rich text editor. I am curious if there is anything I can do to modify the string on the code side that allows for markdown editing like bolding or new lines. I cannot find any documentation for this online and I am curious if there is any information that the community has on markdown formatting. 

Thank you!

1 Reply

Sort By
  • lucasf1's avatar
    lucasf1
    New Contributor
    7 days ago

    For those who are interested in the solution: 

    After further testing it can accept basic HTML elements such as <b></b> for bold or <br> for new lines. Please research HTML elements using this link for example to introduce markup formatting in your "comment:" string

    https://developer.mozilla.org/en-US/docs/Web/HTML/Element