Set PR scan issue and clean summaries together

Atomically enables or disables both PR issue-summary comments and clean-scan summary comments for a repository

POST /api/v1/repositories/set-pr-scan-summaries-enabled

Set PR scan issue and clean summaries together

cURL

curl --request POST \
  --url https://zeropath.com/api/v1/repositories/set-pr-scan-summaries-enabled \
  --header 'Content-Type: application/json' \
  --header 'X-ZeroPath-API-Token-Id: <api-key>' \
  --header 'X-ZeroPath-API-Token-Secret: <api-key>' \
  --data '
{
  "repositoryId": "<string>",
  "prScanSummariesEnabled": true,
  "organizationId": "<string>"
}
'

import requests

url = "https://zeropath.com/api/v1/repositories/set-pr-scan-summaries-enabled"

payload = {
    "repositoryId": "<string>",
    "prScanSummariesEnabled": True,
    "organizationId": "<string>"
}
headers = {
    "X-ZeroPath-API-Token-Id": "<api-key>",
    "X-ZeroPath-API-Token-Secret": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-ZeroPath-API-Token-Id': '<api-key>',
    'X-ZeroPath-API-Token-Secret': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    repositoryId: '<string>',
    prScanSummariesEnabled: true,
    organizationId: '<string>'
  })
};

fetch('https://zeropath.com/api/v1/repositories/set-pr-scan-summaries-enabled', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://zeropath.com/api/v1/repositories/set-pr-scan-summaries-enabled",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'repositoryId' => '<string>',
    'prScanSummariesEnabled' => true,
    'organizationId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-ZeroPath-API-Token-Id: <api-key>",
    "X-ZeroPath-API-Token-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://zeropath.com/api/v1/repositories/set-pr-scan-summaries-enabled"

	payload := strings.NewReader("{\n  \"repositoryId\": \"<string>\",\n  \"prScanSummariesEnabled\": true,\n  \"organizationId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-ZeroPath-API-Token-Id", "<api-key>")
	req.Header.Add("X-ZeroPath-API-Token-Secret", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://zeropath.com/api/v1/repositories/set-pr-scan-summaries-enabled")
  .header("X-ZeroPath-API-Token-Id", "<api-key>")
  .header("X-ZeroPath-API-Token-Secret", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repositoryId\": \"<string>\",\n  \"prScanSummariesEnabled\": true,\n  \"organizationId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://zeropath.com/api/v1/repositories/set-pr-scan-summaries-enabled")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-ZeroPath-API-Token-Id"] = '<api-key>'
request["X-ZeroPath-API-Token-Secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"repositoryId\": \"<string>\",\n  \"prScanSummariesEnabled\": true,\n  \"organizationId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "ok": true
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-ZeroPath-API-Token-Id · string · header · required

X-ZeroPath-API-Token-Secret · string · header · required

Body

application/json

repositoryId · string · required

prScanSummariesEnabled · boolean · required

When true, both issue-found and clean-scan PR summary comments are enabled; when false, both are disabled (single atomic update)

organizationId · string

Response

200

application/json

Successful response

ok · boolean