From 8262b95c470ead267ab47ac367b2d0fef5c4a8d9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 2 Nov 2026 09:08:07 +0000 Subject: [PATCH] docs: expand short descriptions on API reference and changelog pages --- api-reference/credits/get-credit-balance.mdx | 2 +- api-reference/findings/count-findings.mdx | 2 +- api-reference/pentests/discard-pentest.mdx | 2 +- api-reference/pentests/estimate-pentest.mdx | 2 +- api-reference/pentests/start-pentest.mdx | 2 +- api-reference/pentests/update-pentest.mdx | 2 +- api-reference/repos/get-pr-review-settings.mdx | 2 +- api-reference/repos/update-pr-review-settings.mdx | 2 +- api-reference/scans/stop-scan.mdx | 2 +- changelog.mdx | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/api-reference/credits/get-credit-balance.mdx b/api-reference/credits/get-credit-balance.mdx index 62fd70a..16109a5 100644 --- a/api-reference/credits/get-credit-balance.mdx +++ b/api-reference/credits/get-credit-balance.mdx @@ -1,7 +1,7 @@ --- title: "Get credit balance" openapi: "GET /credits" -description: "Read the organization's pentest credit balance." +description: "Get the pentest credits available to your organization, with totals purchased, used, refunded and granted, and whether the organization is unlimited." --- Returns the pentest credits available to the organization, with totals purchased, used, refunded and granted. `is_unlimited` is true for organizations without a credit limit. diff --git a/api-reference/findings/count-findings.mdx b/api-reference/findings/count-findings.mdx index a1ebdb2..48be3c6 100644 --- a/api-reference/findings/count-findings.mdx +++ b/api-reference/findings/count-findings.mdx @@ -1,7 +1,7 @@ --- title: "Count findings" openapi: "GET /findings/counts" -description: "Count findings by severity, state and repository." +description: "Count findings with the same filters as List findings, without fetching every page. Returns the total plus counts by severity, state and repository." --- Counts findings using the same filters as [List findings](/api-reference/findings/list-findings), without requiring you to fetch every page. The response includes the total and counts by severity, state and repository. Severity and state counts include zero values. Repositories appear in order of finding count, highest first. diff --git a/api-reference/pentests/discard-pentest.mdx b/api-reference/pentests/discard-pentest.mdx index ff3dd85..1c81da6 100644 --- a/api-reference/pentests/discard-pentest.mdx +++ b/api-reference/pentests/discard-pentest.mdx @@ -1,7 +1,7 @@ --- title: "Discard pentest draft" openapi: "DELETE /pentests/{id}" -description: "Delete a pentest that hasn't started." +description: "Delete a draft pentest that hasn't started, along with its saved login details. Use Stop scan instead to end a pentest that is already running." --- Deletes a draft pentest and its saved login details. To end a pentest that has already started, use [Stop scan](/api-reference/scans/stop-scan). diff --git a/api-reference/pentests/estimate-pentest.mdx b/api-reference/pentests/estimate-pentest.mdx index a880967..64f4bec 100644 --- a/api-reference/pentests/estimate-pentest.mdx +++ b/api-reference/pentests/estimate-pentest.mdx @@ -1,7 +1,7 @@ --- title: "Estimate pentest" openapi: "POST /pentests/{id}/estimate" -description: "Price a draft pentest before starting it." +description: "Start a cost estimation for a draft pentest and get its cost_estimation_id, then poll Get cost estimation for the credit total to confirm at start." --- Starts a cost estimation for the draft and returns its `cost_estimation_id`. Poll [Get cost estimation](/api-reference/cost-estimations/get-cost-estimation) until its `status` is `completed` or `partial`. diff --git a/api-reference/pentests/start-pentest.mdx b/api-reference/pentests/start-pentest.mdx index 6efa2b9..631a00c 100644 --- a/api-reference/pentests/start-pentest.mdx +++ b/api-reference/pentests/start-pentest.mdx @@ -1,7 +1,7 @@ --- title: "Start pentest" openapi: "POST /pentests/{id}/start" -description: "Start an estimated pentest and spend the confirmed credits." +description: "Start a draft pentest with a completed estimate. Confirm the expected credits, pass login checks for each target, and Hacktron deducts the credits." --- Starts a draft pentest that has a completed estimate. Credits are deducted when it starts. diff --git a/api-reference/pentests/update-pentest.mdx b/api-reference/pentests/update-pentest.mdx index 5921350..93e746c 100644 --- a/api-reference/pentests/update-pentest.mdx +++ b/api-reference/pentests/update-pentest.mdx @@ -1,7 +1,7 @@ --- title: "Update pentest draft" openapi: "PATCH /pentests/{id}" -description: "Change a pentest that hasn't started." +description: "Update a draft pentest before it starts. Replace repositories, login targets or target URLs, then run the estimate again before starting the pentest." --- Updates a draft pentest. Fields in the request replace their saved values. Omitted fields keep their current values. You can't change a pentest after it starts. diff --git a/api-reference/repos/get-pr-review-settings.mdx b/api-reference/repos/get-pr-review-settings.mdx index 471b857..30e068e 100644 --- a/api-reference/repos/get-pr-review-settings.mdx +++ b/api-reference/repos/get-pr-review-settings.mdx @@ -1,7 +1,7 @@ --- title: "Get PR review settings" openapi: "GET /pr-review-settings" -description: "Read how PR reviews behave across your organization." +description: "Get your organization's PR review settings: whether reviews post comments, the severity that fails the PR check, and which pull requests are reviewed." --- Returns the PR review settings configured for your organization under **Settings** in Hacktron: diff --git a/api-reference/repos/update-pr-review-settings.mdx b/api-reference/repos/update-pr-review-settings.mdx index 9aeb933..2ef6384 100644 --- a/api-reference/repos/update-pr-review-settings.mdx +++ b/api-reference/repos/update-pr-review-settings.mdx @@ -1,7 +1,7 @@ --- title: "Update PR review settings" openapi: "PATCH /pr-review-settings" -description: "Change how PR reviews behave across your organization." +description: "Update your organization's PR review settings. Only fields you send change, filters replace the saved list, and null clears a filter or fail_on_severity." --- Updates your organization's PR review settings and returns the full settings object. Only fields in the request change. Send `null` to disable `fail_on_severity` or clear a filter. diff --git a/api-reference/scans/stop-scan.mdx b/api-reference/scans/stop-scan.mdx index b28c2c9..a723b72 100644 --- a/api-reference/scans/stop-scan.mdx +++ b/api-reference/scans/stop-scan.mdx @@ -1,7 +1,7 @@ --- title: "Stop scan" openapi: "POST /scans/{id}/stop" -description: "Stop a running scan or pentest." +description: "Stop a running scan or pentest and get its status. Members can stop their own pentests and any PR scan, and organization admins can stop any scan." --- Stops a running scan and returns its status. Members can stop their own pentests and any PR scan. Organization admins can stop any scan. diff --git a/changelog.mdx b/changelog.mdx index efa6670..96fad01 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -1,6 +1,6 @@ --- title: "Changelog" -description: "New features, improvements, and fixes." +description: "New features, improvements, and fixes in Hacktron, including updates to Whitebox pentests, Code Review, billing, integrations, and the dashboard." rss: true ---