diff --git a/docs/docs/api/azureboardintegration.md b/docs/docs/api/azureboardintegration.md index c0dac585..54d0876a 100644 --- a/docs/docs/api/azureboardintegration.md +++ b/docs/docs/api/azureboardintegration.md @@ -522,12 +522,13 @@ curl -X PUT 'https://portal.prancer.io/prancer-customer1/api/azboard/configurati - **CURL Sample** ```curl -curl -X POST 'https://portal.prancer.io/prancer-customer1/api/azboard/issue' -H 'Authorization: Bearer ' --data-raw '{"container": "aws_tf_rds","issues":[{"title": "Bulk issue creation 3"}]}' +curl -X POST 'https://portal.prancer.io/prancer-customer1/api/azboard/ticket/create/' -H 'Authorization: Bearer ' --data-raw '{"container":"aws_cloud_specific", "pac_alert_ids": ["62b59d9105c659f779127df4", "62b9af0d0f8908d3969b39b6", "62b9af0d0f8908d3969b39f0"]} ```   -- **URL: ** -- **Method:POST**- **Header:** +- **URL: ** +- **Method:POST** +- **Header:** ``` code     - content-type: application/json @@ -539,18 +540,34 @@ curl -X POST 'https://portal.prancer.io/prancer-customer1/api/azboard/issue' -H ``` json { - "container": "aws_tf_rds", - "issues": [ - { - "title": "Issue creation" - } - ] + "container":"aws_cloud_specific", + "pac_alert_ids": [ + "62b59d9105c659f779127df4", + "62b9af0d0f8908d3969b39b6", + "62b9af0d0f8908d3969b39f0" + ] } ``` - **Explanation:** - `The Container and issues fields are mandatory. + `Required Fields` + + - **container:** Name of the cloud container for which you want want to create Jira tickets. + + **For Creating Ticket for Infra findings:** + - **result_id:** Result id of the infra output. + - **output_id:** Output id of the infra output. + - **test_id:** Test id of the failed testcase of the infra output. + - **snapshot_id:** Snapshot id of the failed testcase in infra output. + + **For Creating Ticket for App findings:** + - **pac_alert_ids:** Alert id list for which ticket needs to be created. + + + `Optional Fields` + + - **matching_testcase:** : Valid values are `true` and `false`. To create the a single ticket for all similar failed testcases on the Infra findings if `true` - **Response:** diff --git a/docs/docs/api/jiraintegration.md b/docs/docs/api/jiraintegration.md index 6ef0ea9e..f0cb1360 100644 --- a/docs/docs/api/jiraintegration.md +++ b/docs/docs/api/jiraintegration.md @@ -578,11 +578,11 @@ curl -X GET 'https://portal.prancer.io/prancer-customer1/api/jira/issue?containe - **CURL Sample** ```curl -curl -X POST 'https://portal.prancer.io/prancer-customer1/api/jira/issue' -H 'Authorization: Bearer ' --data-raw {"container":"new_container","project":"IP","issues":[{"title" : "title for the issue","tags"["test","label"]}]} +curl -X POST 'https://portal.prancer.io/prancer-customer1/api/jira/ticket/create/' -H 'Authorization: Bearer ' --data-raw '{"container":"aws_cloud_specific", "pac_alert_ids": ["62b59d9105c659f779127df4", "62b9af0d0f8908d3969b39b6", "62b9af0d0f8908d3969b39f0"]} ```   -- **URL: ** +- **URL: ** - **Method:POST** - **Header:** @@ -596,19 +596,37 @@ curl -X POST 'https://portal.prancer.io/prancer-customer1/api/jira/issue' -H 'Au ``` json { - "container":"new_container", - "project":"IP", - - "issues":[ - { - "title" : "title for the issue", - "tags":["test","label"] - }] + "container":"aws_cloud_specific", + "pac_alert_ids": [ + "62b59d9105c659f779127df4", + "62b9af0d0f8908d3969b39b6", + "62b9af0d0f8908d3969b39f0" + ] } ``` - **Explanation:** - `The Container and issues fields are mandatory. The title in the issues is a required field.Tags and issuetype are optional.The Project field can be optional.` + + `Required Fields` + + - **container:** Name of the cloud container for which you want want to create Jira tickets. + + **For Creating Ticket for Infra findings:** + - **result_id:** Result id of the infra output. + - **output_id:** Output id of the infra output. + - **test_id:** Test id of the failed testcase of the infra output. + - **snapshot_id:** Snapshot id of the failed testcase in infra output. + + **For Creating Ticket for App findings:** + - **pac_alert_ids:** Alert id list for which ticket needs to be created. + + + `Optional Fields` + + - **issuetype:** : Issue type for Jira ticket. + - **labels:** : Labels type for Jira ticket. + - **project:** : Project name of Jira in which ticket needs to be created. + - **matching_testcase:** : Valid values are `true` and `false`. To create the a single ticket for all similar failed testcases on the Infra findings if `true` - **Response:**