Repository navigation
Apply SEO and metadata best practices #106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
mintlify
wants to merge
1
commit into
main
Choose a base branch
from
mintlify/29329bb9
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| <Info>**Scope required**: `read`</Info> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| --- | ||
| 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). | ||
|
|
||
| <Info>**Scope required**: `write`. **Role**: member or above.</Info> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,14 @@ | ||
| --- | ||
| 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. | ||
|
|
||
| <Info>**Scope required**: `write`. **Role**: organization admin.</Info> | ||
|
|
||
| - Set `expected_credits` to the estimate's `total_credits`, plus `triage_fee_credits` if triage is required or you set `triage_enabled`. If the current cost differs from this total, the endpoint returns `409` without spending credits. If the organization has insufficient credits, it returns `402`. | ||
| - Every login target needs a login check that passed within the last hour. See [Check pentest logins](/api-reference/pentests/check-pentest-logins). | ||
|
|
||
| After it starts, follow the pentest with [Get scan status](/api-reference/scans/get-scan-status) using the same `scan_id`, read its results with [List scan findings](/api-reference/scans/list-scan-findings), or stop it with [Stop scan](/api-reference/scans/stop-scan). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| --- | ||
| 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." | ||
|
Check warning on line 4 in api-reference/scans/stop-scan.mdx
|
||
| --- | ||
|
|
||
| Stops a running scan and returns its status. Members can stop their own pentests and any PR scan. Organization admins can stop any scan. | ||
|
|
||
| <Info>**Scope required**: `write`. **Role**: member or above.</Info> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mintlify renders
descriptionunder the page title, so this new subtitle is followed immediately by line 7 restating the same credits, totals, and unlimited-status facts. Several other modified endpoint pages introduce the same description/body duplication, making readers consume each summary twice and leaving two copies that can drift apart. Consolidate each description and opening-paragraph pair while retaining the expanded metadata. .agents/skills/writing-docs/SKILL.mdL26-L30Useful? React with 👍 / 👎.