testomatio / docs

Documentation for Testomatio
https://docs.testomat.io/
5 stars 1 forks source link

User guide how Testomat API can be used #102

Open TetianaKhomenko opened 3 months ago

TetianaKhomenko commented 3 months ago

It would be nice to have a page with some examples of user scenarios that use our API.

Here is one of the user cases:

Justin Scroggins 5 days ago I didn't see anything listed in https://app.testomat.io/docs/api - but wanted to ask - is there a way to programmatically create documentation? I'm using Test Case Studio pro right now and it's speeding up my time to create manual scenarios. I requested that they add support for export to Markdown which they've agreed to add. I was hoping to find a way to send the test cases to Testomat rather than manually copying them in. Is there a way to do such a thing? (edited)

Mykhailo Poliarush :testomat: 5 days ago @Justin Scroggins

is there a way to programmatically create documentation? do you mean create test cases by API? if so yes, you can manage test case description and attachment by API

create test - https://app.testomat.io/docs/api/1.0/tests/create.html
update test - https://app.testomat.io/docs/api/1.0/tests/update.html
upload attachments - https://app.testomat.io/docs/api/1.0/tests/upload.html 

Justin Scroggins 5 days ago Hey @Mykhailo Poliarush thanks for this. So, would the param: attributes[description] contain the markdown file for the scenario?

Mykhailo Poliarush :testomat: 5 days ago yes, you can pass markdown there

Justin Scroggins 5 days ago Thank you, you've made my life much easier :slightly_smiling_face: